Inheritance diagram for iox::popo::RequestHeader:
Collaboration diagram for iox::popo::RequestHeader:
Public Member Functions | |
| RequestHeader (const cxx::UniqueId &uniqueClientQueueId, const uint32_t lastKnownClientQueueIndex) noexcept | |
| Constructs and initializes a RpcBaseHeader. More... | |
| RequestHeader (const RequestHeader &other)=delete | |
| RequestHeader & | operator= (const RequestHeader &)=delete |
| RequestHeader (RequestHeader &&rhs) noexcept=default | |
| RequestHeader & | operator= (RequestHeader &&rhs) noexcept=default |
| void | setSequenceId (const int64_t sequenceId) noexcept |
| Sets the sequence ID which is used to match a response to a request. More... | |
 Public Member Functions inherited from iox::popo::RpcBaseHeader | |
| RpcBaseHeader (const cxx::UniqueId &uniqueClientQueueId, const uint32_t lastKnownClientQueueIndex, const int64_t sequenceId, const uint8_t rpcHeaderVersion) noexcept | |
| Constructs and initializes a RpcBaseHeader. More... | |
| RpcBaseHeader (const RpcBaseHeader &other)=delete | |
| RpcBaseHeader & | operator= (const RpcBaseHeader &)=delete |
| RpcBaseHeader (RpcBaseHeader &&rhs) noexcept=default | |
| RpcBaseHeader & | operator= (RpcBaseHeader &&rhs) noexcept=default |
| uint8_t | getRpcHeaderVersion () const noexcept |
| The RpcBaseHeader version is used to detect incompatibilities for record&replay functionality. More... | |
| int64_t | getSequenceId () const noexcept |
| mepoo::ChunkHeader * | getChunkHeader () noexcept |
| Get the pointer to the ChunkHeader. More... | |
| const mepoo::ChunkHeader * | getChunkHeader () const noexcept |
| Get the const pointer to the ChunkHeader. More... | |
| void * | getUserPayload () noexcept |
| Get the pointer to the user-payload. More... | |
| const void * | getUserPayload () const noexcept |
| Get the const pointer to the user-payload. More... | |
Static Public Member Functions | |
| static RequestHeader * | fromPayload (void *const payload) noexcept |
| static const RequestHeader * | fromPayload (const void *const payload) noexcept |
Additional Inherited Members | |
| Static Public Attributes inherited from iox::popo::RpcBaseHeader | |
| 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} |
| Protected Attributes inherited from iox::popo::RpcBaseHeader | |
| uint8_t | m_rpcHeaderVersion {RPC_HEADER_VERSION} |
| uint32_t | m_lastKnownClientQueueIndex {UNKNOWN_CLIENT_QUEUE_INDEX} |
| cxx::UniqueId | m_uniqueClientQueueId |
| int64_t | m_sequenceId {0} |
Constructor & Destructor Documentation
◆ RequestHeader()
|
explicitnoexcept |
Constructs and initializes a RpcBaseHeader.
- Parameters
-
[in] uniqueClientQueueId is the cxx::UniqueId of the client queue to which the response shall be delivered [in] lastKnownClientQueueIndex is the last know index of the client queue in the ChunkDistributor for fast lookup
Member Function Documentation
◆ setSequenceId()
|
noexcept |
Sets the sequence ID which is used to match a response to a request.
- Parameters
-
[in] sequenceId is a consecutive number set by the user
- Note
- The user has to set this manually if multiple requests are sent before a response is read since a server might drop a requests or process the requests out of order and therefore the responses might also be out of order
The documentation for this class was generated from the following file:
- iceoryx_posh/popo/rpc_header.hpp
