iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
iox::mepoo::ChunkSettings Class Reference

Public Types

enum class  Error { ALIGNMENT_NOT_POWER_OF_TWO , USER_HEADER_ALIGNMENT_EXCEEDS_CHUNK_HEADER_ALIGNMENT , USER_HEADER_SIZE_NOT_MULTIPLE_OF_ITS_ALIGNMENT , REQUIRED_CHUNK_SIZE_EXCEEDS_MAX_CHUNK_SIZE }
 

Public Member Functions

uint32_t requiredChunkSize () const noexcept
 getter method for the chunk size fulfilling the user-payload and user-header requirements
 
uint32_t userPayloadSize () const noexcept
 getter method for the user-payload size
 
uint32_t userPayloadAlignment () const noexcept
 getter method for the user-payload alignment
 
uint32_t userHeaderSize () const noexcept
 getter method for the user-header size
 
uint32_t userHeaderAlignment () const noexcept
 getter method for the user-header alignment
 

Static Public Member Functions

static cxx::expected< ChunkSettings, ChunkSettings::Error > create (const uint32_t userPayloadSize, const uint32_t userPayloadAlignment=iox::CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT, const uint32_t userHeaderSize=iox::CHUNK_NO_USER_HEADER_SIZE, const uint32_t userHeaderAlignment=iox::CHUNK_NO_USER_HEADER_ALIGNMENT) noexcept
 constructs and initializes a ChunkSettings
 

Member Function Documentation

◆ create()

static cxx::expected< ChunkSettings, ChunkSettings::Error > iox::mepoo::ChunkSettings::create ( const uint32_t  userPayloadSize,
const uint32_t  userPayloadAlignment = iox::CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT,
const uint32_t  userHeaderSize = iox::CHUNK_NO_USER_HEADER_SIZE,
const uint32_t  userHeaderAlignment = iox::CHUNK_NO_USER_HEADER_ALIGNMENT 
)
staticnoexcept

constructs and initializes a ChunkSettings

Parameters
[in]chunkSizeis the size of the chunk fulfilling the user-payload and user-header requirements
[in]userPayloadSizeis the size of the user-payload
[in]userPayloadAlignmentis the alignment of the user-payload
[in]userHeaderSizeis the size of the user-header
[in]userHeaderAlignmentis the alignment for the user-header

◆ requiredChunkSize()

uint32_t iox::mepoo::ChunkSettings::requiredChunkSize ( ) const
noexcept

getter method for the chunk size fulfilling the user-payload and user-header requirements

Returns
the chunk size

◆ userHeaderAlignment()

uint32_t iox::mepoo::ChunkSettings::userHeaderAlignment ( ) const
noexcept

getter method for the user-header alignment

Returns
the user-header alignment

◆ userHeaderSize()

uint32_t iox::mepoo::ChunkSettings::userHeaderSize ( ) const
noexcept

getter method for the user-header size

Returns
the user-header size

◆ userPayloadAlignment()

uint32_t iox::mepoo::ChunkSettings::userPayloadAlignment ( ) const
noexcept

getter method for the user-payload alignment

Returns
the user-payload alignment

◆ userPayloadSize()

uint32_t iox::mepoo::ChunkSettings::userPayloadSize ( ) const
noexcept

getter method for the user-payload size

Returns
the user-payload size

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