|
static constexpr uint8_t | RPC_HEADER_VERSION {1U} |
| From the 2.0 release onward, this must be incremented for each incompatible change, e.g. More...
|
|
static constexpr uint32_t | UNKNOWN_CLIENT_QUEUE_INDEX {std::numeric_limits<uint32_t>::max()} |
|
static constexpr int64_t | START_SEQUENCE_ID {0} |
|
|
uint8_t | m_rpcHeaderVersion {RPC_HEADER_VERSION} |
|
uint32_t | m_lastKnownClientQueueIndex {UNKNOWN_CLIENT_QUEUE_INDEX} |
|
cxx::UniqueId | m_uniqueClientQueueId |
|
int64_t | m_sequenceId {0} |
|
◆ RpcBaseHeader()
iox::popo::RpcBaseHeader::RpcBaseHeader |
( |
const cxx::UniqueId & |
uniqueClientQueueId, |
|
|
const uint32_t |
lastKnownClientQueueIndex, |
|
|
const int64_t |
sequenceId, |
|
|
const uint8_t |
rpcHeaderVersion |
|
) |
| |
|
explicitnoexcept |
Constructs and initializes a RpcBaseHeader.
- Parameters
-
[in] | uniqueClientQueueId | is the cxx::UniqueId of the client queue where the response shall be delivered |
[in] | lastKnownClientQueueIndex | is the last know index of the client queue in the ChunkDistributor for fast lookup |
[in] | sequenceId | is a custom ID to map a response to a request |
[in] | rpcHeaderVersion | is set by RequestHeader/ResponseHeader and should be RPC_HEADER_VERSION |
◆ getChunkHeader() [1/2]
Get the const pointer to the ChunkHeader.
- Returns
- the const pointer to the ChunkHeader
◆ getChunkHeader() [2/2]
Get the pointer to the ChunkHeader.
- Returns
- the pointer to the ChunkHeader
◆ getRpcHeaderVersion()
uint8_t iox::popo::RpcBaseHeader::getRpcHeaderVersion |
( |
| ) |
const |
|
noexcept |
◆ getSequenceId()
int64_t iox::popo::RpcBaseHeader::getSequenceId |
( |
| ) |
const |
|
noexcept |
@briet Obtains the sequence ID of the RPC message
- Returns
- the sequenceId of the RPC message
◆ getUserPayload() [1/2]
const void * iox::popo::RpcBaseHeader::getUserPayload |
( |
| ) |
const |
|
noexcept |
Get the const pointer to the user-payload.
- Returns
- the const pointer to the user-payload
◆ getUserPayload() [2/2]
void * iox::popo::RpcBaseHeader::getUserPayload |
( |
| ) |
|
|
noexcept |
Get the pointer to the user-payload.
- Returns
- the pointer to the user-payload
◆ RPC_HEADER_VERSION
constexpr uint8_t iox::popo::RpcBaseHeader::RPC_HEADER_VERSION {1U} |
|
staticconstexpr |
From the 2.0 release onward, this must be incremented for each incompatible change, e.g.
- data width of members changes
- members are rearranged
- semantic meaning of a member changes in any of RpcBaseHeader, RequestHeader or ResponseHeader!
The documentation for this class was generated from the following file: