Phoenix.SocketClient.State (phoenix_socket_client v0.7.0)

Represents the state of a Phoenix Socket Client connection.

Summary

Types

t()

The state struct for the socket client.

Types

t()

@type t() :: %Phoenix.SocketClient.State{
  auto_connect: boolean(),
  custom: map(),
  default_channel_module: module() | nil,
  default_channel_params: map() | nil,
  headers: [{String.t(), String.t()}],
  join_channels: [String.t()],
  joined_channels: %{
    required(String.t()) => %{
      params: map(),
      status: :joining | :joined | :leaving | :left | :errored
    }
  },
  json_library: module(),
  params: map(),
  reconnect: boolean(),
  reconnect_interval: non_neg_integer(),
  reconnect_timer: reference() | nil,
  reconnecting: boolean(),
  ref: integer(),
  registry_name: atom(),
  serializer: module(),
  status: :disconnected | :connecting | :connected,
  sup_pid: pid() | nil,
  to_send_r: [Phoenix.SocketClient.Message.t()],
  transport: module(),
  transport_opts: keyword(),
  transport_pid: pid() | nil,
  url: String.t(),
  vsn: String.t()
}

The state struct for the socket client.