The websocket protocol x-afb-ws-json1

The WebSocket protocol x-afb-ws-json1 is used to communicate between an application and a binder. It allows access to all registered apis of the binder.

This protocol is inspired from the protocol OCPP - SRPC as described for example here: OCPP transport specification - SRPC over WebSocket.

The registration to the IANA is still to be done, see: WebSocket Protocol Registries

This document gives a short description of the protocol x-afb-ws-json1. A more formal description has to be done.

Architecture

The protocol is intended to be symmetric. It allows:

  • to CALL a remote procedure that returns a result
  • to push and receive EVENT

Messages

Valid messages are made of text frames that are all valid JSON.

Valid messages are:

Calls:

[ 2, ID, PROCN, ARGS ]
[ 2, ID, PROCN, ARGS, TOKEN ]

Replies (3: OK, 4: ERROR):

[ 3, ID, RESP ]
[ 4, ID, RESP ]

Events:

[ 5, EVTN, OBJ ]

Where:

Field Type Description
ID string A string that identifies the call. A reply to that call uses the ID of the CALL.
PROCN string The procedure’s name to call, in the form “api/verb”
ARGS any Any argument to pass to the call (see afb_req_json that returns it)
RESP any The response to the call
TOKEN string The authorization token
EVTN string Name of the event in the form “api/event”
OBJ any The companion object of the event

Below, an example of exchange:

C->S:   [2,"156","hello/ping",null]
S->C:   [3,"156",{"response":"Some String","jtype":"afb-reply","request":{"status":"success","info":"Ping Binder Daemon tag=pingSample count=1 query=\"null\""}}]

Javascript implementation

The file AFB.js is a javascript implementation of the protocol.

It can be downloaded here.

A more modern javascript implementation, AFB2.js, can be downloaded here.