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

Public Types

using Name_t = cxx::string< NAME_SIZE >
 
- Public Types inherited from DesignPattern::Creation< SharedMemory, SharedMemoryError >
using CreationPattern_t = Creation< SharedMemory, SharedMemoryError >
 
using result_t = iox::cxx::expected< SharedMemory, SharedMemoryError >
 
using errorType_t = SharedMemoryError
 

Public Member Functions

 SharedMemory (const SharedMemory &)=delete
 
SharedMemoryoperator= (const SharedMemory &)=delete
 
 SharedMemory (SharedMemory &&) noexcept
 
SharedMemoryoperator= (SharedMemory &&) noexcept
 
int32_t getHandle () const noexcept
 
- Public Member Functions inherited from DesignPattern::Creation< SharedMemory, SharedMemoryError >
 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 uint64_t NAME_SIZE = 128U
 

Friends

class DesignPattern::Creation< SharedMemory, SharedMemoryError >
 

Additional Inherited Members

- Static Public Member Functions inherited from DesignPattern::Creation< SharedMemory, SharedMemoryError >
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 (SharedMemory &&newObject) noexcept
 verifies if a class was created successfully More...
 
static iox::cxx::expected< SharedMemoryError > 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< SharedMemory, SharedMemoryError >
bool m_isInitialized
 
SharedMemoryError m_errorValue
 

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