iceoryx_posh 2.0.3
Public Member Functions | List of all members
iox::roudi::IceOryxRouDiMemoryManager Class Reference
Inheritance diagram for iox::roudi::IceOryxRouDiMemoryManager:
Inheritance graph
[legend]
Collaboration diagram for iox::roudi::IceOryxRouDiMemoryManager:
Collaboration graph
[legend]

Public Member Functions

 IceOryxRouDiMemoryManager (const RouDiConfig_t &roudiConfig) noexcept
 
virtual ~IceOryxRouDiMemoryManager () noexcept=default
 The Destructor of the IceOryxRouDiMemoryManager also calls destroy on the registered MemoryProvider.
 
 IceOryxRouDiMemoryManager (IceOryxRouDiMemoryManager &&)=delete
 
IceOryxRouDiMemoryManageroperator= (IceOryxRouDiMemoryManager &&)=delete
 
 IceOryxRouDiMemoryManager (const IceOryxRouDiMemoryManager &)=delete
 
IceOryxRouDiMemoryManageroperator= (const IceOryxRouDiMemoryManager &)=delete
 
cxx::expected< RouDiMemoryManagerErrorcreateAndAnnounceMemory () noexcept override
 The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks. More...
 
cxx::expected< RouDiMemoryManagerErrordestroyMemory () noexcept override
 The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data. More...
 
const PosixShmMemoryProvidermgmtMemoryProvider () const noexcept override
 
cxx::optional< PortPool * > portPool () noexcept override
 
cxx::optional< mepoo::MemoryManager * > introspectionMemoryManager () const noexcept override
 
cxx::optional< mepoo::SegmentManager<> * > segmentManager () const noexcept override
 
- Public Member Functions inherited from iox::roudi::RouDiMemoryInterface
virtual ~RouDiMemoryInterface () noexcept=default
 The Destructor of the RouDiMemoryInterface also calls destroy on the registered MemoryProvider.
 
 RouDiMemoryInterface (RouDiMemoryInterface &&)=delete
 
RouDiMemoryInterfaceoperator= (RouDiMemoryInterface &&)=delete
 
 RouDiMemoryInterface (const RouDiMemoryInterface &)=delete
 
RouDiMemoryInterfaceoperator= (const RouDiMemoryInterface &)=delete
 
virtual cxx::expected< RouDiMemoryManagerErrorcreateAndAnnounceMemory () noexcept=0
 The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks. More...
 
virtual cxx::expected< RouDiMemoryManagerErrordestroyMemory () noexcept=0
 The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data. More...
 
virtual const PosixShmMemoryProvidermgmtMemoryProvider () const noexcept=0
 
virtual cxx::optional< PortPool * > portPool () noexcept=0
 
virtual cxx::optional< mepoo::MemoryManager * > introspectionMemoryManager () const noexcept=0
 
virtual cxx::optional< mepoo::SegmentManager<> * > segmentManager () const noexcept=0
 

Member Function Documentation

◆ createAndAnnounceMemory()

cxx::expected< RouDiMemoryManagerError > iox::roudi::IceOryxRouDiMemoryManager::createAndAnnounceMemory ( )
overridevirtualnoexcept

The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks.

Returns
an RouDiMemoryManagerError if the MemoryProvider cannot create the memory, otherwise success

Implements iox::roudi::RouDiMemoryInterface.

◆ destroyMemory()

cxx::expected< RouDiMemoryManagerError > iox::roudi::IceOryxRouDiMemoryManager::destroyMemory ( )
overridevirtualnoexcept

The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data.

Implements iox::roudi::RouDiMemoryInterface.

◆ introspectionMemoryManager()

cxx::optional< mepoo::MemoryManager * > iox::roudi::IceOryxRouDiMemoryManager::introspectionMemoryManager ( ) const
overridevirtualnoexcept

◆ mgmtMemoryProvider()

const PosixShmMemoryProvider * iox::roudi::IceOryxRouDiMemoryManager::mgmtMemoryProvider ( ) const
overridevirtualnoexcept

◆ portPool()

cxx::optional< PortPool * > iox::roudi::IceOryxRouDiMemoryManager::portPool ( )
overridevirtualnoexcept

◆ segmentManager()

cxx::optional< mepoo::SegmentManager<> * > iox::roudi::IceOryxRouDiMemoryManager::segmentManager ( ) const
overridevirtualnoexcept

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