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

One component's registry record in shared memory. More...

#include <ComponentMemory.h>

Collaboration diagram for cmlabs::ComponentInfoStruct:
[legend]

Public Member Functions

std::string toXML (bool printStats=true)
bool writeToMsg (uint32 n, DataMessage *msg)

Public Attributes

uint64 size
 Total record size in bytes including parameter and data areas.
uint32 id
 Component id (index into the segment's offset table).
uint8 syncStatus
 Cluster sync status (0: not there, 1: in-sync, 2: ready).
uint8 selfTrigger
 SELFTRIGGER_* policy.
uint8 type
 Component type (Whiteboard, Catalog, Module, ...).
uint8 status
 COMPSTATUS_* run status.
uint8 policy
 Migration policy (COMPONENT_CAN_MIGRATE flag).
uint16 nodeID
 Node the component currently runs on.
uint16 procID
 Process (space) the component currently runs in.
uint64 createdTime
 Creation timestamp (µs).
uint64 migratedTime
 Timestamp of the last migration (µs), 0 if never migrated.
uint64 lastUpdateTime
 Timestamp of the last record update (µs).
char name [MAXKEYNAMELEN]
 Component name (unique per system).
ComponentStats stats
AveragePerfStats perfStats
uint16 paramCount
uint32 paramSize
uint16 dataCount
uint64 dataSize

Detailed Description

One component's registry record in shared memory.

Variable-sized: the fixed fields below are followed by paramSize bytes of parameters (ParamHeader entries) and dataSize bytes of private data (PrivateHeader entries).

Warning
Shared-memory layout; see MemoryManager.h for the ABI/rebuild warning.

Definition at line 141 of file ComponentMemory.h.

Member Function Documentation

◆ toXML()

std::string cmlabs::ComponentInfoStruct::toXML ( bool printStats = true)
inline

Definition at line 166 of file ComponentMemory.h.

References createdTime, dataCount, dataSize, lastUpdateTime, migratedTime, name, nodeID, paramCount, paramSize, perfStats, policy, procID, selfTrigger, stats, cmlabs::utils::StringFormat(), syncStatus, and type.

◆ writeToMsg()

bool cmlabs::ComponentInfoStruct::writeToMsg ( uint32 n,
DataMessage * msg )
inline

Definition at line 174 of file ComponentMemory.h.

References createdTime, name, nodeID, policy, procID, selfTrigger, cmlabs::DataMessage::setInt(), cmlabs::DataMessage::setString(), cmlabs::DataMessage::setTime(), size, status, and type.

Member Data Documentation

◆ createdTime

uint64 cmlabs::ComponentInfoStruct::createdTime

Creation timestamp (µs).

Definition at line 152 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::cancelComponentID(), cmlabs::ComponentMemory::createComponent(), toXML(), and writeToMsg().

◆ dataCount

uint16 cmlabs::ComponentInfoStruct::dataCount

Definition at line 163 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::deletePrivateData(), cmlabs::ComponentMemory::setPrivateData(), and toXML().

◆ dataSize

uint64 cmlabs::ComponentInfoStruct::dataSize

Definition at line 164 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::deletePrivateData(), cmlabs::ComponentMemory::getPrivateDataKeys(), cmlabs::ComponentMemory::getPrivateDataKeysAndTypes(), cmlabs::ComponentMemory::setPrivateData(), and toXML().

◆ id

uint32 cmlabs::ComponentInfoStruct::id

Component id (index into the segment's offset table).

Definition at line 143 of file ComponentMemory.h.

◆ lastUpdateTime

uint64 cmlabs::ComponentInfoStruct::lastUpdateTime

Timestamp of the last record update (µs).

Definition at line 154 of file ComponentMemory.h.

Referenced by toXML().

◆ migratedTime

uint64 cmlabs::ComponentInfoStruct::migratedTime

Timestamp of the last migration (µs), 0 if never migrated.

Definition at line 153 of file ComponentMemory.h.

Referenced by toXML().

◆ name

char cmlabs::ComponentInfoStruct::name[MAXKEYNAMELEN]

Component name (unique per system).

Definition at line 155 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::getComponentName(), cmlabs::ComponentMemory::getComponentNameString(), cmlabs::ComponentMemory::lookupComponentID(), toXML(), and writeToMsg().

◆ nodeID

uint16 cmlabs::ComponentInfoStruct::nodeID

Node the component currently runs on.

Definition at line 149 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::addLocalPerformanceStats(), cmlabs::ComponentMemory::cancelComponentID(), cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::getComponentLocation(), cmlabs::ComponentMemory::getComponentNodeID(), cmlabs::ComponentMemory::isComponentLocal(), toXML(), cmlabs::ComponentMemory::updateComponentInformation(), cmlabs::ComponentMemory::updateComponentLocation(), and writeToMsg().

◆ paramCount

uint16 cmlabs::ComponentInfoStruct::paramCount

Definition at line 160 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::deleteParameter(), and toXML().

◆ paramSize

uint32 cmlabs::ComponentInfoStruct::paramSize

Definition at line 161 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::createParameter(), cmlabs::ComponentMemory::deleteParameter(), cmlabs::ComponentMemory::getPrivateDataKeys(), cmlabs::ComponentMemory::getPrivateDataKeysAndTypes(), and toXML().

◆ perfStats

AveragePerfStats cmlabs::ComponentInfoStruct::perfStats

Definition at line 158 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::getComponentPerfStats(), cmlabs::ComponentMemory::setComponentPerfStats(), and toXML().

◆ policy

uint8 cmlabs::ComponentInfoStruct::policy

Migration policy (COMPONENT_CAN_MIGRATE flag).

Definition at line 148 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::getComponentPolicy(), cmlabs::ComponentMemory::setComponentPolicy(), toXML(), cmlabs::ComponentMemory::updateComponentInformation(), and writeToMsg().

◆ procID

uint16 cmlabs::ComponentInfoStruct::procID

Process (space) the component currently runs in.

Definition at line 150 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::addLocalPerformanceStats(), cmlabs::ComponentMemory::cancelComponentID(), cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::getComponentLocation(), cmlabs::ComponentMemory::getComponentProcessID(), toXML(), cmlabs::ComponentMemory::updateComponentInformation(), cmlabs::ComponentMemory::updateComponentLocation(), and writeToMsg().

◆ selfTrigger

uint8 cmlabs::ComponentInfoStruct::selfTrigger

SELFTRIGGER_* policy.

Definition at line 145 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::getComponentSelfTrigger(), cmlabs::ComponentMemory::setComponentSelfTrigger(), toXML(), cmlabs::ComponentMemory::updateComponentInformation(), and writeToMsg().

◆ size

uint64 cmlabs::ComponentInfoStruct::size

Total record size in bytes including parameter and data areas.

Definition at line 142 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::addLocalPerformanceStats(), cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::destroyComponent(), cmlabs::ComponentMemory::getComponentData(), cmlabs::ComponentMemory::setComponentData(), and writeToMsg().

◆ stats

ComponentStats cmlabs::ComponentInfoStruct::stats

Definition at line 157 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::addComponentStats(), cmlabs::ComponentMemory::addLocalPerformanceStats(), cmlabs::ComponentMemory::getComponentStats(), cmlabs::ComponentMemory::setComponentData(), cmlabs::ComponentMemory::setComponentStats(), and toXML().

◆ status

uint8 cmlabs::ComponentInfoStruct::status

COMPSTATUS_* run status.

Definition at line 147 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::addComponentStats(), cmlabs::ComponentMemory::addLocalPerformanceStats(), and writeToMsg().

◆ syncStatus

uint8 cmlabs::ComponentInfoStruct::syncStatus

Cluster sync status (0: not there, 1: in-sync, 2: ready).

Definition at line 144 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::cancelComponentID(), cmlabs::ComponentMemory::confirmComponentID(), cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::lookupComponentID(), toXML(), and cmlabs::ComponentMemory::updateComponentInformation().

◆ type

uint8 cmlabs::ComponentInfoStruct::type

Component type (Whiteboard, Catalog, Module, ...).

Definition at line 146 of file ComponentMemory.h.

Referenced by cmlabs::ComponentMemory::addLocalPerformanceStats(), cmlabs::ComponentMemory::cancelComponentID(), cmlabs::ComponentMemory::confirmComponentID(), cmlabs::ComponentMemory::createComponent(), cmlabs::ComponentMemory::getComponentType(), toXML(), cmlabs::ComponentMemory::updateComponentInformation(), and writeToMsg().

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