Mbed OS Reference
Loading...
Searching...
No Matches
Record Struct Reference

Represent a record. More...

#include <Record.h>

Public Member Functions

 Record ()
 Construct an empty record. More...
 
 Record (RecordType type, const RecordPayload &payload, const RecordID &id, bool chunk, bool last_record)
 Construct a record from its type, payload and id. More...
 

Data Fields

RecordType type
 Type of the record. More...
 
RecordPayload payload
 Value of the payload. More...
 
RecordID id
 ID of the record. More...
 
bool chunk: 1
 If true, this record is a chunked record. More...
 
bool last_record: 1
 If true, this record is the last one of the payload containing it. More...
 

Detailed Description

Represent a record.

Definition at line 149 of file Record.h.

Constructor & Destructor Documentation

◆ Record() [1/2]

Record ( )

Construct an empty record.

Definition at line 153 of file Record.h.

◆ Record() [2/2]

Record ( RecordType  type,
const RecordPayload payload,
const RecordID id,
bool  chunk,
bool  last_record 
)

Construct a record from its type, payload and id.

The flags chunk and last_record can be added to indicate if the record is aprt of a chunk or the last one in a message.

Parameters
typeThe type of the record.
payloadThe payload of the record.
idThe id associated with the record.
chunkIf true then this record is a chunk of a bigger record.
last_recordIf true then this record is the last of the message containing it.

Definition at line 168 of file Record.h.

Field Documentation

◆ type

RecordType type

Type of the record.

Definition at line 185 of file Record.h.

◆ payload

RecordPayload payload

Value of the payload.

Definition at line 190 of file Record.h.

◆ id

ID of the record.

Definition at line 195 of file Record.h.

◆ chunk

bool chunk

If true, this record is a chunked record.

Definition at line 200 of file Record.h.

◆ last_record

bool last_record

If true, this record is the last one of the payload containing it.

Definition at line 205 of file Record.h.