iox::roudi::IceOryxRouDiMemoryManager Class Reference

Inheritance diagram for iox::roudi::IceOryxRouDiMemoryManager:

Collaboration diagram for iox::roudi::IceOryxRouDiMemoryManager:

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
IceOryxRouDiMemoryManager &	operator= (IceOryxRouDiMemoryManager &&)=delete
	IceOryxRouDiMemoryManager (const IceOryxRouDiMemoryManager &)=delete
IceOryxRouDiMemoryManager &	operator= (const IceOryxRouDiMemoryManager &)=delete
cxx::expected< RouDiMemoryManagerError >	createAndAnnounceMemory () noexcept override
	The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks.
cxx::expected< RouDiMemoryManagerError >	destroyMemory () noexcept override
	The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data.
const PosixShmMemoryProvider *	mgmtMemoryProvider () 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
RouDiMemoryInterface &	operator= (RouDiMemoryInterface &&)=delete
	RouDiMemoryInterface (const RouDiMemoryInterface &)=delete
RouDiMemoryInterface &	operator= (const RouDiMemoryInterface &)=delete

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

Implements iox::roudi::RouDiMemoryInterface.

mgmtMemoryProvider()

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

overridevirtualnoexcept

Implements iox::roudi::RouDiMemoryInterface.

portPool()

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

overridevirtualnoexcept

Implements iox::roudi::RouDiMemoryInterface.

segmentManager()

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

overridevirtualnoexcept

Implements iox::roudi::RouDiMemoryInterface.

---

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

• iceoryx_posh/roudi/memory/iceoryx_roudi_memory_manager.hpp