iox::roudi::RouDiMemoryInterface

Inherited by iox::roudi::IceOryxRouDiMemoryManager

Public Functions

	Name
	RouDiMemoryInterface() =default
virtual	~RouDiMemoryInterface() =default The Destructor of the RouDiMemoryInterface also calls destroy on the registered MemoryProvider.
	RouDiMemoryInterface(RouDiMemoryInterface && )
RouDiMemoryInterface &	operator=(RouDiMemoryInterface && )
	RouDiMemoryInterface(const RouDiMemoryInterface & )
RouDiMemoryInterface &	operator=(const RouDiMemoryInterface & )
virtual cxx::expected< RouDiMemoryManagerError >	createAndAnnounceMemory() =0 The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks.
virtual cxx::expected< RouDiMemoryManagerError >	destroyMemory() =0 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 =0
virtual cxx::optional< PortPool * >	portPool() =0
virtual cxx::optional< mepoo::MemoryManager * >	introspectionMemoryManager() const =0
virtual cxx::optional< mepoo::SegmentManager<> * >	segmentManager() const =0

Public Functions Documentation

function RouDiMemoryInterface

RouDiMemoryInterface() =default

function ~RouDiMemoryInterface

virtual ~RouDiMemoryInterface() =default

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

function RouDiMemoryInterface

RouDiMemoryInterface(
    RouDiMemoryInterface && 
)

function operator=

RouDiMemoryInterface & operator=(
    RouDiMemoryInterface && 
)

function RouDiMemoryInterface

RouDiMemoryInterface(
    const RouDiMemoryInterface & 
)

function operator=

RouDiMemoryInterface & operator=(
    const RouDiMemoryInterface & 
)

function createAndAnnounceMemory

virtual cxx::expected< RouDiMemoryManagerError > createAndAnnounceMemory() =0

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

Reimplemented by: iox::roudi::IceOryxRouDiMemoryManager::createAndAnnounceMemory

function destroyMemory

virtual cxx::expected< RouDiMemoryManagerError > destroyMemory() =0

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

Reimplemented by: iox::roudi::IceOryxRouDiMemoryManager::destroyMemory

function mgmtMemoryProvider

virtual const PosixShmMemoryProvider * mgmtMemoryProvider() const =0

Reimplemented by: iox::roudi::IceOryxRouDiMemoryManager::mgmtMemoryProvider

function portPool

virtual cxx::optional< PortPool * > portPool() =0

Reimplemented by: iox::roudi::IceOryxRouDiMemoryManager::portPool

function introspectionMemoryManager

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

Reimplemented by: iox::roudi::IceOryxRouDiMemoryManager::introspectionMemoryManager

function segmentManager

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

Reimplemented by: iox::roudi::IceOryxRouDiMemoryManager::segmentManager

---

Updated on 31 May 2022 at 15:29:16 CEST