PdcommGemSpoolInfo

Struct

Spooling details of a GEM result, filled by pdcomm_gem_result_spool_info().

typedef struct PdcommGemSpoolInfo { ... } PdcommGemSpoolInfo

Declared in: #include <pdcomm_gem_spooling.h>

Processing fields describe the last operation performed on this result. A later pdcomm_gem_spool_retry_dequeue() changes endpoint state, not these historical fields; use pdcomm_gem_spool_state() for the current queue.

Members

`acknowledgement`

Field

Acknowledgement code: RSPACK (S2F44), RSDA (S6F24), or ACKC5/ACKC6 from a delivered S5F1/S6F11 reply.

uint8_t acknowledgement

Declared in: #include <pdcomm_gem_spooling.h>

`acknowledgement_present`

Field

1 when acknowledgement is valid.

uint8_t acknowledgement_present

Declared in: #include <pdcomm_gem_spooling.h>

`applied`

Field

1 when processing this result installed a spool change.

uint8_t applied

Declared in: #include <pdcomm_gem_spooling.h>

`command`

Field

S6F23 command (#PDCOMM_GEM_SPOOL_TRANSMIT or #PDCOMM_GEM_SPOOL_PURGE) for control kinds; otherwise 0.

uint32_t command

Declared in: #include <pdcomm_gem_spooling.h>

`confirmation_required`

Field

1 when a retained reply waits for pdcomm_gem_spool_confirm_reply() after #PDCOMM_SPOOL_UNCONFIRMED.

uint8_t confirmation_required

Declared in: #include <pdcomm_gem_spooling.h>

`delivery_attempt`

Field

Delivery attempt number for delivery results; otherwise 0.

uint64_t delivery_attempt

Declared in: #include <pdcomm_gem_spooling.h>

`delivery_completed`

Field

1 when pdcomm_gem_spool_complete_delivery() finished with this delivery result.

uint8_t delivery_completed

Declared in: #include <pdcomm_gem_spooling.h>

`delivery_proof`

Field

Delivery proof: #PDCOMM_GEM_SPOOL_PROOF_NONE, #PDCOMM_GEM_SPOOL_PROOF_RESPONSE, or #PDCOMM_GEM_SPOOL_PROOF_WRITTEN.

uint32_t delivery_proof

Declared in: #include <pdcomm_gem_spooling.h>

`dequeue_pending`

Field

1 when delivery succeeded but the dequeue failed before installation and is still pending.

uint8_t dequeue_pending

Declared in: #include <pdcomm_gem_spooling.h>

`durability`

Field

Durability of the change applied by a response or delivery, as in ::PdcommGemSpoolWriteInfo, or #PDCOMM_GEM_SPOOL_CONFIRMED.

uint32_t durability

Declared in: #include <pdcomm_gem_spooling.h>

`entry_id`

Field

Entry ID of the delivered message for delivery results; otherwise 0.

uint64_t entry_id

Declared in: #include <pdcomm_gem_spooling.h>

`error_count`

Field

Number of stream errors in a received S2F44.

size_t error_count

Declared in: #include <pdcomm_gem_spooling.h>

`is_request`

Field

1 for an incoming request (Equipment side); 0 for a response or delivery result.

uint8_t is_request

Declared in: #include <pdcomm_gem_spooling.h>

`persistence_status`

Field

#PDCOMM_OK, or the persistence error of an unconfirmed or failed installation or dequeue.

int32_t persistence_status

Declared in: #include <pdcomm_gem_spooling.h>

`reply_ready`

Field

1 when a prepared reply is retained and can be sent by pdcomm_gem_spool_respond().

uint8_t reply_ready

Declared in: #include <pdcomm_gem_spooling.h>

`request_kind`

Field

Request kind: #PDCOMM_GEM_SPOOL_CONFIGURE, #PDCOMM_GEM_SPOOL_QUERY, #PDCOMM_GEM_SPOOL_CONTROL, or #PDCOMM_GEM_SPOOL_DELIVERY.

uint32_t request_kind

Declared in: #include <pdcomm_gem_spooling.h>

`responded`

Field

1 after the reply to an incoming request was queued.

uint8_t responded

Declared in: #include <pdcomm_gem_spooling.h>

`selection_count`

Field

Number of stream selections in an incoming S2F43 or a received S2F60.

size_t selection_count

Declared in: #include <pdcomm_gem_spooling.h>

`struct_size`

Field

Size of this structure in bytes; set to sizeof(PdcommGemSpoolInfo) or larger before the call.

size_t struct_size

Declared in: #include <pdcomm_gem_spooling.h>

`success_accepted`

Field

1 when the application reported this delivery as successful.

uint8_t success_accepted

Declared in: #include <pdcomm_gem_spooling.h>