Phoenix.Socket.Message

Исходный код

Определяет сообщение, передаваемое по транспортному каналу каналам и обратно.

Формат сообщения должен содержать следующие ключи:

:topic — строковое пространство имён темы или пары «тема:подтема», например «messages», «messages:123»
:event — строковое имя события, например «phx_join»
:payload — полезная нагрузка сообщения
:ref — уникальная строковая ссылка
:join_ref — уникальная строковая ссылка при присоединении

Краткое описание

t()

from_map!(map): Преобразует карту со строковыми ключами в структуру сообщения.

Типы

t()Исходный код

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

Функции

from_map!(map)Исходный код

Преобразует карту со строковыми ключами в структуру сообщения.

Вызывает исключение Phoenix.Socket.InvalidMessageError, если карта недействительна.

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

спецификации, руководства, описания, API

free hit counter