phoenix_gen_socket_client v4.0.0 Phoenix.Channels.GenSocketClient.Serializer behaviour View Source

Describes the serializer interface used in Phoenix.Channels.GenSocketClient to encode/decode messages.

Link to this section Summary

Callbacks

decode_message(arg1, arg2)

Invoked to decode the raw message.

encode_message(arg1)

Invoked to encode a socket message.

Link to this section Callbacks

decode_message(arg1, arg2)

Specs

decode_message(Phoenix.Channels.GenSocketClient.encoded_message(), Keyword.t()) ::
  Phoenix.Channels.GenSocketClient.message()

Invoked to decode the raw message.

encode_message(arg1)

Specs

encode_message(Phoenix.Channels.GenSocketClient.message()) ::
  {:ok, Phoenix.Channels.GenSocketClient.Transport.frame()}
  | {:error, reason :: any()}

Invoked to encode a socket message.