iceoryx_posh 2.0.3
Public Member Functions | List of all members
iox::roudi::RouDiMemoryManager Class Reference

Public Member Functions

virtual ~RouDiMemoryManager () noexcept
 The Destructor of the RouDiMemoryManager also calls destroy on the registered MemoryProvider.
 
 RouDiMemoryManager (RouDiMemoryManager &&)=delete
 
RouDiMemoryManageroperator= (RouDiMemoryManager &&)=delete
 
 RouDiMemoryManager (const RouDiMemoryManager &)=delete
 
RouDiMemoryManageroperator= (const RouDiMemoryManager &)=delete
 
cxx::expected< RouDiMemoryManagerErroraddMemoryProvider (MemoryProvider *memoryProvider) noexcept
 This function add a MemoryProvider to the memory manager. More...
 
cxx::expected< RouDiMemoryManagerErrorcreateAndAnnounceMemory () noexcept
 The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks. More...
 
cxx::expected< RouDiMemoryManagerErrordestroyMemory () noexcept
 The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data.
 

Member Function Documentation

◆ addMemoryProvider()

cxx::expected< RouDiMemoryManagerError > iox::roudi::RouDiMemoryManager::addMemoryProvider ( MemoryProvider memoryProvider)
noexcept

This function add a MemoryProvider to the memory manager.

Parameters
[in]memoryProvideris a pointer to a user defined MemoryProvider
Returns
an RouDiMemoryManagerError::MEMORY_PROVIDER_EXHAUSTED error if no further memory provider can be added, otherwise success

◆ createAndAnnounceMemory()

cxx::expected< RouDiMemoryManagerError > iox::roudi::RouDiMemoryManager::createAndAnnounceMemory ( )
noexcept

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

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