View Source Phoenix.Socket.Reply (Phoenix v1.7.0-rc.0)

Defines a reply sent from channels to transports.

The message format requires the following keys:

:topic - The string topic or topic:subtopic pair namespace, for example "messages", "messages:123"
:status - The reply status as an atom
:payload - The reply payload
:ref - The unique string ref
:join_ref - The unique string ref when joining

Link to this section Summary

Types

t()

Link to this section Types

t()

@type t() :: %Phoenix.Socket.Reply{
  join_ref: term(),
  payload: term(),
  ref: term(),
  status: term(),
  topic: term()
}