iox::roudi::IceOryxRouDiMemoryManager

Inherits from iox::roudi::RouDiMemoryInterface

Public Functions

	Name
	IceOryxRouDiMemoryManager(const RouDiConfig_t & roudiConfig)
virtual	~IceOryxRouDiMemoryManager() =default The Destructor of the IceOryxRouDiMemoryManager also calls destroy on the registered MemoryProvider.
	IceOryxRouDiMemoryManager(IceOryxRouDiMemoryManager && )
IceOryxRouDiMemoryManager &	operator=(IceOryxRouDiMemoryManager && )
	IceOryxRouDiMemoryManager(const IceOryxRouDiMemoryManager & )
IceOryxRouDiMemoryManager &	operator=(const IceOryxRouDiMemoryManager & )
virtual cxx::expected< RouDiMemoryManagerError >	createAndAnnounceMemory() override The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks.
virtual cxx::expected< RouDiMemoryManagerError >	destroyMemory() override The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data.
virtual const PosixShmMemoryProvider *	mgmtMemoryProvider() const override
virtual cxx::optional< PortPool * >	portPool() override
virtual cxx::optional< mepoo::MemoryManager * >	introspectionMemoryManager() const override
virtual cxx::optional< mepoo::SegmentManager<> * >	segmentManager() const override

Additional inherited members

Public Functions inherited from iox::roudi::RouDiMemoryInterface

	Name
	RouDiMemoryInterface() =default
virtual	~RouDiMemoryInterface() =default The Destructor of the RouDiMemoryInterface also calls destroy on the registered MemoryProvider.
	RouDiMemoryInterface(RouDiMemoryInterface && )
	RouDiMemoryInterface(const RouDiMemoryInterface & )

Public Functions Documentation

function IceOryxRouDiMemoryManager

IceOryxRouDiMemoryManager(
    const RouDiConfig_t & roudiConfig
)

function ~IceOryxRouDiMemoryManager

virtual ~IceOryxRouDiMemoryManager() =default

The Destructor of the IceOryxRouDiMemoryManager also calls destroy on the registered MemoryProvider.

function IceOryxRouDiMemoryManager

IceOryxRouDiMemoryManager(
    IceOryxRouDiMemoryManager && 
)

function operator=

IceOryxRouDiMemoryManager & operator=(
    IceOryxRouDiMemoryManager && 
)

function IceOryxRouDiMemoryManager

IceOryxRouDiMemoryManager(
    const IceOryxRouDiMemoryManager & 
)

function operator=

IceOryxRouDiMemoryManager & operator=(
    const IceOryxRouDiMemoryManager & 
)

function createAndAnnounceMemory

virtual cxx::expected< RouDiMemoryManagerError > createAndAnnounceMemory() override

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

Return: an RouDiMemoryManagerError if the MemoryProvider cannot create the memory, otherwise success

Reimplements: iox::roudi::RouDiMemoryInterface::createAndAnnounceMemory

function destroyMemory

virtual cxx::expected< RouDiMemoryManagerError > destroyMemory() override

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

Reimplements: iox::roudi::RouDiMemoryInterface::destroyMemory

function mgmtMemoryProvider

virtual const PosixShmMemoryProvider * mgmtMemoryProvider() const override

Reimplements: iox::roudi::RouDiMemoryInterface::mgmtMemoryProvider

function portPool

virtual cxx::optional< PortPool * > portPool() override

Reimplements: iox::roudi::RouDiMemoryInterface::portPool

function introspectionMemoryManager

virtual cxx::optional< mepoo::MemoryManager * > introspectionMemoryManager() const override

Reimplements: iox::roudi::RouDiMemoryInterface::introspectionMemoryManager

function segmentManager

virtual cxx::optional< mepoo::SegmentManager<> * > segmentManager() const override

Reimplements: iox::roudi::RouDiMemoryInterface::segmentManager

---

Updated on 2 April 2022 at 16:37:47 CEST