Skip to content

iox::roudi::RouDiMemoryManager🔗

Public Functions🔗

Name
RouDiMemoryManager() =default
virtual ~RouDiMemoryManager()
The Destructor of the RouDiMemoryManager also calls destroy on the registered MemoryProvider.
RouDiMemoryManager(RouDiMemoryManager && )
RouDiMemoryManager & operator=(RouDiMemoryManager && )
RouDiMemoryManager(const RouDiMemoryManager & )
RouDiMemoryManager & operator=(const RouDiMemoryManager & )
cxx::expected< RouDiMemoryManagerError > addMemoryProvider(MemoryProvider * memoryProvider)
This function add a MemoryProvider to the memory manager.
cxx::expected< RouDiMemoryManagerError > createAndAnnounceMemory()
The RouDiMemoryManager calls the the MemoryProvider to create the memory and announce the availability to its MemoryBlocks.
cxx::expected< RouDiMemoryManagerError > destroyMemory()
The RouDiMemoryManager calls the the MemoryProvider to destroy the memory, which in turn prompts the MemoryBlocks to destroy their data.

Public Functions Documentation🔗

function RouDiMemoryManager🔗

RouDiMemoryManager() =default

function ~RouDiMemoryManager🔗

virtual ~RouDiMemoryManager()

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

function RouDiMemoryManager🔗

RouDiMemoryManager(
    RouDiMemoryManager && 
)

function operator=🔗

RouDiMemoryManager & operator=(
    RouDiMemoryManager && 
)

function RouDiMemoryManager🔗

RouDiMemoryManager(
    const RouDiMemoryManager & 
)

function operator=🔗

RouDiMemoryManager & operator=(
    const RouDiMemoryManager & 
)

function addMemoryProvider🔗

cxx::expected< RouDiMemoryManagerError > addMemoryProvider(
    MemoryProvider * memoryProvider
)

This function add a MemoryProvider to the memory manager.

Parameters:

Return: an RouDiMemoryManagerError::MEMORY_PROVIDER_EXHAUSTED error if no further memory provider can be added, otherwise success

function createAndAnnounceMemory🔗

cxx::expected< RouDiMemoryManagerError > createAndAnnounceMemory()

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

function destroyMemory🔗

cxx::expected< RouDiMemoryManagerError > destroyMemory()

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

Updated on 31 May 2022 at 11:34:55 CEST