cmlabs::RequestMapEntry Struct Reference

Request-map entry tracking one cross-component request/reply transaction. More...

#include <DataMapsMemory.h>

Public Member Functions
std::string	toXML ()

Static Public Member Functions
static std::string	GetOuterXMLName ()

Public Attributes
uint32	id
	Request id; corresponds to the index in the map.
uint64	time
	Creation timestamp (µs).
char	name [MAXKEYNAMELEN+1]
	Internal use only, for named events.
uint64	lastUpdate
	Timestamp of the last status change (µs); used to expire stale requests.
uint8	status
	REQ_* lifecycle status.
uint32	from
	Id of the component making the request.
uint32	to
	Id of the component processing the request.
uint32	remoteID
	Id of the request at the origin node, if forwarded cross-node.
uint64	dataMessageID
	TemporalMemory id of the reply DataMessage (0 = none yet).
uint64	dataMessageEOL
	End-of-life of the reply message; after this the payload is gone (REQ_*_DATA_EOL).
uint32	key

Detailed Description

Request-map entry tracking one cross-component request/reply transaction.

Legacy request-map entry tracking one request/reply transaction.

The reply payload itself is stored in TemporalMemory (dataMessageID/dataMessageEOL).

Warning

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

Shared-memory layout.

Definition at line 210 of file DataMapsMemory.h.

Member Function Documentation

GetOuterXMLName()

std::string cmlabs::RequestMapEntry::GetOuterXMLName ( )

inlinestatic

Definition at line 225 of file DataMapsMemory.h.

toXML()

std::string cmlabs::RequestMapEntry::toXML ( )

inline

Definition at line 221 of file DataMapsMemory.h.

References dataMessageEOL, dataMessageID, from, lastUpdate, name, remoteID, status, cmlabs::utils::StringFormat(), time, and to.

Member Data Documentation

dataMessageEOL

uint64 cmlabs::RequestMapEntry::dataMessageEOL

End-of-life of the reply message; after this the payload is gone (REQ_*_DATA_EOL).

Definition at line 220 of file DataMapsMemory.h.

Referenced by toXML().

dataMessageID

uint64 cmlabs::RequestMapEntry::dataMessageID

TemporalMemory id of the reply DataMessage (0 = none yet).

Definition at line 219 of file DataMapsMemory.h.

Referenced by toXML().

from

uint32 cmlabs::RequestMapEntry::from

Id of the component making the request.

Definition at line 216 of file DataMapsMemory.h.

Referenced by toXML().

id

uint32 cmlabs::RequestMapEntry::id

Request id; corresponds to the index in the map.

Definition at line 211 of file DataMapsMemory.h.

key

uint32 cmlabs::RequestMapEntry::key

Definition at line 199 of file MemoryMaps.h.

lastUpdate

uint64 cmlabs::RequestMapEntry::lastUpdate

Timestamp of the last status change (µs); used to expire stale requests.

Definition at line 214 of file DataMapsMemory.h.

Referenced by toXML().

name

char cmlabs::RequestMapEntry::name

Internal use only, for named events.

Definition at line 213 of file DataMapsMemory.h.

Referenced by toXML().

remoteID

uint32 cmlabs::RequestMapEntry::remoteID

Id of the request at the origin node, if forwarded cross-node.

Definition at line 218 of file DataMapsMemory.h.

Referenced by toXML().

status

uint8 cmlabs::RequestMapEntry::status

REQ_* lifecycle status.

Definition at line 215 of file DataMapsMemory.h.

Referenced by toXML().

time

uint64 cmlabs::RequestMapEntry::time

Creation timestamp (µs).

Definition at line 212 of file DataMapsMemory.h.

Referenced by toXML().

to

uint32 cmlabs::RequestMapEntry::to

Id of the component processing the request.

Definition at line 217 of file DataMapsMemory.h.

Referenced by toXML().

---

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

• /home/ubuntu/c/partner/psyclone2/CMSDK/include/DataMapsMemory.h
• /home/ubuntu/c/partner/psyclone2/CMSDK/include/MemoryMaps.h