PdcommGemSpoolState

Struct

Snapshot of an Equipment spool, filled by pdcomm_gem_spool_state().

typedef struct PdcommGemSpoolState { ... } PdcommGemSpoolState

Declared in: #include <pdcomm_gem_spooling.h>

Members

`active`

Field

1 when spooling is active (E30 SPOOL ACTIVE): messages are being stored or are still waiting for delivery.

uint8_t active

Declared in: #include <pdcomm_gem_spooling.h>

`body_bytes`

Field

Total encoded body bytes of the spooled messages.

size_t body_bytes

Declared in: #include <pdcomm_gem_spooling.h>

`catalog_count`

Field

Number of catalog entries.

size_t catalog_count

Declared in: #include <pdcomm_gem_spooling.h>

`connected`

Field

1 when the last sync observed a Selected, Communicating connection.

uint8_t connected

Declared in: #include <pdcomm_gem_spooling.h>

`delivery_pending`

Field

1 while a delivery attempt is in flight or an acknowledged dequeue is pending.

uint8_t delivery_pending

Declared in: #include <pdcomm_gem_spooling.h>

`dequeue_pending`

Field

1 when a delivered head entry still has to be dequeued with pdcomm_gem_spool_retry_dequeue().

uint8_t dequeue_pending

Declared in: #include <pdcomm_gem_spooling.h>

`discarded`

Field

Messages discarded or overwritten because the spool was full.

uint64_t discarded

Declared in: #include <pdcomm_gem_spooling.h>

`enabled`

Field

1 when spooling is enabled.

uint8_t enabled

Declared in: #include <pdcomm_gem_spooling.h>

`full_time`

Field

Application timestamp when the spool became full (E30 SpoolFullTime); valid when full_time_present is 1.

uint64_t full_time

Declared in: #include <pdcomm_gem_spooling.h>

`full_time_present`

Field

1 when full_time holds a value.

uint8_t full_time_present

Declared in: #include <pdcomm_gem_spooling.h>

`max_transmit`

Field

Current per-run transmit limit; 0 means unbounded.

uint32_t max_transmit

Declared in: #include <pdcomm_gem_spooling.h>

`message_count`

Field

Number of spooled messages (E30 SpoolCountActual).

size_t message_count

Declared in: #include <pdcomm_gem_spooling.h>

`next_id`

Field

Entry ID that the next stored message receives.

uint64_t next_id

Declared in: #include <pdcomm_gem_spooling.h>

`overflow`

Field

Current overflow policy: #PDCOMM_GEM_SPOOL_DISCARD_NEW or #PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST.

uint32_t overflow

Declared in: #include <pdcomm_gem_spooling.h>

`persistent`

Field

1 when the spool is backed by a snapshot file; 0 for RAM.

uint8_t persistent

Declared in: #include <pdcomm_gem_spooling.h>

`received`

Field

Selected messages offered for spooling while active, stored or discarded.

uint64_t received

Declared in: #include <pdcomm_gem_spooling.h>

`selection_count`

Field

Number of streams in the current selection.

size_t selection_count

Declared in: #include <pdcomm_gem_spooling.h>

`start_time`

Field

Application timestamp when spooling started (E30 SpoolStartTime); valid when start_time_present is 1.

uint64_t start_time

Declared in: #include <pdcomm_gem_spooling.h>

`start_time_present`

Field

1 when start_time holds a value.

uint8_t start_time_present

Declared in: #include <pdcomm_gem_spooling.h>

`stored`

Field

Messages stored in the spool.

uint64_t stored

Declared in: #include <pdcomm_gem_spooling.h>

`struct_size`

Field

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

size_t struct_size

Declared in: #include <pdcomm_gem_spooling.h>

`synchronized`

Field

1 when the last pdcomm_gem_spool_sync() still matches the current connection state.

uint8_t synchronized

Declared in: #include <pdcomm_gem_spooling.h>

`transmitted`

Field

Spooled messages delivered and dequeued.

uint64_t transmitted

Declared in: #include <pdcomm_gem_spooling.h>

`transmitted_in_run`

Field

Messages dequeued in the current transmission run.

uint32_t transmitted_in_run

Declared in: #include <pdcomm_gem_spooling.h>

`transmitting`

Field

1 while a transmission run accepted by S6F23 is in progress.

uint8_t transmitting

Declared in: #include <pdcomm_gem_spooling.h>