push_ex v1.0.0-rc1 PushEx.Behaviour.Socket behaviour

Implementable functions that are used in the flow of socket/channel creation. It is crucial to implement secure connect/join functions for all applications.

Link to this section Summary

Link to this section Callbacks

Link to this callback channel_join(bitstring, map, arg2)
channel_join(bitstring(), map(), Phoenix.Socket.t()) ::
  {:ok, Phoenix.Socket.t()}
  | {:ok, reply :: map(), Phoenix.Socket.t()}
  | {:error, reason :: map()}

See Phoenix.Channel.join/3

Link to this callback presence_identifier(arg0)
presence_identifier(Phoenix.Socket.t()) :: bitstring()

See Phoenix.Presence.track/4 key

Link to this callback socket_connect(map, arg1)
socket_connect(map(), Phoenix.Socket.t()) :: {:ok, Phoenix.Socket.t()} | :error

See Phoenix.Socket.connect/3