Spec-Zone.ru › Phoenix

Phoenix.Socket.Reply

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
  • :join_ref - The unique string ref when joining

Summary

Types

t()

Types

t()Source

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

Hex Package Hex Preview Download ePub version

Built using ExDoc (v0.40.3) for the Elixir programming language

© 2014 Chris McCord
Licensed under the MIT License.
https://phoenix.hexdocs.pm/Phoenix.Socket.Reply.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API