The main supervisor for the Phoenix Socket Client.
Summary
Functions
Returns a specification to start this module under a supervisor.
Releases the private configuration of a child specification that will not be started.
Starts the socket client supervisor.
Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
@spec discard_child_spec(Supervisor.child_spec()) :: :ok | {:error, :in_use}
Releases the private configuration of a child specification that will not be started.
Returns {:error, :in_use} once a supervising parent has activated the specification.
Activated configuration is retained until that parent exits, including across
client restarts.
@spec start_link(keyword()) :: Supervisor.on_start()
Starts the socket client supervisor.
Options
:name- The name to register the supervisor.:url- The WebSocket URL.:params- The parameters to send on connection.:headers- The headers to send on connection.:transport- The transport to use.:heartbeat_interval- The heartbeat interval in milliseconds.:reconnect_interval- The reconnect interval in milliseconds.:reconnect?- Whether to reconnect automatically.:auto_connect- Whether to connect automatically on startup.:json_library- The JSON encoder/decoder module to use.:vsn- The Phoenix Channels protocol version.:topic_channel_map- A map from a topic string to a channel module.:default_channel_module- The default channel module to use.:default_channel_params- The default parameters to use for channels.