Class SharedMemoryBuilder

• Defined in File shared_memory.hpp

Class Documentation

class SharedMemoryBuilder

Public Functions

cxx::expected<SharedMemory, SharedMemoryError> create() noexcept

A valid file name for the shared memory with the restriction that no leading dot is allowed since it is not compatible with every file system.

Defines if the memory should be mapped read only or with write access. A read only memory section will cause a segmentation fault when written to.

Defines how the shared memory is acquired

Defines the access permissions of the shared memory

Defines the size of the shared memory

creates a valid SharedMemory object. If the construction failed the expected contains an enum value describing the error.

Returns:

expected containing SharedMemory on success otherwise SharedMemoryError