phoenix_client v0.6.0 PhoenixClient.Channel
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Join a channel topic through a socket with optional params
Leave the channel topic and stop the channel
Push a message to the server and wait for a response or timeout
Push a message to the server and do not wait for a response
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
Join a channel topic through a socket with optional params
A socket can only join a topic once. If the socket you pass already has a
channel connection for the supplied topic, you will receive an error
{:error, {:already_joined, pid}}
with the channel pid of the process joined
to that topic through that socket. If you require to join the same topic with
multiple processes, you will need to start a new socket process for each channel.
Calling join will link the caller to the channel process.
Leave the channel topic and stop the channel
push(pid(), binary(), map(), non_neg_integer()) :: term()
Push a message to the server and wait for a response or timeout
The server must be configured to return {:reply, _, socket}
otherwise, the call will timeout.
Push a message to the server and do not wait for a response