iox::roudi::PortPoolMemoryBlock🔗

Public Functions🔗

	Name
	PortPoolMemoryBlock() =default
	~PortPoolMemoryBlock()
	PortPoolMemoryBlock(const PortPoolMemoryBlock & )
	PortPoolMemoryBlock(PortPoolMemoryBlock && )
PortPoolMemoryBlock &	operator=(const PortPoolMemoryBlock & )
PortPoolMemoryBlock &	operator=(PortPoolMemoryBlock && )
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 ports.
virtual void	destroy() override Implementation of MemoryBlock::destroy This will clean up the ports.
cxx::optional< PortPoolData * >	portPool() const This function enables the access to the PortPool.

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 PortPoolMemoryBlock🔗

PortPoolMemoryBlock() =default

Todo: the PortPool needs to be refactored to use a typed MemPool once that is done, the cTor needs a configuration similar to MemPoolCollectionMemoryProvider

function ~PortPoolMemoryBlock🔗

~PortPoolMemoryBlock()

function PortPoolMemoryBlock🔗

PortPoolMemoryBlock(
    const PortPoolMemoryBlock & 
)

function PortPoolMemoryBlock🔗

PortPoolMemoryBlock(
    PortPoolMemoryBlock && 
)

function operator=🔗

PortPoolMemoryBlock & operator=(
    const PortPoolMemoryBlock & 
)

function operator=🔗

PortPoolMemoryBlock & operator=(
    PortPoolMemoryBlock && 
)

function size🔗

virtual uint64_t size() const override

Implementation of MemoryBlock::size.

Return: the size of for all the ports

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

function alignment🔗

virtual uint64_t alignment() const override

Implementation of MemoryBlock::alignment.

Return: the memory alignment for the ports

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

function memoryAvailable🔗

virtual void memoryAvailable(
    void * memory
) override

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

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 ports.

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

function portPool🔗

cxx::optional< PortPoolData * > portPool() const

This function enables the access to the PortPool.

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