msgpax_serializer's Introduction

Msgpax Serializer

Use MessagePack via Msgpax to serialize data sent over a Phoenix Socket.

Usage

Phoenix Socket

Add Phoenix.Socket.V2.MsgpaxSerializer as the serializer for the websocket in endpoint.ex.

socket "/triple-cream-brie-socket", CheeseFactoryWeb.TripleCreamBrieSocket,
  websocket: [serializer: [{Phoenix.Socket.V2.MsgpaxSerializer, "~> 2.0.0"}]],
  longpoll: false

PhoenixGenSocketClient

The fourth arg to GenSocketClient.start_link is the socket_opts, where you set serialzer: Phoenix.Channels.GenSocketClient.Serializer.Msgpax.

GenSocketClient.start_link(
  __MODULE__,
  Phoenix.Channels.GenSocketClient.Transport.WebSocketClient,
  Keyword.put(opts, :url, "ws://cheese.factory/triple-cream-brie-socket/websocket"),
  [serializer: Phoenix.Channels.GenSocketClient.Serializer.Msgpax],
  name: __MODULE__
)

msgpax_serializer's People

Contributors

Watchers

msgpax_serializer's Issues

add JS usage example

something like this person did

npm install --save @msgpack/msgpack

import {encode, decode} from '@msgpack/msgpack'

// Still that old saying, pay attention to the same order!
const serialize = ({join_ref, ref, topic, event, payload}, callback) => callback(encode([join_ref, ref, topic, event, payload]))

const deserialize = (rawMessage, callback) => {
  // Don't I repeat it?
  const [join_ref, ref, topic, event, payload] = decode(rawMessage)
  return callback({join_ref, ref, topic, event, payload})
}

let socket = new Socket("/socket", {
  ...,
  encode: serialize,  // Overwrite the original ws serialization mode
  decode: deserialize  // Overwrite the original ws deserialization mode
})

Recommend Projects