|
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
} |
|
◆ 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] | chunkSize | is the size of the chunk fulfilling the user-payload and user-header requirements |
[in] | userPayloadSize | is the size of the user-payload |
[in] | userPayloadAlignment | is the alignment of the user-payload |
[in] | userHeaderSize | is the size of the user-header |
[in] | userHeaderAlignment | is 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: