iceoryx_posh 2.0.3
|
Public Types | |
using | UserPayloadOffset_t = uint32_t |
Public Member Functions | |
ChunkHeader (const uint32_t chunkSize, const ChunkSettings &chunkSettings) noexcept | |
constructs and initializes a ChunkHeader More... | |
ChunkHeader (const ChunkHeader &)=delete | |
ChunkHeader (ChunkHeader &&)=delete | |
ChunkHeader & | operator= (const ChunkHeader &)=delete |
ChunkHeader & | operator= (ChunkHeader &&)=delete |
uint8_t | chunkHeaderVersion () const noexcept |
The ChunkHeader version is used to detect incompatibilities for record&replay functionality. More... | |
uint16_t | userHeaderId () const noexcept |
The id of the user-header used by the chunk; if no user-header is used, this is set to NO_USER_HEADER. More... | |
void * | userHeader () noexcept |
Get the pointer to the user-header. More... | |
const void * | userHeader () const noexcept |
Get the const pointer to the user-header. More... | |
void * | userPayload () noexcept |
Get a pointer to the user-payload carried by the chunk. More... | |
const void * | userPayload () const noexcept |
Get a const pointer to the user-payload carried by the chunk. More... | |
uint32_t | usedSizeOfChunk () const noexcept |
Calculates the used size of the chunk with the ChunkHeader, user-heander and user-payload. More... | |
uint32_t | chunkSize () const noexcept |
The size of the whole chunk, including the header. More... | |
uint32_t | userHeaderSize () const noexcept |
The size of the chunk occupied by the user-header. More... | |
uint32_t | userPayloadSize () const noexcept |
The size of the chunk occupied by the user-payload. More... | |
uint32_t | userPayloadAlignment () const noexcept |
The alignment of the chunk occupied by the user-payload. More... | |
popo::UniquePortId | originId () const noexcept |
The unique identifier of the publisher the chunk was sent from. More... | |
uint64_t | sequenceNumber () const noexcept |
A serial number for the sent chunks. More... | |
Static Public Member Functions | |
static ChunkHeader * | fromUserPayload (void *const userPayload) noexcept |
Get a pointer to the ChunkHeader associated to the user-payload of the chunk. More... | |
static const ChunkHeader * | fromUserPayload (const void *const userPayload) noexcept |
Get a const pointer to the ChunkHeader associated to the user-payload of the chunk. More... | |
static ChunkHeader * | fromUserHeader (void *const userHeader) noexcept |
Get a pointer to the ChunkHeader associated to the user-header of the chunk. More... | |
static const ChunkHeader * | fromUserHeader (const void *const userHeader) noexcept |
Get a const pointer to the ChunkHeader associated to the user-header of the chunk. More... | |
Static Public Attributes | |
static constexpr uint8_t | CHUNK_HEADER_VERSION {1U} |
From the 1.0 release onward, this must be incremented for each incompatible change, e.g. More... | |
static constexpr uint16_t | NO_USER_HEADER {0x0000} |
User-Header id for no user-header. | |
static constexpr uint16_t | UNKNOWN_USER_HEADER {0xFFFF} |
User-Header id for an unknown user-header. | |
Friends | |
template<typename T > | |
class | popo::ChunkSender |
|
noexcept |
constructs and initializes a ChunkHeader
[in] | chunkSize | is the size of the chunk the ChunkHeader is constructed |
[in] | chunkSettings | are the settings like user-payload size and user-header alignment |
|
noexcept |
The ChunkHeader version is used to detect incompatibilities for record&replay functionality.
|
noexcept |
The size of the whole chunk, including the header.
|
staticnoexcept |
Get a const pointer to the ChunkHeader
associated to the user-header of the chunk.
[in] | userHeader | is the const pointer to the user-header of the chunk |
ChunkHeader
or a nullptr
if userPayload
is a nullptr
|
staticnoexcept |
Get a pointer to the ChunkHeader
associated to the user-header of the chunk.
[in] | userHeader | is the pointer to the user-header of the chunk |
ChunkHeader
or a nullptr
if userHeader
is a nullptr
|
staticnoexcept |
Get a const pointer to the ChunkHeader
associated to the user-payload of the chunk.
[in] | userPayload | is the const pointer to the user-payload of the chunk |
ChunkHeader
or a nullptr
if userPayload
is a nullptr
|
staticnoexcept |
Get a pointer to the ChunkHeader
associated to the user-payload of the chunk.
[in] | userPayload | is the pointer to the user-payload of the chunk |
ChunkHeader
or a nullptr
if userPayload
is a nullptr
|
noexcept |
The unique identifier of the publisher the chunk was sent from.
|
noexcept |
A serial number for the sent chunks.
the serquence number of the chunk
|
noexcept |
Calculates the used size of the chunk with the ChunkHeader, user-heander and user-payload.
|
noexcept |
Get the const pointer to the user-header.
|
noexcept |
Get the pointer to the user-header.
|
noexcept |
The id of the user-header used by the chunk; if no user-header is used, this is set to NO_USER_HEADER.
|
noexcept |
The size of the chunk occupied by the user-header.
|
noexcept |
Get a const pointer to the user-payload carried by the chunk.
|
noexcept |
Get a pointer to the user-payload carried by the chunk.
|
noexcept |
The alignment of the chunk occupied by the user-payload.
|
noexcept |
The size of the chunk occupied by the user-payload.
|
staticconstexpr |
From the 1.0 release onward, this must be incremented for each incompatible change, e.g.