Module: lib/common/protocol

Module with synchronous Whiteflag protocol functions

Source:
Tutorials:

Methods

(inner) messageType(wfMessage) → {string}

Determines type of message

Parameters:
Name Type Description
wfMessage wfMessage

a Whiteflag message

Source:
Returns:

message type

Type
string

Type Definitions

wfMessage

A Whiteflag message object

Type:
  • Object
Properties:
Name Type Description
MetaHeader Object

Metaheader for Whiteflag messages as used by the Whiteflag API

MessageHeader Object

Container for the message header fields, which are identical for all message types"

MessageBody Object

Container for the message body, which depends on the message type

Source: