◆ RpcBaseHeader()
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
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: