Accessor for the shared name/id maps and the request map. More...

#include <DataMapsMemory.h>

Public Member Functions
	DataMapsMemory (MasterMemory *master)
	~DataMapsMemory ()
bool	open ()
	Attach to the existing data-maps segment.
bool	create (uint32 typesMaxCount, uint32 contextsMaxCount, uint32 tagsMaxCount, uint32 cranksMaxCount, uint32 requestsMaxCount)
	Create the segment (master only) with the given per-map capacities.
bool	getMemoryUsage (uint64 &alloc, uint64 &usage)
	Report allocation/usage.
bool	maintenance ()
	Periodic cleanup (e.g.
std::string	printFriendlyHTML ()
std::string	toXML ()
bool	writeIDsToMsg (DataMessage *msg)
	Write all map names/ids into msg for cluster sync.
Type-level map (message type names ↔ uint16 ids)
Two-phase creation: createNewTypeLevel() reserves, confirm/cancel commits or rolls back; lookup* returns the sync status (0 absent, 1 in-sync, 2 ready).
bool	writeTypeLevelsToMsg (DataMessage *msg)
bool	confirmTypeLevelID (uint16 id)
bool	cancelTypeLevelID (uint16 id)
bool	createNewTypeLevel (uint16 id, const char *name, uint64 time, uint16 &existingID)
bool	syncTypeLevels (DataMessage *msg)
bool	getTypeLevelName (uint16 id, char *name, uint32 maxSize)
bool	getTypeLevelID (const char *name, uint16 &id)
uint8	lookupTypeLevelID (const char *name, uint16 &id)
bool	deleteTypeLevel (const char *name)
bool	deleteTypeLevel (uint16 id)
uint64	getTypeLevelCreateTime (uint16 id)
std::string	printAllTypes ()
Context-level map (context names ↔ uint16 ids); same two-phase pattern as types.
bool	writeContextLevelsToMsg (DataMessage *msg)
bool	confirmContextLevelID (uint16 id)
bool	cancelContextLevelID (uint16 id)
bool	createNewContextLevel (uint16 id, const char *name, uint64 time, uint16 &existingID)
bool	syncContextLevels (DataMessage *msg)
bool	getContextLevelName (uint16 id, char *name, uint32 maxSize)
bool	getContextLevelID (const char *name, uint16 &id)
uint8	lookupContextLevelID (const char *name, uint16 &id)
bool	deleteContextLevel (const char *name)
bool	deleteContextLevel (uint16 id)
uint64	getContextLevelCreateTime (uint16 id)
std::string	printAllContexts ()
Tag map (tag names ↔ uint32 ids); same two-phase pattern as types.
bool	writeTagsToMsg (DataMessage *msg)
bool	confirmTagID (uint32 id)
bool	cancelTagID (uint32 id)
bool	createNewTag (uint32 id, const char *name, uint64 time, uint32 &existingID)
bool	syncTags (DataMessage *msg)
bool	getTagName (uint32 id, char *name, uint32 maxSize)
bool	getTagID (const char *name, uint32 &id)
uint8	lookupTagID (const char *name, uint32 &id)
bool	deleteTag (const char *name)
bool	deleteTag (uint32 id)
uint64	getTagCreateTime (uint32 id)
Crank map (crank callbacks/scripts ↔ uint16 ids); same two-phase pattern, with
extra fields for function, library filename, language and inline script.
bool	writeCranksToMsg (DataMessage *msg)
bool	confirmCrankID (uint16 id)
bool	cancelCrankID (uint16 id)
bool	createNewCrank (uint16 id, uint32 compID, const char name, const char function, const char libraryFilename, const char language, const char *script, uint64 time, uint16 &existingID)
bool	syncCranks (DataMessage *msg)
bool	getCrankName (uint16 id, char *name, uint32 maxSize)
bool	getCrankFunction (uint16 id, char *function, uint32 maxSize)
bool	getCrankLanguage (uint16 id, char *language, uint32 maxSize)
bool	getCrankLibraryFilename (uint16 id, char *libraryFilename, uint32 maxSize)
bool	getCrankID (const char *name, uint16 &id)
uint8	lookupCrankID (const char *name, uint16 &id)
uint32	getCrankCompID (uint16 id)
bool	getCrankScript (uint16 id, char *script, uint32 maxSize)
bool	deleteCrank (uint16 id)
bool	deleteCrank (const char *name)
uint64	getCrankCreateTime (uint16 id)
Request map (cross-component request/reply tracking)
createNewRequest() allocates a transaction id; setRequestStatus() advances it through the REQ_* lifecycle (optionally attaching the temporal-memory id of the reply); waitForRequestReply() blocks the caller up to timeout ms until a terminal status.
bool	createNewRequest (uint32 from, uint32 to, uint32 remoteID, uint32 &id)
bool	getRequestInfo (uint32 id, uint32 &from, uint32 &to, uint32 &remoteID)
bool	getRequestStatus (uint32 id, uint8 &status, uint64 &time, uint64 &msgID, uint64 &msgEOL)
bool	setRequestStatus (uint32 id, uint8 status)
bool	setRequestStatus (uint32 id, uint8 status, uint64 msgID, uint64 msgEOL)
bool	waitForRequestReply (uint32 id, uint32 timeout, uint8 &status, uint64 &time, uint64 &msgID, uint64 &msgEOL)
bool	deleteRequest (uint32 id)
uint32	getRequestCount ()

Detailed Description

Accessor for the shared name/id maps and the request map.

One instance per process (created by MemoryManager); master calls create(), others open(). All calls lock the segment's named cross-process mutex and re-attach when the segment was resized (serial check). The confirm/cancel method pairs implement two-phase, cluster-wide id allocation; sync* methods merge entries received from remote nodes.

uint16 id, existing;
dataMapsMemory->createNewTypeLevel(id, "Vision.Face", now, existing); // reserve
dataMapsMemory->confirmTypeLevelID(id);                              // commit
uint16 found; dataMapsMemory->getTypeLevelID("Vision.Face", found);

Definition at line 245 of file DataMapsMemory.h.

Constructor & Destructor Documentation

◆ DataMapsMemory()

cmlabs::DataMapsMemory::DataMapsMemory ( MasterMemory * master )

Parameters

master Segment bookkeeping interface (borrowed, not owned).

Definition at line 9 of file DataMapsMemory.cpp.

◆ ~DataMapsMemory()

cmlabs::DataMapsMemory::~DataMapsMemory ( )

Definition at line 24 of file DataMapsMemory.cpp.

References cmlabs::utils::CloseSharedMemorySegment().

Member Function Documentation

◆ cancelContextLevelID()

bool cmlabs::DataMapsMemory::cancelContextLevelID ( uint16 id )

Definition at line 640 of file DataMapsMemory.cpp.

References cmlabs::GenericMemoryMap< T, ID >::CancelEntry(), and CHECKDATAMAPSMEMORYSERIAL.

◆ cancelCrankID()

bool cmlabs::DataMapsMemory::cancelCrankID ( uint16 id )

Definition at line 923 of file DataMapsMemory.cpp.

References cmlabs::GenericMemoryMap< T, ID >::CancelEntry(), and CHECKDATAMAPSMEMORYSERIAL.

◆ cancelTagID()

bool cmlabs::DataMapsMemory::cancelTagID ( uint32 id )

Definition at line 784 of file DataMapsMemory.cpp.

References cmlabs::GenericMemoryMap< T, ID >::CancelEntry(), and CHECKDATAMAPSMEMORYSERIAL.

◆ cancelTypeLevelID()

bool cmlabs::DataMapsMemory::cancelTypeLevelID ( uint16 id )

Definition at line 366 of file DataMapsMemory.cpp.

References cmlabs::GenericMemoryMap< T, ID >::CancelEntry(), and CHECKDATAMAPSMEMORYSERIAL.

◆ confirmContextLevelID()

bool cmlabs::DataMapsMemory::confirmContextLevelID ( uint16 id )

Definition at line 631 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::ConfirmEntry().

Referenced by syncContextLevels().

◆ confirmCrankID()

bool cmlabs::DataMapsMemory::confirmCrankID ( uint16 id )

Definition at line 914 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::ConfirmEntry().

Referenced by syncCranks().

◆ confirmTagID()

bool cmlabs::DataMapsMemory::confirmTagID ( uint32 id )

Definition at line 775 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::ConfirmEntry().

Referenced by syncTags(), and cmlabs::ComponentMemory::UnitTest().

◆ confirmTypeLevelID()

bool cmlabs::DataMapsMemory::confirmTypeLevelID ( uint16 id )

Definition at line 357 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::ConfirmEntry().

Referenced by syncTypeLevels(), and cmlabs::ComponentMemory::UnitTest().

◆ create()

bool cmlabs::DataMapsMemory::create	(	uint32	typesMaxCount,
		uint32	contextsMaxCount,
		uint32	tagsMaxCount,
		uint32	cranksMaxCount,
		uint32	requestsMaxCount )

Create the segment (master only) with the given per-map capacities.

Returns: true on success.

Definition at line 62 of file DataMapsMemory.cpp.

◆ createNewContextLevel()

bool cmlabs::DataMapsMemory::createNewContextLevel	(	uint16	id,
		const char *	name,
		uint64	time,
		uint16 &	existingID )

Definition at line 649 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::CreateEntry(), cmlabs::GenericMemoryMap< T, ID >::GetEntryID(), and cmlabs::ContextMapEntry::time.

Referenced by syncContextLevels().

◆ createNewCrank()

bool cmlabs::DataMapsMemory::createNewCrank	(	uint16	id,
		uint32	compID,
		const char *	name,
		const char *	function,
		const char *	libraryFilename,
		const char *	language,
		const char *	script,
		uint64	time,
		uint16 &	existingID )

Definition at line 932 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::CrankMapEntry::compID, cmlabs::GenericMemoryMap< T, ID >::CreateEntry(), cmlabs::CrankMapEntry::function, cmlabs::GenericMemoryMap< T, ID >::GetEntryID(), cmlabs::CrankMapEntry::language, cmlabs::CrankMapEntry::libraryFilename, MAXKEYNAMELEN, MAXSCRIPTLEN, cmlabs::CrankMapEntry::script, cmlabs::utils::strcpyavail(), and cmlabs::CrankMapEntry::time.

Referenced by syncCranks().

◆ createNewRequest()

bool cmlabs::DataMapsMemory::createNewRequest	(	uint32	from,
		uint32	to,
		uint32	remoteID,
		uint32 &	id )

Definition at line 1137 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::CreateFirstFreeEntry(), cmlabs::GetTimeNow(), LOG_MEMORY, LogPrint, maintenance(), MAXKEYNAMELEN, and REQ_CREATED.

◆ createNewTag()

bool cmlabs::DataMapsMemory::createNewTag	(	uint32	id,
		const char *	name,
		uint64	time,
		uint32 &	existingID )

Definition at line 793 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::CreateEntry(), cmlabs::GenericMemoryMap< T, ID >::GetEntryID(), and cmlabs::TagMapEntry::time.

Referenced by syncTags(), and cmlabs::ComponentMemory::UnitTest().

◆ createNewTypeLevel()

bool cmlabs::DataMapsMemory::createNewTypeLevel	(	uint16	id,
		const char *	name,
		uint64	time,
		uint16 &	existingID )

Definition at line 492 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::CreateEntry(), cmlabs::GenericMemoryMap< T, ID >::GetEntry(), cmlabs::GenericMemoryMap< T, ID >::GetEntryID(), cmlabs::TypeMapEntry::name, and cmlabs::TypeMapEntry::time.

Referenced by syncTypeLevels(), and cmlabs::ComponentMemory::UnitTest().

◆ deleteContextLevel() [1/2]

bool cmlabs::DataMapsMemory::deleteContextLevel ( const char * name )

Definition at line 718 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::DeleteEntry(), and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

◆ deleteContextLevel() [2/2]

bool cmlabs::DataMapsMemory::deleteContextLevel ( uint16 id )

Definition at line 734 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::DeleteEntry().

◆ deleteCrank() [1/2]

bool cmlabs::DataMapsMemory::deleteCrank ( const char * name )

Definition at line 1088 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::DeleteEntry(), and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

◆ deleteCrank() [2/2]

bool cmlabs::DataMapsMemory::deleteCrank ( uint16 id )

Definition at line 1104 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::DeleteEntry().

◆ deleteRequest()

bool cmlabs::DataMapsMemory::deleteRequest ( uint32 id )

Definition at line 1287 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::DeleteEntry(), LOG_MEMORY, and LogPrint.

◆ deleteTag() [1/2]

bool cmlabs::DataMapsMemory::deleteTag ( const char * name )

Definition at line 864 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::DeleteEntry(), and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

◆ deleteTag() [2/2]

bool cmlabs::DataMapsMemory::deleteTag ( uint32 id )

Definition at line 880 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::DeleteEntry().

◆ deleteTypeLevel() [1/2]

bool cmlabs::DataMapsMemory::deleteTypeLevel ( const char * name )

Definition at line 574 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::DeleteEntry(), and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

◆ deleteTypeLevel() [2/2]

bool cmlabs::DataMapsMemory::deleteTypeLevel ( uint16 id )

Definition at line 590 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::DeleteEntry().

◆ getContextLevelCreateTime()

uint64 cmlabs::DataMapsMemory::getContextLevelCreateTime ( uint16 id )

Definition at line 749 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryTime().

◆ getContextLevelID()

bool cmlabs::DataMapsMemory::getContextLevelID	(	const char *	name,
		uint16 &	id )

Definition at line 694 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

◆ getContextLevelName()

bool cmlabs::DataMapsMemory::getContextLevelName	(	uint16	id,
		char *	name,
		uint32	maxSize )

Definition at line 679 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryName().

◆ getCrankCompID()

uint32 cmlabs::DataMapsMemory::getCrankCompID ( uint16 id )

Definition at line 1072 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntry().

◆ getCrankCreateTime()

uint64 cmlabs::DataMapsMemory::getCrankCreateTime ( uint16 id )

Definition at line 1119 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryTime().

◆ getCrankFunction()

bool cmlabs::DataMapsMemory::getCrankFunction	(	uint16	id,
		char *	function,
		uint32	maxSize )

Definition at line 966 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), and cmlabs::utils::strcpyavail().

◆ getCrankID()

bool cmlabs::DataMapsMemory::getCrankID	(	const char *	name,
		uint16 &	id )

Definition at line 1048 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

◆ getCrankLanguage()

bool cmlabs::DataMapsMemory::getCrankLanguage	(	uint16	id,
		char *	language,
		uint32	maxSize )

Definition at line 982 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), and cmlabs::utils::strcpyavail().

◆ getCrankLibraryFilename()

bool cmlabs::DataMapsMemory::getCrankLibraryFilename	(	uint16	id,
		char *	libraryFilename,
		uint32	maxSize )

Definition at line 999 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), and cmlabs::utils::strcpyavail().

◆ getCrankName()

bool cmlabs::DataMapsMemory::getCrankName	(	uint16	id,
		char *	name,
		uint32	maxSize )

Definition at line 1033 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryName().

◆ getCrankScript()

bool cmlabs::DataMapsMemory::getCrankScript	(	uint16	id,
		char *	script,
		uint32	maxSize )

Definition at line 1016 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), and cmlabs::utils::strcpyavail().

◆ getMemoryUsage()

bool cmlabs::DataMapsMemory::getMemoryUsage	(	uint64 &	alloc,
		uint64 &	usage )

Report allocation/usage.

Returns: true on success.

Definition at line 44 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL.

◆ getRequestCount()

uint32 cmlabs::DataMapsMemory::getRequestCount ( )

Definition at line 1302 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetCount().

◆ getRequestInfo()

bool cmlabs::DataMapsMemory::getRequestInfo	(	uint32	id,
		uint32 &	from,
		uint32 &	to,
		uint32 &	remoteID )

Definition at line 1167 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntry().

◆ getRequestStatus()

bool cmlabs::DataMapsMemory::getRequestStatus	(	uint32	id,
		uint8 &	status,
		uint64 &	time,
		uint64 &	msgID,
		uint64 &	msgEOL )

Definition at line 1185 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntry().

◆ getTagCreateTime()

uint64 cmlabs::DataMapsMemory::getTagCreateTime ( uint32 id )

Definition at line 895 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryTime().

◆ getTagID()

bool cmlabs::DataMapsMemory::getTagID	(	const char *	name,
		uint32 &	id )

Definition at line 838 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

Referenced by cmlabs::ComponentMemory::UnitTest().

◆ getTagName()

bool cmlabs::DataMapsMemory::getTagName	(	uint32	id,
		char *	name,
		uint32	maxSize )

Definition at line 823 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryName().

Referenced by cmlabs::ComponentMemory::UnitTest().

◆ getTypeLevelCreateTime()

uint64 cmlabs::DataMapsMemory::getTypeLevelCreateTime ( uint16 id )

Definition at line 605 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryTime().

◆ getTypeLevelID()

bool cmlabs::DataMapsMemory::getTypeLevelID	(	const char *	name,
		uint16 &	id )

Definition at line 548 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryID().

Referenced by cmlabs::ComponentMemory::UnitTest().

◆ getTypeLevelName()

bool cmlabs::DataMapsMemory::getTypeLevelName	(	uint16	id,
		char *	name,
		uint32	maxSize )

Definition at line 533 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::GetEntryName().

Referenced by cmlabs::ComponentMemory::UnitTest().

◆ lookupContextLevelID()

uint8 cmlabs::DataMapsMemory::lookupContextLevelID	(	const char *	name,
		uint16 &	id )

Definition at line 709 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::LookupEntryID().

◆ lookupCrankID()

uint8 cmlabs::DataMapsMemory::lookupCrankID	(	const char *	name,
		uint16 &	id )

Definition at line 1063 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::LookupEntryID().

◆ lookupTagID()

uint8 cmlabs::DataMapsMemory::lookupTagID	(	const char *	name,
		uint32 &	id )

Definition at line 854 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::LookupEntryID().

◆ lookupTypeLevelID()

uint8 cmlabs::DataMapsMemory::lookupTypeLevelID	(	const char *	name,
		uint16 &	id )

Definition at line 564 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::LookupEntryID().

◆ maintenance()

bool cmlabs::DataMapsMemory::maintenance ( )

Periodic cleanup (e.g.

stale requests).

Returns: true on success.

Definition at line 113 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL.

Referenced by createNewRequest().

◆ open()

bool cmlabs::DataMapsMemory::open ( )

Attach to the existing data-maps segment.

Returns: true on success.

Definition at line 67 of file DataMapsMemory.cpp.

References cmlabs::DataMapsMemoryStruct::cid, cmlabs::utils::CloseSharedMemorySegment(), DATAMAPSMEMORYID, LOG_MEMORY, LogPrint, cmlabs::utils::OpenSharedMemorySegment(), and cmlabs::utils::StringFormat().

◆ printAllContexts()

std::string cmlabs::DataMapsMemory::printAllContexts ( )

Definition at line 758 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::PrintAllEntries().

◆ printAllTypes()

std::string cmlabs::DataMapsMemory::printAllTypes ( )

Definition at line 614 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::PrintAllEntries().

◆ printFriendlyHTML()

std::string cmlabs::DataMapsMemory::printFriendlyHTML ( )

Returns: HTML dump of all maps for monitoring UIs.

Definition at line 1312 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::PrintAllEntriesHTML().

◆ setRequestStatus() [1/2]

bool cmlabs::DataMapsMemory::setRequestStatus	(	uint32	id,
		uint8	status )

Definition at line 1204 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), cmlabs::GetTimeNow(), and cmlabs::utils::SignalSemaphore().

◆ setRequestStatus() [2/2]

bool cmlabs::DataMapsMemory::setRequestStatus	(	uint32	id,
		uint8	status,
		uint64	msgID,
		uint64	msgEOL )

Definition at line 1222 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), cmlabs::GetTimeNow(), LOG_MEMORY, LogPrint, cmlabs::PrintTimeString(), and cmlabs::utils::SignalSemaphore().

◆ syncContextLevels()

bool cmlabs::DataMapsMemory::syncContextLevels ( DataMessage * msg )

Definition at line 423 of file DataMapsMemory.cpp.

References confirmContextLevelID(), createNewContextLevel(), cmlabs::DataMessage::getInt(), cmlabs::DataMessage::getString(), and cmlabs::DataMessage::getTime().

◆ syncCranks()

bool cmlabs::DataMapsMemory::syncCranks ( DataMessage * msg )

Definition at line 471 of file DataMapsMemory.cpp.

References confirmCrankID(), createNewCrank(), cmlabs::DataMessage::getInt(), cmlabs::DataMessage::getString(), and cmlabs::DataMessage::getTime().

◆ syncTags()

bool cmlabs::DataMapsMemory::syncTags ( DataMessage * msg )

Definition at line 447 of file DataMapsMemory.cpp.

References confirmTagID(), createNewTag(), cmlabs::DataMessage::getInt(), cmlabs::DataMessage::getString(), and cmlabs::DataMessage::getTime().

◆ syncTypeLevels()

bool cmlabs::DataMapsMemory::syncTypeLevels ( DataMessage * msg )

Definition at line 399 of file DataMapsMemory.cpp.

References confirmTypeLevelID(), createNewTypeLevel(), cmlabs::DataMessage::getInt(), cmlabs::DataMessage::getString(), and cmlabs::DataMessage::getTime().

◆ toXML()

std::string cmlabs::DataMapsMemory::toXML ( )

Returns: XML dump of all maps.

Definition at line 1331 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::utils::StringFormat(), and cmlabs::GenericMemoryMap< T, ID >::ToXML().

◆ waitForRequestReply()

bool cmlabs::DataMapsMemory::waitForRequestReply	(	uint32	id,
		uint32	timeout,
		uint8 &	status,
		uint64 &	time,
		uint64 &	msgID,
		uint64 &	msgEOL )

Definition at line 1244 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, cmlabs::GenericMemoryMap< T, ID >::GetEntry(), cmlabs::GetTimeAgeMS(), cmlabs::GetTimeNow(), LOG_MEMORY, LogPrint, cmlabs::PrintTimeString(), REQ_REPLY_READY, and cmlabs::utils::WaitForSemaphore().

◆ writeContextLevelsToMsg()

bool cmlabs::DataMapsMemory::writeContextLevelsToMsg ( DataMessage * msg )

Definition at line 414 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::WriteAllEntriesToMsg().

◆ writeCranksToMsg()

bool cmlabs::DataMapsMemory::writeCranksToMsg ( DataMessage * msg )

Definition at line 462 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::WriteAllEntriesToMsg().

◆ writeIDsToMsg()

bool cmlabs::DataMapsMemory::writeIDsToMsg ( DataMessage * msg )

Write all map names/ids into msg for cluster sync.

Returns: true on success.

Definition at line 375 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::WriteAllIDsToMsg().

◆ writeTagsToMsg()

bool cmlabs::DataMapsMemory::writeTagsToMsg ( DataMessage * msg )

Definition at line 438 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::WriteAllEntriesToMsg().

◆ writeTypeLevelsToMsg()

bool cmlabs::DataMapsMemory::writeTypeLevelsToMsg ( DataMessage * msg )

Definition at line 390 of file DataMapsMemory.cpp.

References CHECKDATAMAPSMEMORYSERIAL, and cmlabs::GenericMemoryMap< T, ID >::WriteAllEntriesToMsg().

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

/home/ubuntu/c/partner/psyclone2/CMSDK/include/DataMapsMemory.h
/home/ubuntu/c/partner/psyclone2/CMSDK/src/DataMapsMemory.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DataMapsMemory()

◆ ~DataMapsMemory()

Member Function Documentation

◆ cancelContextLevelID()

◆ cancelCrankID()

◆ cancelTagID()

◆ cancelTypeLevelID()

◆ confirmContextLevelID()

◆ confirmCrankID()

◆ confirmTagID()

◆ confirmTypeLevelID()

◆ create()

◆ createNewContextLevel()

◆ createNewCrank()

◆ createNewRequest()

◆ createNewTag()

◆ createNewTypeLevel()

◆ deleteContextLevel() [1/2]

◆ deleteContextLevel() [2/2]

◆ deleteCrank() [1/2]

◆ deleteCrank() [2/2]

◆ deleteRequest()

◆ deleteTag() [1/2]

◆ deleteTag() [2/2]

◆ deleteTypeLevel() [1/2]

◆ deleteTypeLevel() [2/2]

◆ getContextLevelCreateTime()

◆ getContextLevelID()

◆ getContextLevelName()

◆ getCrankCompID()

◆ getCrankCreateTime()

◆ getCrankFunction()

◆ getCrankID()

◆ getCrankLanguage()

◆ getCrankLibraryFilename()

◆ getCrankName()

◆ getCrankScript()

◆ getMemoryUsage()

◆ getRequestCount()

◆ getRequestInfo()

◆ getRequestStatus()

◆ getTagCreateTime()

◆ getTagID()

◆ getTagName()

◆ getTypeLevelCreateTime()

◆ getTypeLevelID()

◆ getTypeLevelName()

◆ lookupContextLevelID()

◆ lookupCrankID()

◆ lookupTagID()

◆ lookupTypeLevelID()

◆ maintenance()

◆ open()

◆ printAllContexts()

◆ printAllTypes()

◆ printFriendlyHTML()

◆ setRequestStatus() [1/2]

◆ setRequestStatus() [2/2]

◆ syncContextLevels()

◆ syncCranks()

◆ syncTags()

◆ syncTypeLevels()

◆ toXML()

◆ waitForRequestReply()

◆ writeContextLevelsToMsg()

◆ writeCranksToMsg()

◆ writeIDsToMsg()

◆ writeTagsToMsg()

◆ writeTypeLevelsToMsg()