CMSDK 2.0.1
Cross-platform C++ base library and SDK for the Psyclone AIOS platform
Loading...
Searching...
No Matches
cmlabs::DataMessageEntryHeader Struct Reference
Messaging

Header preceding every user entry inside a DataMessage's flat memory block. More...

#include <DataMessage.h>

Public Attributes

uint32 size
 Total size of this entry in bytes, including this header, the key and the payload.
uint32 cid
 Content type id of the payload (CONSTCHARID, TIMEID, INTID, DOUBLEID, CHARDATAID, DATAMESSAGEID, UNUSEDID, ...), see ObjectIDs.h.

Detailed Description

Header preceding every user entry inside a DataMessage's flat memory block.

Each user entry (key/value pair) inside a DataMessage starts with this 8-byte header, followed by the NUL-terminated key string and then the value payload. Entries are walked sequentially by advancing size bytes; a deleted entry keeps its slot but has its cid set to UNUSEDID so the space can later be reused by an entry of exactly the same size (see DataMessage::findSpace()).

Definition at line 128 of file DataMessage.h.

Member Data Documentation

◆ cid

uint32 cmlabs::DataMessageEntryHeader::cid

Content type id of the payload (CONSTCHARID, TIMEID, INTID, DOUBLEID, CHARDATAID, DATAMESSAGEID, UNUSEDID, ...), see ObjectIDs.h.

Definition at line 130 of file DataMessage.h.

◆ size

uint32 cmlabs::DataMessageEntryHeader::size

Total size of this entry in bytes, including this header, the key and the payload.

Used as the skip distance when scanning entries.

Definition at line 129 of file DataMessage.h.

Referenced by cmlabs::DataMessage::copyUserEntriesFromMessage(), cmlabs::DataMessage::fillInDraftUserDataFrom(), cmlabs::DataMessage::findKey(), cmlabs::DataMessage::findSpace(), cmlabs::DataMessage::getArraySize(), cmlabs::DataMessage::getAsFloatArray(), cmlabs::DataMessage::getAsFloatMap(), cmlabs::DataMessage::getAsIntArray(), cmlabs::DataMessage::getAsIntMap(), cmlabs::DataMessage::getAsStringArray(), cmlabs::DataMessage::getAsStringMap(), cmlabs::DataMessage::getAttachedMessageArray(), cmlabs::DataMessage::getAttachedMessageMap(), cmlabs::DataMessage::getDoubleArray(), cmlabs::DataMessage::getDoubleMap(), cmlabs::DataMessage::getFloatArray(), cmlabs::DataMessage::getFloatMap(), cmlabs::DataMessage::getIntArray(), cmlabs::DataMessage::getIntMap(), cmlabs::DataMessage::getKeyType(), cmlabs::DataMessage::getMapSize(), cmlabs::DataMessage::getStringArray(), cmlabs::DataMessage::getStringMap(), cmlabs::DataMessage::getTimeArray(), cmlabs::DataMessage::getTimeMap(), cmlabs::DataMessage::getUserEntriesAsJSON(), cmlabs::DataMessage::getUserEntriesAsString(), cmlabs::DataMessage::isArrayContent(), cmlabs::DataMessage::isMapContent(), cmlabs::DataMessage::toJSON(), and cmlabs::DataMessage::toXML().

The documentation for this struct was generated from the following file: