CMSDK 2.0.1
Cross-platform C++ base library and SDK for the Psyclone AIOS platform
Loading...
Searching...
No Matches
cmlabs::MemoryController Class Referenceabstract

Pure-virtual interface for shared-segment bookkeeping (implemented by MasterMemory). More...

#include <MemoryController.h>

Inheritance diagram for cmlabs::MemoryController:
[legend]

Public Member Functions

 MemoryController ()
virtual ~MemoryController ()
virtual bool setID (uint16 id)=0
 Set the node id.
virtual uint16 getID ()=0
virtual bool setDynamicShmemSize (uint64 memorySize)=0
 Record the dynamic segment's new byte size.
virtual uint64 getDynamicShmemSize ()=0
virtual uint32 getDynamicShmemSerial ()=0
virtual uint32 incrementDynamicShmemSerial ()=0
 Bump the serial after re-creating the segment.

Detailed Description

Pure-virtual interface for shared-segment bookkeeping (implemented by MasterMemory).

Thread-safety is the implementer's responsibility; MasterMemory serializes access with a named cross-process mutex.

Definition at line 22 of file MemoryController.h.

Constructor & Destructor Documentation

◆ MemoryController()

cmlabs::MemoryController::MemoryController ( )

Definition at line 9 of file MemoryController.cpp.

◆ ~MemoryController()

cmlabs::MemoryController::~MemoryController ( )
virtual

Definition at line 10 of file MemoryController.cpp.

Member Function Documentation

◆ getDynamicShmemSerial()

virtual uint32 cmlabs::MemoryController::getDynamicShmemSerial ( )
pure virtual
Returns
Current resize serial of the dynamic segment.

Implemented in cmlabs::MasterMemory.

◆ getDynamicShmemSize()

virtual uint64 cmlabs::MemoryController::getDynamicShmemSize ( )
pure virtual
Returns
The dynamic segment's current byte size.

Implemented in cmlabs::MasterMemory.

◆ getID()

virtual uint16 cmlabs::MemoryController::getID ( )
pure virtual
Returns
The node id.

Implemented in cmlabs::MasterMemory.

◆ incrementDynamicShmemSerial()

virtual uint32 cmlabs::MemoryController::incrementDynamicShmemSerial ( )
pure virtual

Bump the serial after re-creating the segment.

Returns
New serial.

Implemented in cmlabs::MasterMemory.

◆ setDynamicShmemSize()

virtual bool cmlabs::MemoryController::setDynamicShmemSize ( uint64 memorySize)
pure virtual

Record the dynamic segment's new byte size.

Returns
true on success.

Implemented in cmlabs::MasterMemory.

◆ setID()

virtual bool cmlabs::MemoryController::setID ( uint16 id)
pure virtual

Set the node id.

Parameters
idNew id.
Returns
true on success.

Implemented in cmlabs::MasterMemory.


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