Module: lib/protocol/codec

Module for Whiteflag message encoding and decoding

Source:
Tutorials:

Methods

(inner) encodeMessage(wfMessage, callback)

Encodes a json formatted message to binary format and updates metaheader accordingly

Parameters:
Name Type Description
wfMessage wfMessage

a Whiteflag message
callback function

function to be called upon completion
Source:

(inner) verifyFormat(wfMessage, callback)

Checks if message formate validates against schema and updates metaheader accordingly

Parameters:
Name Type Description
wfMessage wfMessage

a Whiteflag message
callback function

function to be called upon completion
Source:

Type Definitions

ivMissing

Decodes binary message to validated json object and updates metaheader accordingly

Type:
  • boolean
Source: