Skip to content

Wire

Jump to bottom Edit New page
Mark Nadal edited this page May 15, 2022 · 4 revisions

Mandatory

Read how to port GUN first. This page is just an outline.

UTF8

UTF8 is used as the default encoding.

  1. { or [, if a wire message (after decompressing) starts with one of these symbols, use JSON (not RAD) to parse it. [ will be a list of messages, just iterate over them and call them individually.

RAD is not used on the wire yet.

Envelope

GUN messages may have extra properties on it, especially if DAM is used, that make up the message envelope.

Message

  • # message identifier to deduplicate against. mandatory
  • @ is the identifier that this message is acknowledging a reply to.
  • get is a lexical lookup.
  • put is a graph.
  • ok object (dictionary/set)
  • err text / number / object

WIP

... more coming soon ...

Add a custom footer

This wiki is where all the GUN website documentation comes from.

You can read it here or on the website, but the website has some special features like rendering some markdown extensions to create interactive coding tutorials.

Please feel free to improve the docs itself, we need contributions!

Clone this wiki locally