iox::roudi::MemPoolCollectionMemoryBlock Class Reference

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

#include <mempool_collection_memory_block.hpp>

Inheritance diagram for iox::roudi::MemPoolCollectionMemoryBlock:

Collaboration diagram for iox::roudi::MemPoolCollectionMemoryBlock:

Public Member Functions
	MemPoolCollectionMemoryBlock (const mepoo::MePooConfig &memPoolConfig) noexcept
	MemPoolCollectionMemoryBlock (const MemPoolCollectionMemoryBlock &)=delete
	MemPoolCollectionMemoryBlock (MemPoolCollectionMemoryBlock &&)=delete
MemPoolCollectionMemoryBlock &	operator= (const MemPoolCollectionMemoryBlock &)=delete
MemPoolCollectionMemoryBlock &	operator= (MemPoolCollectionMemoryBlock &&)=delete
uint64_t	size () const noexcept override
	Implementation of MemoryBlock::size. More...
uint64_t	alignment () const noexcept override
	Implementation of MemoryBlock::alignment. More...
void	memoryAvailable (void *memory) noexcept override
	Implementation of MemoryBlock::memoryAvailable This will create the MemPools. More...
void	destroy () noexcept override
	Implementation of MemoryBlock::destroy This will clean up the MemPools.
cxx::optional< mepoo::MemoryManager * >	memoryManager () const noexcept
	This function enables the access to the MemoryManager for the MemPools. More...
Public Member Functions inherited from iox::roudi::MemoryBlock
	MemoryBlock (const MemoryBlock &)=delete
	MemoryBlock (MemoryBlock &&)=delete
MemoryBlock &	operator= (const MemoryBlock &)=delete
MemoryBlock &	operator= (MemoryBlock &&)=delete
cxx::optional< void * >	memory () const noexcept
	This function provides the pointer to the requested memory. More...

Detailed Description

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

Member Function Documentation

alignment()

uint64_t iox::roudi::MemPoolCollectionMemoryBlock::alignment ( ) const

overridevirtualnoexcept

Implementation of MemoryBlock::alignment.

Returns

the alignment of type T

Implements iox::roudi::MemoryBlock.

memoryAvailable()

void iox::roudi::MemPoolCollectionMemoryBlock::memoryAvailable ( void *  memory )

overridevirtualnoexcept

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

Parameters

[in]

memory

pointer to a valid memory location to place the mempools

Reimplemented from iox::roudi::MemoryBlock.

memoryManager()

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

noexcept

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

Returns

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

size()

uint64_t iox::roudi::MemPoolCollectionMemoryBlock::size ( ) const

overridevirtualnoexcept

Implementation of MemoryBlock::size.

Returns

the size of type T

Implements iox::roudi::MemoryBlock.

---

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

• iceoryx_posh/internal/roudi/memory/mempool_collection_memory_block.hpp