PdcommGemSpoolWriteInfo

Struct

Outcome of a spool mutation.

typedef struct PdcommGemSpoolWriteInfo { ... } PdcommGemSpoolWriteInfo

Declared in: #include <pdcomm_gem_spooling.h>

Filled by the configure, sync, capture, purge, delivery-completion, and dequeue functions. It is cleared before validation, so after a failure applied is 0; after #PDCOMM_SPOOL_UNCONFIRMED it describes the installed change.

Members

affected_count

Field

Overwritten entries for a capture, purged entries for a purge, 1 for a dequeue; otherwise 0.

size_t affected_count

Declared in: #include <pdcomm_gem_spooling.h>

applied

Field

1 when a change was installed; 0 otherwise.

uint8_t applied

Declared in: #include <pdcomm_gem_spooling.h>

durability

Field

Durability of the change: #PDCOMM_GEM_SPOOL_DURABILITY_NONE, #PDCOMM_GEM_SPOOL_VOLATILE, #PDCOMM_GEM_SPOOL_SYNCED, or #PDCOMM_GEM_SPOOL_UNCONFIRMED.

uint32_t durability

Declared in: #include <pdcomm_gem_spooling.h>

entry_id

Field

Entry ID of a captured (#PDCOMM_GEM_SPOOL_CAPTURED) or removed (#PDCOMM_GEM_SPOOL_REMOVED) entry; otherwise 0.

uint64_t entry_id

Declared in: #include <pdcomm_gem_spooling.h>

mutation

Field

Kind of change: one of the PDCOMM_GEM_SPOOL_MUTATION_NONE to PDCOMM_GEM_SPOOL_PURGED values.

uint32_t mutation

Declared in: #include <pdcomm_gem_spooling.h>

persistence_status

Field

#PDCOMM_OK, or the persistence error (for example #PDCOMM_IO_ERROR) when durability is #PDCOMM_GEM_SPOOL_UNCONFIRMED.

int32_t persistence_status

Declared in: #include <pdcomm_gem_spooling.h>

selected

Field

1 when a change was installed; 0 when a captured message was not selected for spooling.

uint8_t selected

Declared in: #include <pdcomm_gem_spooling.h>

struct_size

Field

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

size_t struct_size

Declared in: #include <pdcomm_gem_spooling.h>