PdcommGemResultInfo

Struct

Fixed fields of a ::PdcommGemResult, read with pdcomm_gem_result_info().

typedef struct PdcommGemResultInfo { ... } PdcommGemResultInfo

Declared in: #include <pdcomm_gem.h>

Members

acknowledgement

Field

Acknowledgement code of the exchange (such as COMMACK, OFLACK, or ONLACK); valid only when acknowledgement_present is nonzero.

uint8_t acknowledgement

Declared in: #include <pdcomm_gem.h>

acknowledgement_present

Field

Nonzero when acknowledgement holds a value.

uint8_t acknowledgement_present

Declared in: #include <pdcomm_gem.h>

code

Field

Failure or error detail; 0 when there is none.

uint32_t code

Declared in: #include <pdcomm_gem.h>

For #PDCOMM_GEM_FAILED, a PDCOMM_TCP_* failure reason or #PDCOMM_GEM_ERROR_ABORTED. For #PDCOMM_GEM_INVALID_RESPONSE and #PDCOMM_GEM_UNHANDLED, a PDCOMM_GEM_ERROR_* value.

entry_count

Field

Number of entries in list-type results, such as the values of #PDCOMM_GEM_VALUES_RECEIVED or the entries of #PDCOMM_GEM_NAMES_RECEIVED; 0 otherwise.

size_t entry_count

Declared in: #include <pdcomm_gem.h>

kind

Field

Result kind: #PDCOMM_GEM_IGNORED, #PDCOMM_GEM_PRIMARY, #PDCOMM_GEM_RESPONSE, #PDCOMM_GEM_FAILED, #PDCOMM_GEM_INVALID_RESPONSE, or #PDCOMM_GEM_UNHANDLED.

uint32_t kind

Declared in: #include <pdcomm_gem.h>

outcome

Field

What the message did, as a PDCOMM_GEM_* outcome value.

uint32_t outcome

Declared in: #include <pdcomm_gem.h>

Values 0 to 13 are defined in this header; the other GEM headers define additional outcomes. #PDCOMM_GEM_OUTCOME_NONE when there is no outcome.

reply_sent

Field

Nonzero when this side has sent the reply to the primary of this result.

uint8_t reply_sent

Declared in: #include <pdcomm_gem.h>

pdcomm_gem_handle_event() sets it when the library answers a received primary automatically; the respond functions of the other GEM headers set it when they answer a primary result explicitly. It stays zero for #PDCOMM_GEM_RESPONSE results, which answer this side's own requests.

request_kind

Field

Request kind of the matched pending request for response, failed, and invalid-response results; 0 otherwise.

uint32_t request_kind

Declared in: #include <pdcomm_gem.h>

state

Field

GEM state of the endpoint after the event was processed.

PdcommGemState state

Declared in: #include <pdcomm_gem.h>

struct_size

Field

Structure size in bytes.

size_t struct_size

Declared in: #include <pdcomm_gem.h>

Set it to sizeof(PdcommGemResultInfo) or larger before the call. On success the library stores the size of the layout it wrote; bytes past that size are not modified.

token

Field

Transaction token.

PdcommTcpToken token

Declared in: #include <pdcomm_gem.h>

For a primary: the endpoint, generation, and system bytes of the received message. For response, failed, and invalid-response results: the token returned when the request was submitted. Zero for ignored events that carry no transaction.