iceoryx_doc  1.0.1
Public Member Functions | Static Public Attributes | Friends | List of all members
iox::posix::SharedMemoryObject Class Reference
Inheritance diagram for iox::posix::SharedMemoryObject:
Inheritance graph
[legend]
Collaboration diagram for iox::posix::SharedMemoryObject:
Collaboration graph
[legend]

Public Member Functions

 SharedMemoryObject (const SharedMemoryObject &)=delete
 
SharedMemoryObjectoperator= (const SharedMemoryObject &)=delete
 
 SharedMemoryObject (SharedMemoryObject &&)=default
 
SharedMemoryObjectoperator= (SharedMemoryObject &&)=default
 
void * allocate (const uint64_t size, const uint64_t alignment)
 
void finalizeAllocation ()
 
AllocatorgetAllocator ()
 
void * getBaseAddress () const
 
uint64_t getSizeInBytes () const
 
int getFileHandle () const
 
- Public Member Functions inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >
 Creation (Creation &&rhs) noexcept
 
 Creation (const Creation &rhs) noexcept=default
 
Creationoperator= (Creation &&rhs) noexcept
 
Creationoperator= (const Creation &rhs) noexcept=default
 
bool isInitialized () const noexcept
 returns true if the object was constructed successfully, otherwise false
 

Static Public Attributes

static constexpr void * NO_ADDRESS_HINT = nullptr
 

Friends

class DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >
 

Additional Inherited Members

- Public Types inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >
using CreationPattern_t = Creation< SharedMemoryObject, SharedMemoryObjectError >
 
using result_t = iox::cxx::expected< SharedMemoryObject, SharedMemoryObjectError >
 
using errorType_t = SharedMemoryObjectError
 
- Static Public Member Functions inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >
static result_t create (Targs &&... args) noexcept
 factory method which guarantees that either a working object is produced or an error value describing the error during construction More...
 
static result_t verify (SharedMemoryObject &&newObject) noexcept
 verifies if a class was created successfully More...
 
static iox::cxx::expected< SharedMemoryObjectError > placementCreate (void *const memory, Targs &&... args) noexcept
 factory method which guarantees that either a working object is produced or an error value describing the error during construction More...
 
- Protected Attributes inherited from DesignPattern::Creation< SharedMemoryObject, SharedMemoryObjectError >
bool m_isInitialized
 
SharedMemoryObjectError m_errorValue
 

The documentation for this class was generated from the following file: