查看源代码 Phoenix.Socket.Message (Phoenix v1.7.14)

定义通过传输发送到通道和反之的消息。

消息格式需要以下键

  • :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。