pdcomm::GemResultInfo

Struct

Common information about a GemResult, returned by GemResult::info().

struct GemResultInfo

Declared in: #include <pdcomm_gem.hpp>

Members

acknowledgement

Field

Acknowledgement code from the reply (for example COMMACK, ONLACK, DRACK or HCACK); valid only when #acknowledgementPresent is true.

uint8_t acknowledgement

Declared in: #include <pdcomm_gem.hpp>

acknowledgementPresent

Field

true when #acknowledgement holds a received or sent acknowledgement code.

bool acknowledgementPresent

Declared in: #include <pdcomm_gem.hpp>

code

Field

Failure detail: a PDCOMM_TCP_* failure reason for Failed results, or a PDCOMM_GEM_ERROR_* value for InvalidResponse and Unhandled results; otherwise 0.

uint32_t code

Declared in: #include <pdcomm_gem.hpp>

entryCount

Field

Number of entries that the typed getters can read (values, names, alarms, reports, rows or IDs, depending on the outcome).

size_t entryCount

Declared in: #include <pdcomm_gem.hpp>

kind

Field

Result classification.

GemResultKind kind

Declared in: #include <pdcomm_gem.hpp>

outcome

Field

Meaning of the result.

GemOutcome outcome

Declared in: #include <pdcomm_gem.hpp>

replySent

Field

true when a reply to an incoming primary was sent, by the library or by a respond call.

bool replySent

Declared in: #include <pdcomm_gem.hpp>

request

Field

Transaction kind the result belongs to.

GemRequest request

Declared in: #include <pdcomm_gem.hpp>

state

Field

Endpoint state captured when the result was produced.

GemState state

Declared in: #include <pdcomm_gem.hpp>

token

Field

Transaction token: the submitted request's token for replies and failures, or the incoming message's identity for primaries.

PdcommTcpToken token

Declared in: #include <pdcomm_gem.hpp>