檢視原始碼 Phoenix.Socket.Message (Phoenix v1.7.14)

定義發送超過頻道傳輸的訊息和發送回傳訊息。

訊息格式需要以下鍵值

  • :topic - 字串標題或標題:子標題配對命名空間，例如「訊息」、「訊息: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。