iceoryx_doc  1.0.1
Public Member Functions | List of all members
iox::roudi::PortPoolMemoryBlock Class Reference
Inheritance diagram for iox::roudi::PortPoolMemoryBlock:
Inheritance graph
[legend]
Collaboration diagram for iox::roudi::PortPoolMemoryBlock:
Collaboration graph
[legend]

Public Member Functions

 PortPoolMemoryBlock () noexcept=default
 
 PortPoolMemoryBlock (const PortPoolMemoryBlock &)=delete
 
 PortPoolMemoryBlock (PortPoolMemoryBlock &&)=delete
 
PortPoolMemoryBlockoperator= (const PortPoolMemoryBlock &)=delete
 
PortPoolMemoryBlockoperator= (PortPoolMemoryBlock &&)=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 ports. More...
 
void destroy () noexcept override
 Implementation of MemoryBlock::destroy This will clean up the ports.
 
cxx::optional< PortPoolData * > portPool () const noexcept
 This function enables the access to the PortPool. More...
 
- Public Member Functions inherited from iox::roudi::MemoryBlock
 MemoryBlock (const MemoryBlock &)=delete
 
 MemoryBlock (MemoryBlock &&)=delete
 
MemoryBlockoperator= (const MemoryBlock &)=delete
 
MemoryBlockoperator= (MemoryBlock &&)=delete
 
cxx::optional< void * > memory () const noexcept
 This function provides the pointer to the requested memory. More...
 

Constructor & Destructor Documentation

◆ PortPoolMemoryBlock()

iox::roudi::PortPoolMemoryBlock::PortPoolMemoryBlock ( )
defaultnoexcept
Todo:
the PortPool needs to be refactored to use a typed MemPool once that is done, the cTor needs a configuration similar to MemPoolCollectionMemoryProvider

Member Function Documentation

◆ alignment()

uint64_t iox::roudi::PortPoolMemoryBlock::alignment ( ) const
overridevirtualnoexcept

Implementation of MemoryBlock::alignment.

Returns
the memory alignment for the ports

Implements iox::roudi::MemoryBlock.

◆ memoryAvailable()

void iox::roudi::PortPoolMemoryBlock::memoryAvailable ( void *  memory)
overridevirtualnoexcept

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

Parameters
[in]memorypointer to a valid memory location to place the mempools

Reimplemented from iox::roudi::MemoryBlock.

◆ portPool()

cxx::optional<PortPoolData*> iox::roudi::PortPoolMemoryBlock::portPool ( ) const
noexcept

This function enables the access to the PortPool.

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

◆ size()

uint64_t iox::roudi::PortPoolMemoryBlock::size ( ) const
overridevirtualnoexcept

Implementation of MemoryBlock::size.

Returns
the size of for all the ports

Implements iox::roudi::MemoryBlock.


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