@spec child_spec({pid() | atom(), String.t(), map()}) :: Supervisor.child_spec()

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec join(pid() | atom(), String.t(), map(), non_neg_integer()) ::
  {:ok, map(), pid()}
  | {:error, :socket_not_started}
  | {: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.

@spec leave(pid()) :: :ok

Leave the channel topic and stop the channel.

Always returns :ok, even when the channel process is already gone.

@spec push(pid(), String.t(), term(), non_neg_integer()) ::
  {atom(), term()} | {:error, term()}

Push a message to the server and wait for a reply or until timeout.

The server must be configured to return {:reply, _, socket} otherwise, the call will timeout. Payloads must be encodable by the configured JSON library; unencodable payloads return {:error, reason} immediately.

@spec push_async(pid(), String.t(), term()) :: :ok

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

Replies from the server are delivered to the caller's mailbox as a %ChannelClient.Message{} with event "phx_reply".