Skip to content

iox::mepoo::ChunkSettings🔗

Public Types🔗

Name
enum Error

Public Functions🔗

Name
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)
constructs and initializes a ChunkSettings
uint32_t requiredChunkSize() const
getter method for the chunk size fulfilling the user-payload and user-header requirements
uint32_t userPayloadSize() const
getter method for the user-payload size
uint32_t userPayloadAlignment() const
getter method for the user-payload alignment
uint32_t userHeaderSize() const
getter method for the user-header size
uint32_t userHeaderAlignment() const
getter method for the user-header alignment

Public Types Documentation🔗

enum Error🔗

Enumerator Value Description
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 Functions Documentation🔗

function create🔗

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
)

constructs and initializes a ChunkSettings

Parameters:

  • chunkSize is the size of the chunk fulfilling the user-payload and user-header requirements
  • userPayloadSize is the size of the user-payload
  • userPayloadAlignment is the alignment of the user-payload
  • userHeaderSize is the size of the user-header
  • userHeaderAlignment is the alignment for the user-header

function requiredChunkSize🔗

uint32_t requiredChunkSize() const

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

Return: the chunk size

function userPayloadSize🔗

uint32_t userPayloadSize() const

getter method for the user-payload size

Return: the user-payload size

function userPayloadAlignment🔗

uint32_t userPayloadAlignment() const

getter method for the user-payload alignment

Return: the user-payload alignment

function userHeaderSize🔗

uint32_t userHeaderSize() const

getter method for the user-header size

Return: the user-header size

function userHeaderAlignment🔗

uint32_t userHeaderAlignment() const

getter method for the user-header alignment

Return: the user-header alignment

Updated on 31 May 2022 at 11:34:55 CEST