iox::roudi::MemPoolCollectionMemoryBlock

The MemPoolCollectionMemoryBlock is an implementation of a MemoryBlock for a MemPool MemoryManager.

#include <mempool_collection_memory_block.hpp>

Inherits from iox::roudi::MemoryBlock

Public Functions

	Name
	MemPoolCollectionMemoryBlock(const mepoo::MePooConfig & memPoolConfig)
	~MemPoolCollectionMemoryBlock()
	MemPoolCollectionMemoryBlock(const MemPoolCollectionMemoryBlock & )
	MemPoolCollectionMemoryBlock(MemPoolCollectionMemoryBlock && )
MemPoolCollectionMemoryBlock &	operator=(const MemPoolCollectionMemoryBlock & )
MemPoolCollectionMemoryBlock &	operator=(MemPoolCollectionMemoryBlock && )
virtual uint64_t	size() const override Implementation of MemoryBlock::size.
virtual uint64_t	alignment() const override Implementation of MemoryBlock::alignment.
virtual void	memoryAvailable(void * memory) override Implementation of MemoryBlock::memoryAvailable This will create the MemPools.
virtual void	destroy() override Implementation of MemoryBlock::destroy This will clean up the MemPools.
cxx::optional< mepoo::MemoryManager * >	memoryManager() const This function enables the access to the MemoryManager for the MemPools.

Additional inherited members

Public Functions inherited from iox::roudi::MemoryBlock

	Name
	MemoryBlock() =default
	MemoryBlock(const MemoryBlock & )
	MemoryBlock(MemoryBlock && )
cxx::optional< void * >	memory() const This function provides the pointer to the requested memory.

Friends inherited from iox::roudi::MemoryBlock

	Name
class	MemoryProvider

Public Functions Documentation

function MemPoolCollectionMemoryBlock

MemPoolCollectionMemoryBlock(
    const mepoo::MePooConfig & memPoolConfig
)

function ~MemPoolCollectionMemoryBlock

~MemPoolCollectionMemoryBlock()

function MemPoolCollectionMemoryBlock

MemPoolCollectionMemoryBlock(
    const MemPoolCollectionMemoryBlock & 
)

function MemPoolCollectionMemoryBlock

MemPoolCollectionMemoryBlock(
    MemPoolCollectionMemoryBlock && 
)

function operator=

MemPoolCollectionMemoryBlock & operator=(
    const MemPoolCollectionMemoryBlock & 
)

function operator=

MemPoolCollectionMemoryBlock & operator=(
    MemPoolCollectionMemoryBlock && 
)

function size

virtual uint64_t size() const override

Implementation of MemoryBlock::size.

Return: the size of type T

Reimplements: iox::roudi::MemoryBlock::size

function alignment

virtual uint64_t alignment() const override

Implementation of MemoryBlock::alignment.

Return: the alignment of type T

Reimplements: iox::roudi::MemoryBlock::alignment

function memoryAvailable

virtual void memoryAvailable(
    void * memory
) override

Implementation of MemoryBlock::memoryAvailable This will create the MemPools.

Parameters:

• memory pointer to a valid memory location to place the mempools

Reimplements: iox::roudi::MemoryBlock::memoryAvailable

function destroy

virtual void destroy() override

Implementation of MemoryBlock::destroy This will clean up the MemPools.

Reimplements: iox::roudi::MemoryBlock::destroy

function memoryManager

cxx::optional< mepoo::MemoryManager * > memoryManager() const

This function enables the access to the MemoryManager for the MemPools.

Return: an optional pointer to the underlying type, cxx::nullopt_t if value is not initialized

---

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