Swindon-lattice Protocol

The protocol is higher level-protocol on top of websockets that allows routing messages between backends, push from any backend to any user, publish-subscribe and few other useful things.

The protocol is designed to cover large number of cases including different applications covered by single websocket connection for efficiency.

The protocol is registered by IANA as v1.swindon-lattice+json and this value needs to be passed in Sec-WebSocket-Protocol field in handshake.

• Lattices
  • What Does Client See?
  • What Does Backend Send?
    • Example
  • Why is it so Complex?
• CRDT Types
• Frontend API Reference
  • Request Format
    • Example
  • Response Format
  • Event Types
    • Method Call Result (result/error)
    • User Information (hello)
    • Fatal Errors (fatal_error)
    • Message (message)
    • Lattice Update (lattice)
• Upstream backend requirements
  • General requests format
  • Authorization request
  • Inactive session notification
  • Websocket calls
• Backend API Reference
  • Pub/Sub subscriptions
  • Lattice Subscriptions
  • Users Lattice
  • Parameters specification
  • API response status codes
• Websocket Shutdown Codes
• Example Applications