phoenix_channel_client v0.4.0 PhoenixChannelClient behaviour

Link to this section Summary

Link to this section Types

Link to this type from()
from() :: {pid(), tag :: term()}

Link to this section Functions

Link to this function cancel_push(pid_or_name, push_ref)
Link to this function channel(sender, opts)
Link to this function join(pid_or_name, params \\ %{})
Link to this function leave(pid_or_name)
Link to this function push(pid_or_name, event, payload, opts \\ [])
Link to this function terminate(reason, state)

Link to this section Callbacks

Link to this callback handle_call(request, from, state)
handle_call(request :: term(), from(), state :: term()) ::
  {:reply, reply, new_state}
  | {:reply, reply, new_state, timeout() | :hibernate | {:continue, term()}}
  | {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate, {:continue, term()}}
  | {:stop, reason, reply, new_state}
  | {:stop, reason, new_state}
when reply: term(), new_state: term(), reason: term()
Link to this callback handle_cast(request, state)
handle_cast(request :: term(), state :: term()) ::
  {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate | {:continue, term()}}
  | {:stop, reason :: term(), new_state}
when new_state: term()
Link to this callback handle_close(reply, state)
handle_close(reply :: Tuple.t(), state :: map()) ::
  {:noreply, state :: map()} | {:stop, reason :: term(), state :: map()}
Link to this callback handle_in(event, payload, state)
handle_in(event :: String.t(), payload :: map(), state :: map()) ::
  {:noreply, state :: map()}
Link to this callback handle_info(msg, state)
handle_info(msg :: :timeout | term(), state :: term()) ::
  {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate | {:continue, term()}}
  | {:stop, reason :: term(), new_state}
when new_state: term()
Link to this callback handle_reply(reply, state)
handle_reply(reply :: Tuple.t(), state :: map()) :: {:noreply, state :: map()}