iox::roudi::PosixShmMemoryProvider🔗

Creates the shared memory based on a provided configuration. #include <iceoryx_posh/roudi/memory/posix_shm_memory_provider.hpp>

Inherits from iox::roudi::MemoryProvider

Public Functions🔗

	Name
	PosixShmMemoryProvider(const ShmName_t & shmName, const posix::AccessMode accessMode, const posix::OpenMode openMode) Constructs a PosixShmMemoryProvider which can be used to request memory via MemoryBlocks.
	~PosixShmMemoryProvider()
	PosixShmMemoryProvider(PosixShmMemoryProvider && )
PosixShmMemoryProvider &	operator=(PosixShmMemoryProvider && )
	PosixShmMemoryProvider(const PosixShmMemoryProvider & )
PosixShmMemoryProvider &	operator=(const PosixShmMemoryProvider & )

Protected Functions🔗

	Name
virtual cxx::expected< void *, MemoryProviderError >	createMemory(const uint64_t size, const uint64_t alignment) This function needs to be implemented to provide the actual memory, e.g. in case of POSIX SHM, shm_open and mmap would need to be called in the implementation of this function.
virtual cxx::expected< MemoryProviderError >	destroyMemory() This function needs to be implemented to free the actual memory, e.g. in case of POSIX SHM, shm_unlink and munmap would need to be called in the implementation of this function.

Additional inherited members🔗

Public Functions inherited from iox::roudi::MemoryProvider

	Name
	MemoryProvider() =default
virtual	~MemoryProvider()
	MemoryProvider(const MemoryProvider & )
	MemoryProvider(MemoryProvider && )
cxx::expected< MemoryProviderError >	addMemoryBlock(cxx::not_null< MemoryBlock * > memoryBlock) This function add a MemoryBlock to the list of memory requester.
cxx::expected< MemoryProviderError >	create() With this call the memory requested by the MemoryBlocks need to be created. The function should be called from a MemoryManager which handles one or more MemoryProvider.
void	announceMemoryAvailable() This function announces the availability of the memory to the MemoryBlocks. The function should be called from a MemoryManager which handles one or more MemoryProvider.
cxx::expected< MemoryProviderError >	destroy() This function destroys the previously allocated memory. Before the destruction, all MemoryBlocks are requested to handle this appropriately, e.g. call the destructor of the underlying type. The function should be called from a MemoryManager which handles one or more MemoryProvider.
cxx::optional< void * >	baseAddress() const This function provides the base address of the created memory.
uint64_t	size() const This function provides the size of the created memory.
cxx::optional< uint64_t >	segmentId() const This function provides the segment id of the relocatable memory segment which is owned by the MemoryProvider.
bool	isAvailable() const This function can be used to check if the requested memory is already available.
bool	isAvailableAnnounced() const This function can be used to check if the availability of the memory was announced to the MemoryBlocks.

Protected Functions inherited from iox::roudi::MemoryProvider

	Name
const char *	getErrorString(const MemoryProviderError error)

Friends inherited from iox::roudi::MemoryProvider

	Name
class	RouDiMemoryManager

Public Functions Documentation🔗

function PosixShmMemoryProvider🔗

PosixShmMemoryProvider(
    const ShmName_t & shmName,
    const posix::AccessMode accessMode,
    const posix::OpenMode openMode
)

Constructs a PosixShmMemoryProvider which can be used to request memory via MemoryBlocks.

Parameters:

shmName is the name of the posix share memory
accessMode defines the read and write access to the memory
openMode defines the creation/open mode of the shared memory.

function ~PosixShmMemoryProvider🔗

~PosixShmMemoryProvider()

function PosixShmMemoryProvider🔗

PosixShmMemoryProvider(
    PosixShmMemoryProvider && 
)

function operator=🔗

PosixShmMemoryProvider & operator=(
    PosixShmMemoryProvider && 
)

function PosixShmMemoryProvider🔗

PosixShmMemoryProvider(
    const PosixShmMemoryProvider & 
)

function operator=🔗

PosixShmMemoryProvider & operator=(
    const PosixShmMemoryProvider & 
)

Protected Functions Documentation🔗

function createMemory🔗

virtual cxx::expected< void *, MemoryProviderError > createMemory(
    const uint64_t size,
    const uint64_t alignment
)

This function needs to be implemented to provide the actual memory, e.g. in case of POSIX SHM, shm_open and mmap would need to be called in the implementation of this function.

Parameters:

size is the size in bytes for the requested memory, the size should already be calculated according to the alignment requirements
alignment the required alignment for the memory

Return: the pointer of the begin of the created memory or a MemoryProviderError if the memory could not be created

Note: This creates and maps a POSIX shared memory to the address space of the application

Reimplements: iox::roudi::MemoryProvider::createMemory

function destroyMemory🔗

virtual cxx::expected< MemoryProviderError > destroyMemory()

This function needs to be implemented to free the actual memory, e.g. in case of POSIX SHM, shm_unlink and munmap would need to be called in the implementation of this function.

Return: a MemoryProviderError if the destruction failed, otherwise success

Note: This closes and unmaps a POSIX shared memory

Reimplements: iox::roudi::MemoryProvider::destroyMemory

Updated on 18 December 2023 at 13:02:35 CET