Returns a specification to start this module under a supervisor.

See Supervisor.

Specs

join(pid() | atom(), binary(), map(), non_neg_integer()) ::
  {:ok, map(), pid()}
  | {:error, :socket_not_connected}
  | {:error, :timeout}
  | {:error, any()}

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.

Specs

leave(pid()) :: :ok

Leave the channel topic and stop the channel

Specs

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.

Specs

push_async(pid(), binary(), map()) :: :ok

Push a message to the server and do not wait for a response