Phoenix v1.3.0 Phoenix.Socket.Reply View Source

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

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %Phoenix.Socket.Reply{join_ref: term(), payload: term(), ref: term(), status: term(), topic: term()}