Module envelope 

The Node Management payload envelope.

+-------+---------+------+----------+
| TOKEN | OPTIONS | 0xFF |  FRAME   |
+-------+---------+------+----------+
  2 B    variable   1 B    variable

Request and Response payloads share this format; direction lives entirely in the payload type. The frame extends to the end of the payload, so the end marker is always present.

Structs

Envelope

A parsed envelope borrowing from the payload it was read out of.

Enums

EnvelopeError

Why an envelope could not be read.

Constants

CURSOR_MAX

Longest cursor the format permits.

OPT_CURSOR

Option 1 — the continuation handle for a read spanning several exchanges. Critical: a device that cannot honor a cursor must say so rather than answer from the beginning.

OPT_REMAINING

Option 2 — approximate octets not yet returned. Elective: it drives a progress bar and nothing else.

OVERHEAD_MAX

Worst-case envelope overhead: token, the longest cursor, the longest REMAINING, and the end marker.

Type Aliases

Token

The two-octet token, opaque to everyone but the administrator that chose it.