WebWire for JavaScript
_{An asynchronous duplex messaging library}

WebWire is a high-level asynchronous duplex messaging library built on top of WebSockets and an open source binary message protocol with builtin sessions and support for UTF8 and UTF16 encoding. The webwire-js library provides a client implementation for JavaScript environments.

WebWire Binary Protocol

WebWire is built for speed and portability implementing an open source binary protocol.

More information about the protocol is available at WebWire.

Examples

• Chat Room - Demonstrates advanced use of the library. The corresponding Golang Chat Room Server implements the server-side part of the example.

Features

Request-Reply

Clients can initiate multiple simultaneous requests and receive replies asynchronously. Requests are multiplexed through the connection similar to HTTP2 pipelining.

// Send a request to the server, will block the goroutine until replied
const {reply, err} = await client.request("", "sudo rm -rf /")
if (err != null) {
  // Oh oh, request failed for some reason!
}
reply // Here we go!

Timed requests will timeout and return an error if the server doesn't manage to reply within the specified time frame.

// Send a request to the server, will fail if no reply is received within 200ms
const {reply, err} = await client.request("", "hurry up!", null, 200)
if (err != null) {
  // Probably timed out!
}
reply // Just in time!

Client-side Signals

Individual clients can send signals to the server. Signals are one-way messages guaranteed to arrive not requiring any reply though.

// Send signal to server
const err = await client.signal("eventA", "something")

Server-side Signals

The server also can send signals to individual connected clients.

const client = new WebWireClient(serverAddr, {
  onSignal: signal => {
    signal.payload // Handle server-side signal
  },
})

Namespaces

Different kinds of requests and signals can be differentiated using the builtin namespacing feature.

// Request authentication
const {
  reply: authReply,
  err: authReqErr
} = await client.request("auth", "user:pass")
if (authReqErr != null) {
  // Oh oh, authentication failed!
}

// Request data query
const {
  reply: queryReply,
  err: queryErr
} = await client.request("query", "sudo get sandwich")
if (queryErr != null) {
  // Oh oh, data query failed!
}

const {err: aErr} = await client.signal("eventA", "something happend")
const {err: bErr} = await client.signal("eventB", "something else happened")

Sessions

Individual connections can get sessions assigned to identify them. The state of the session is automagically synchronized between the client and the server. WebWire doesn't enforce any kind of authentication technique though, it just provides a way to authenticate a connection.

const client = new WebWireClient(serverAddr, {
  onSessionCreated: newSession => {
    // The newly created session was just synchronized to the client
  },
})

Automatic Session Restoration

WebWire clients persist their session to the local storage and try to restore it when connecting to the server repeatedly assuming the server didn't yet close this session.

const client = new WebWireClient(serverAddr)
const err = await client.connect()
if (err != null) {
  // Oh, oh! Connection failed
}
client.session // Won't be null, if a previous session was restored

Encodings

Besides plain binary streams WebWire supports UTF8 and UTF16 encodings and will automatically transcode payloads into the explicitly specified encoding. If no encoding is explicitly specified - UTF16 is used for JavaScript strings and plain binary for Uint8Array instances by default.

// Cyrillic text in UTF16
client.request("", "кириллица")

// Cyrillic text in UTF8 automatically transcoded
client.request("", "кириллица", "utf8")

const binaryData = new Uint8Array(new ArrayBuffer(5))
binaryData.set([76, 97, 116, 105, 110], 0) // "Latin"
client.request("", binaryData) // 7-bit ASCII text in binary

© 2018 Roman Sharkov [email protected]