Skip to content

iox::posix::SharedMemoryObject🔗

Inherits from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >

Public Functions🔗

Name
SharedMemoryObject(const SharedMemoryObject & )
SharedMemoryObject & operator=(const SharedMemoryObject & )
SharedMemoryObject(SharedMemoryObject && ) =default
SharedMemoryObject & operator=(SharedMemoryObject && ) =default
~SharedMemoryObject() =default
void * allocate(const uint64_t size, const uint64_t alignment)
void finalizeAllocation()
Allocator * getAllocator()
void * getBaseAddress() const
uint64_t getSizeInBytes() const
int getFileHandle() const

Public Attributes🔗

Name
constexpr void * NO_ADDRESS_HINT

Friends🔗

Name
class DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >

Additional inherited members🔗

Public Types inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >

Name
using Creation< DerivedClass, ErrorType > CreationPattern_t
using iox::cxx::expected< DerivedClass, ErrorType > result_t
using ErrorType errorType_t

Public Functions inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >

Name
template \<typename... Targs>
result_t		 create(Targs &&... args)
factory method which guarantees that either a working object is produced or an error value describing the error during construction
result_t verify(DerivedClass && newObject)
verifies if a class was created successfully
template \<typename... Targs>
iox::cxx::expected< ErrorType >		 placementCreate(void *const memory, Targs &&... args)
factory method which guarantees that either a working object is produced or an error value describing the error during construction
Creation() =default
Creation(Creation && rhs)
Creation(const Creation & rhs) =default

Protected Attributes inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >

Name
ErrorType m_errorValue

Public Functions Documentation🔗

function SharedMemoryObject🔗

SharedMemoryObject(
    const SharedMemoryObject & 
)

function operator=🔗

SharedMemoryObject & operator=(
    const SharedMemoryObject & 
)

function SharedMemoryObject🔗

SharedMemoryObject(
    SharedMemoryObject && 
) =default

function operator=🔗

SharedMemoryObject & operator=(
    SharedMemoryObject && 
) =default

function ~SharedMemoryObject🔗

~SharedMemoryObject() =default

function allocate🔗

void * allocate(
    const uint64_t size,
    const uint64_t alignment
)

function finalizeAllocation🔗

void finalizeAllocation()

function getAllocator🔗

Allocator * getAllocator()

function getBaseAddress🔗

void * getBaseAddress() const

function getSizeInBytes🔗

uint64_t getSizeInBytes() const

function getFileHandle🔗

int getFileHandle() const

Public Attributes Documentation🔗

variable NO_ADDRESS_HINT🔗

static constexpr void * NO_ADDRESS_HINT = nullptr;

Friends🔗

friend DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >🔗

friend class DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >;

Updated on 31 May 2022 at 15:29:15 CEST