iox::roudi::MemPoolSegmentManagerMemoryBlock Class Reference

Inheritance diagram for iox::roudi::MemPoolSegmentManagerMemoryBlock:

Collaboration diagram for iox::roudi::MemPoolSegmentManagerMemoryBlock:

Public Member Functions
	MemPoolSegmentManagerMemoryBlock (const mepoo::SegmentConfig &segmentConfig) noexcept
	MemPoolSegmentManagerMemoryBlock (const MemPoolSegmentManagerMemoryBlock &)=delete
	MemPoolSegmentManagerMemoryBlock (MemPoolSegmentManagerMemoryBlock &&)=delete
MemPoolSegmentManagerMemoryBlock &	operator= (const MemPoolSegmentManagerMemoryBlock &)=delete
MemPoolSegmentManagerMemoryBlock &	operator= (MemPoolSegmentManagerMemoryBlock &&)=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 SegmentManager. More...
void	destroy () noexcept override
	Implementation of MemoryBlock::destroy This will clean up the SegmentManager.
cxx::optional< mepoo::SegmentManager<> * >	segmentManager () const noexcept
	This function enables the access to the SegmentManager. 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...

Member Function Documentation

alignment()

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

overridevirtualnoexcept

Implementation of MemoryBlock::alignment.

Returns

the memory alignment for SegmentManager

Implements iox::roudi::MemoryBlock.

memoryAvailable()

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

overridevirtualnoexcept

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

Parameters

[in]

memory

pointer to a valid memory location to place the mempools

Reimplemented from iox::roudi::MemoryBlock.

segmentManager()

cxx::optional<mepoo::SegmentManager<>*> iox::roudi::MemPoolSegmentManagerMemoryBlock::segmentManager ( ) const

noexcept

This function enables the access to the SegmentManager.

Returns

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

size()

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

overridevirtualnoexcept

Implementation of MemoryBlock::size.

Returns

the size of for SegmentManager

Implements iox::roudi::MemoryBlock.

---

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

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