fulmine.protocol.specification
Interface IFrameConstants

public interface IFrameConstants

Various constants for expressing component and section sizes and lengths in the fulmine delta (FD) frame preamble. A frame has the following structure:

 ----------------------------
 | preamble | header | data |
 ----------------------------
 

The preamble is further divided into a static and dynamic section:

 ------------------------------------------------------------------------------------------------
 |   dynamic section   |                static section                                          |
 ------------------------------------------------------------------------------------------------
 | 1 byte  |  x bytes  |    1 byte   |   1 byte     | 1 byte |2 bytes |   4 bytes   | 4 bytes   |
 ------------------------------------------------------------------------------------------------
 | ID size | Record ID | Record type | Record state | domain | Unused | Header size | Data size |
 ------------------------------------------------------------------------------------------------
 

A nested FD frame has the following structure:

 -----------------------------------------------------------------
 |  nested frame preamble  |            nested frame             |
 -----------------------------------------------------------------
 |   4 byte    |  4 byte   | header size bytes | data size bytes |
 -----------------------------------------------------------------
 | header size | data size |       header      |       data      |
 -----------------------------------------------------------------
 

Author:

Ramon Servadei

Field Summary

static int	DATA_SIZE_LENGTH The number of bytes for the 'Data size' component in the FD frame preamble
static int	DATA_SIZE_START The start position of the 'Data size' component in the static section of the FD frame preamble
static int	HEADER_SIZE_LENGTH The number of bytes for the 'Header size' component in the FD frame preamble
static int	HEADER_SIZE_START The start position of the 'Header size' component in the static section of the FD frame preamble
static int	ID_SIZE_LENGTH The number of bytes for the 'ID Size' component in the FD frame preamble
static int	NESTED_FRAME_PREAMBLE_LENGTH The preamble length of a nested frame.
static int	PREAMBLE_STATIC_SECTION_LENGTH The number of bytes making up the static section in the FD frame preamble
static int	RECORD_DOMAIN_LENGTH The number of bytes for the 'Record domain' component in the FD frame preamble
static int	RECORD_STATE_LENGTH The number of bytes for the 'Record state' component in the FD frame preamble.
static int	RECORD_TYPE_LENGTH The number of bytes for the 'Record type' component in the FD frame preamble
static int	UNUSED_LENGTH The number of bytes for the 'Unused' component in the FD frame preamble

Field Detail

RECORD_STATE_LENGTH

static final int RECORD_STATE_LENGTH

The number of bytes for the 'Record state' component in the FD frame preamble.

See Also:

Constant Field Values

RECORD_TYPE_LENGTH

static final int RECORD_TYPE_LENGTH

The number of bytes for the 'Record type' component in the FD frame preamble

See Also:

Constant Field Values

RECORD_DOMAIN_LENGTH

static final int RECORD_DOMAIN_LENGTH

The number of bytes for the 'Record domain' component in the FD frame preamble

See Also:

Constant Field Values

UNUSED_LENGTH

static final int UNUSED_LENGTH

The number of bytes for the 'Unused' component in the FD frame preamble

See Also:

Constant Field Values

HEADER_SIZE_LENGTH

static final int HEADER_SIZE_LENGTH

The number of bytes for the 'Header size' component in the FD frame preamble

See Also:

Constant Field Values

DATA_SIZE_LENGTH

static final int DATA_SIZE_LENGTH

The number of bytes for the 'Data size' component in the FD frame preamble

See Also:

Constant Field Values

PREAMBLE_STATIC_SECTION_LENGTH

static final int PREAMBLE_STATIC_SECTION_LENGTH

The number of bytes making up the static section in the FD frame preamble

See Also:

Constant Field Values

ID_SIZE_LENGTH

static final int ID_SIZE_LENGTH

The number of bytes for the 'ID Size' component in the FD frame preamble

See Also:

Constant Field Values

HEADER_SIZE_START

static final int HEADER_SIZE_START

The start position of the 'Header size' component in the static section of the FD frame preamble

See Also:

Constant Field Values

DATA_SIZE_START

static final int DATA_SIZE_START

The start position of the 'Data size' component in the static section of the FD frame preamble

See Also:

Constant Field Values

NESTED_FRAME_PREAMBLE_LENGTH

static final int NESTED_FRAME_PREAMBLE_LENGTH

The preamble length of a nested frame.

 -----------------------------------------------------------------
 |  nested frame preamble  |            nested frame             |
 -----------------------------------------------------------------
 |   4 byte    |  4 byte   | header size bytes | data size bytes |
 -----------------------------------------------------------------
 | header size | data size |       header      |       data      |
 -----------------------------------------------------------------
 

See Also:

Constant Field Values