pdcomm::GemSpoolState

Struct

State of the spool, returned by GemEndpoint::spoolState().

struct GemSpoolState

Declared in: #include <pdcomm_gem.hpp>

Timestamps and statistics are application-supplied values, not SEMI-defined IDs.

Members

`active`

Field

true while spooling is active (communication lost).

bool active

Declared in: #include <pdcomm_gem.hpp>

`bodyBytes`

Field

Total bytes of stored message bodies.

size_t bodyBytes

Declared in: #include <pdcomm_gem.hpp>

`catalogCount`

Field

Registered spoolable stream and function pairs.

size_t catalogCount

Declared in: #include <pdcomm_gem.hpp>

`connected`

Field

Connection state observed at the last synchronization.

bool connected

Declared in: #include <pdcomm_gem.hpp>

`deliveryPending`

Field

true while a delivery attempt is in flight.

bool deliveryPending

Declared in: #include <pdcomm_gem.hpp>

`dequeuePending`

Field

true when a delivered entry still waits for GemEndpoint::retrySpoolDequeue().

bool dequeuePending

Declared in: #include <pdcomm_gem.hpp>

`discarded`

Field

Messages discarded or overwritten because the spool was full.

uint64_t discarded

Declared in: #include <pdcomm_gem.hpp>

`enabled`

Field

Global spooling switch.

bool enabled

Declared in: #include <pdcomm_gem.hpp>

`fullTime`

Field

Application timestamp when the spool became full; valid when #fullTimePresent is true.

uint64_t fullTime

Declared in: #include <pdcomm_gem.hpp>

`fullTimePresent`

Field

true when #fullTime is set.

bool fullTimePresent

Declared in: #include <pdcomm_gem.hpp>

`maxTransmit`

Field

Configured messages per transmit run; 0 means unbounded.

uint32_t maxTransmit

Declared in: #include <pdcomm_gem.hpp>

`messageCount`

Field

Stored messages.

size_t messageCount

Declared in: #include <pdcomm_gem.hpp>

`nextId`

Field

ID the next stored entry will get.

uint64_t nextId

Declared in: #include <pdcomm_gem.hpp>

`overflow`

Field

Configured overflow behaviour.

GemSpoolOverflow overflow

Declared in: #include <pdcomm_gem.hpp>

`persistent`

Field

true when the spool is backed by a file.

bool persistent

Declared in: #include <pdcomm_gem.hpp>

`received`

Field

Selected messages offered for capture.

uint64_t received

Declared in: #include <pdcomm_gem.hpp>

`selectionCount`

Field

Selected streams.

size_t selectionCount

Declared in: #include <pdcomm_gem.hpp>

`startTime`

Field

Application timestamp when spooling started; valid when #startTimePresent is true.

uint64_t startTime

Declared in: #include <pdcomm_gem.hpp>

`startTimePresent`

Field

true when #startTime is set.

bool startTimePresent

Declared in: #include <pdcomm_gem.hpp>

`stored`

Field

Messages stored.

uint64_t stored

Declared in: #include <pdcomm_gem.hpp>

`synchronized`

Field

true when GemEquipment::syncSpool() observed the current connection state.

bool synchronized

Declared in: #include <pdcomm_gem.hpp>

`transmitted`

Field

Messages delivered and removed from the spool.

uint64_t transmitted

Declared in: #include <pdcomm_gem.hpp>

`transmittedInRun`

Field

Messages sent in the current transmit run.

uint32_t transmittedInRun

Declared in: #include <pdcomm_gem.hpp>

`transmitting`

Field

true during a transmit run accepted by S6F23.

bool transmitting

Declared in: #include <pdcomm_gem.hpp>