iox::roudi::MemoryBlock🔗

The MemoryBlock is a container for general purpose memory. It is used to request some memory from a MemoryProvider, which can be POSIX SHM, the stack or something completely different. To be able to use the container, some functions need to be implemented. For most use cases the GenericMemoryBlock can be used, which is a templated class and implements the most common case. #include <iceoryx_posh/roudi/memory/memory_block.hpp>

Inherited by iox::roudi::GenericMemoryBlock< T >

Public Functions🔗

	Name
	MemoryBlock() =default
virtual	~MemoryBlock() =default
	MemoryBlock(const MemoryBlock & )
	MemoryBlock(MemoryBlock && )
MemoryBlock &	operator=(const MemoryBlock & )
MemoryBlock &	operator=(MemoryBlock && )
virtual uint64_t	size() const =0 This function provides the size of the required memory for the underlying data. It is needed for the MemoryProvider to calculate the total size of memory.
virtual uint64_t	alignment() const =0 This function provides the alignment of the memory for the underlying data. This information is needed for the MemoryProvider.
cxx::optional< void * >	memory() const This function provides the pointer to the requested memory.

Protected Functions🔗

	Name
virtual void	destroy() =0 The MemoryProvider calls this either when MemoryProvider::destroy is called or in its destructor.
virtual void	onMemoryAvailable(cxx::not_null< void * > memory) This function is called once the memory is available and is therefore the earliest possibility to use the memory.

Friends🔗

	Name
class	MemoryProvider

Public Functions Documentation🔗

function MemoryBlock🔗

MemoryBlock() =default

function ~MemoryBlock🔗

virtual ~MemoryBlock() =default

function MemoryBlock🔗

MemoryBlock(
    const MemoryBlock & 
)

Note: this is intentional not movable/copyable, since a pointer to the memory block is registered at a MemoryProvider and therefore an instance of a MemoryBlock must be pinned to memory

function MemoryBlock🔗

MemoryBlock(
    MemoryBlock && 
)

function operator=🔗

MemoryBlock & operator=(
    const MemoryBlock & 
)

function operator=🔗

MemoryBlock & operator=(
    MemoryBlock && 
)

function size🔗

virtual uint64_t size() const =0

This function provides the size of the required memory for the underlying data. It is needed for the MemoryProvider to calculate the total size of memory.

Return: the required memory as multiple of the alignment

Reimplemented by: iox::roudi::GenericMemoryBlock::size

function alignment🔗

virtual uint64_t alignment() const =0

This function provides the alignment of the memory for the underlying data. This information is needed for the MemoryProvider.

Return: the alignment of the underlying data.

Reimplemented by: iox::roudi::GenericMemoryBlock::alignment

function memory🔗

cxx::optional< void * > memory() const

This function provides the pointer to the requested memory.

Return: an optional pointer to a memory block with the requested size and alignment if the memory is available, otherwise a cxx::nullopt_t

Protected Functions Documentation🔗

function destroy🔗

virtual void destroy() =0

The MemoryProvider calls this either when MemoryProvider::destroy is called or in its destructor.

Note: This function can be called multiple times. Make sure that the implementation can handle this.

Reimplemented by: iox::roudi::GenericMemoryBlock::destroy

function onMemoryAvailable🔗

virtual void onMemoryAvailable(
    cxx::not_null< void * > memory
)

This function is called once the memory is available and is therefore the earliest possibility to use the memory.

Parameters:

memory pointer to a valid memory block, the same one that the memory() member function would return

Friends🔗

friend MemoryProvider🔗

friend class MemoryProvider(
    MemoryProvider 
);

Updated on 31 May 2022 at 11:34:55 CEST