Skip to content
Start free evaluation

PdcommGemSpoolOptions

Struct

Storage limits and persistence bound for an Equipment spool.

typedef struct PdcommGemSpoolOptions { ... } PdcommGemSpoolOptions

Declared in: #include <pdcomm_gem_spooling.h>

Passed to pdcomm_gem_configure_spooling(). Message bodies are also bounded by the item limits of the configured GEM Equipment, which must all be nonzero.

Members

max_body_bytes

Field

Largest encoded body of one captured message in bytes; larger bodies are rejected.

size_t max_body_bytes

Declared in: #include <pdcomm_gem_spooling.h>

max_catalog_entries

Field

Largest number of catalog entries; also bounds the total functions listed in an incoming S2F43 or an outgoing S2F60.

size_t max_catalog_entries

Declared in: #include <pdcomm_gem_spooling.h>

max_functions_per_stream

Field

Largest number of functions listed for one stream in a selection.

size_t max_functions_per_stream

Declared in: #include <pdcomm_gem_spooling.h>

max_messages

Field

Largest number of spooled messages; reaching it makes the spool full.

size_t max_messages

Declared in: #include <pdcomm_gem_spooling.h>

max_serialized_bytes

Field

Largest snapshot file size in bytes; used only with a file path.

uint64_t max_serialized_bytes

Declared in: #include <pdcomm_gem_spooling.h>

Checked when an existing snapshot is loaded and before every write. Values below the minimum snapshot size (144 bytes) are rejected with #PDCOMM_INVALID_ARGUMENT when a file path is given.

max_streams

Field

Largest number of streams in a selection, locally or in S2F43 and S2F60.

size_t max_streams

Declared in: #include <pdcomm_gem_spooling.h>

max_total_body_bytes

Field

Largest total encoded body bytes of all spooled messages; reaching it makes the spool full.

size_t max_total_body_bytes

Declared in: #include <pdcomm_gem_spooling.h>

reserved

Field

Reserved; must be 0.

uint32_t reserved

Declared in: #include <pdcomm_gem_spooling.h>

struct_size

Field

Size of this structure in bytes; set to sizeof(PdcommGemSpoolOptions) or larger.

size_t struct_size

Declared in: #include <pdcomm_gem_spooling.h>

version

Field

Structure version; must be #PDCOMM_GEM_SPOOL_OPTIONS_VERSION.

uint32_t version

Declared in: #include <pdcomm_gem_spooling.h>