Skip to content

iox::popo::ResponseHeader🔗

Inherits from iox::popo::RpcBaseHeader

Public Functions🔗

Name
ResponseHeader(const cxx::UniqueId & uniqueClientQueueId, const uint32_t lastKnownClientQueueIndex, const int64_t sequenceId)
Constructs and initializes a RpcBaseHeader.
ResponseHeader(const ResponseHeader & other)
ResponseHeader & operator=(const ResponseHeader & )
ResponseHeader(ResponseHeader && rhs) =default
ResponseHeader & operator=(ResponseHeader && rhs) =default
~ResponseHeader() =default
void setServerError()
Sets the server error flag.
bool hasServerError() const
Obtains the server error flag.
ResponseHeader * fromPayload(void *const payload)
const ResponseHeader * fromPayload(const void *const payload)

Additional inherited members🔗

Public Functions inherited from iox::popo::RpcBaseHeader

Name
RpcBaseHeader(const cxx::UniqueId & uniqueClientQueueId, const uint32_t lastKnownClientQueueIndex, const int64_t sequenceId, const uint8_t rpcHeaderVersion)
Constructs and initializes a RpcBaseHeader.
RpcBaseHeader(const RpcBaseHeader & other)
RpcBaseHeader(RpcBaseHeader && rhs) =default
~RpcBaseHeader() =default
uint8_t getRpcHeaderVersion() const
The RpcBaseHeader version is used to detect incompatibilities for record&replay functionality.
int64_t getSequenceId() const
mepoo::ChunkHeader * getChunkHeader()
Get the pointer to the ChunkHeader.
const mepoo::ChunkHeader * getChunkHeader() const
Get the const pointer to the ChunkHeader.
void * getUserPayload()
Get the pointer to the user-payload.
const void * getUserPayload() const
Get the const pointer to the user-payload.

Public Attributes inherited from iox::popo::RpcBaseHeader

Name
constexpr uint8_t RPC_HEADER_VERSION
From the 2.0 release onward, this must be incremented for each incompatible change, e.g.
constexpr uint32_t UNKNOWN_CLIENT_QUEUE_INDEX
constexpr int64_t START_SEQUENCE_ID

Protected Attributes inherited from iox::popo::RpcBaseHeader

Name
uint8_t m_rpcHeaderVersion
uint32_t m_lastKnownClientQueueIndex
cxx::UniqueId m_uniqueClientQueueId
int64_t m_sequenceId

Friends inherited from iox::popo::RpcBaseHeader

Name
class ServerPortUser

Public Functions Documentation🔗

function ResponseHeader🔗

explicit ResponseHeader(
    const cxx::UniqueId & uniqueClientQueueId,
    const uint32_t lastKnownClientQueueIndex,
    const int64_t sequenceId
)

Constructs and initializes a RpcBaseHeader.

Parameters:

  • uniqueClientQueueId is the cxx::UniqueId of the client queue to which the response shall be delivered
  • lastKnownClientQueueIndex is the last know index of the client queue in the ChunkDistributor for fast lookup
  • sequenceId is a custom ID to map a response to a request

function ResponseHeader🔗

ResponseHeader(
    const ResponseHeader & other
)

function operator=🔗

ResponseHeader & operator=(
    const ResponseHeader & 
)

function ResponseHeader🔗

ResponseHeader(
    ResponseHeader && rhs
) =default

function operator=🔗

ResponseHeader & operator=(
    ResponseHeader && rhs
) =default

function ~ResponseHeader🔗

~ResponseHeader() =default

function setServerError🔗

void setServerError()

Sets the server error flag.

function hasServerError🔗

bool hasServerError() const

Obtains the server error flag.

Return: true if there is an error, false otherwise

function fromPayload🔗

static ResponseHeader * fromPayload(
    void *const payload
)

function fromPayload🔗

static const ResponseHeader * fromPayload(
    const void *const payload
)

Updated on 18 December 2023 at 13:11:43 CET