Share via


Header Class

Definition

The 48-byte, fixed size, header prefaces every payload. The header must always have the same shape, regardless of if its payload is a request, response, or content.It is a period-delimited ASCII-encoded string terminated with a newline.All headers must have these segments, and all values must be zero padded to fill the correct number of bytes: |Title Size Description |Type 1 byte ASCII-encoded char. Describes the format of the payload(request, response, stream, etc.) |Delimiter 1 byte ASCII period character. |Length 6 bytes ASCII-encoded decimal. Size in bytes of this payload in ASCII decimal, not including the header. Zero padded. |Delimiter 1 byte ASCII period character. |ID 36 bytes ASCII-encoded hex. GUID (Request ID, Stream ID, etc.). |Delimiter 1 byte ASCII period character. |End 1 byte ASCII ‘0’ or ‘1’. Signals the end of a payload or multi-part payload. |Terminator 1 byte Hardcoded to \n . ex: A.000168.68e999ca-a651-40f4-ad8f-3aaf781862b4.1\n end example.

public class Header
type Header = class
Public Class Header
Inheritance
Header

Constructors

Header()

Properties

End

Gets or sets a value indicating whether the 1 byte ASCII value is ‘0’ or ‘1’. Signals the end of a payload or multi-part payload.

Id

Gets or sets the 36 bytes ASCII-encoded hex. GUID (Request ID, Stream ID, etc.).

PayloadLength

Gets or sets the 6 bytes ASCII-encoded decimal. Size in bytes of this payload in ASCII decimal, not including the header. Zero padded.

Type

Gets or sets the 1 byte ASCII-encoded char. Describes the format of the payload(request, response, stream, etc.).

Applies to