PDComm.GemEquipmentSpoolConfiguration

Class

Represents the spool that GemEquipmentWorker.StartWithSpoolingAsync attaches to the equipment.

public sealed record GemEquipmentSpoolConfiguration

The start method copies the configuration before it returns. On the worker thread it calls GemEquipment.ConfigureSpooling and, when GemEquipmentSpoolConfiguration.LocalPolicy is set, GemEquipment.ConfigureLocalSpooling.

Parameters

Name	Description
`Options`	The spool limits.
`Catalog`	The primary messages that can be spooled, in order; empty to accept the catalog of an existing snapshot file.
`Path`	The path of the snapshot file, whose parent directory must exist, or `null` for an in-memory spool.
`LocalPolicy`	The local spooling policy, or `null` to keep the policy of a new spool (disabled) or of the loaded file.
`Selections`	The stream selections applied with `LocalPolicy`; not applied when it is `null`, but still checked against the limits.

Members

`GemEquipmentSpoolConfiguration`

Constructor

Represents the spool that GemEquipmentWorker.StartWithSpoolingAsync attaches to the equipment.

public GemEquipmentSpoolConfiguration(GemSpoolOptions Options, ReadOnlyMemory<GemSpoolMessageKey> Catalog, string? Path = null, GemSpoolPolicy? LocalPolicy = null, ReadOnlyMemory<GemSpoolSelection> Selections = default)

Parameters

Name	Description
`Options`	The spool limits.
`Catalog`	The primary messages that can be spooled, in order; empty to accept the catalog of an existing snapshot file.
`Path`	The path of the snapshot file, whose parent directory must exist, or `null` for an in-memory spool.
`LocalPolicy`	The local spooling policy, or `null` to keep the policy of a new spool (disabled) or of the loaded file.
`Selections`	The stream selections applied with `LocalPolicy`; not applied when it is `null`, but still checked against the limits.

`Catalog`

Property

The primary messages that can be spooled, in order; empty to accept the catalog of an existing snapshot file.

public ReadOnlyMemory<GemSpoolMessageKey> Catalog { get; init; }

`LocalPolicy`

Property

The local spooling policy, or null to keep the policy of a new spool (disabled) or of the loaded file.

public GemSpoolPolicy? LocalPolicy { get; init; }

`Options`

Property

The spool limits.

public GemSpoolOptions Options { get; init; }

`Path`

Property

The path of the snapshot file, whose parent directory must exist, or null for an in-memory spool.

public string? Path { get; init; }

`Selections`

Property

The stream selections applied with LocalPolicy; not applied when it is null, but still checked against the limits.

public ReadOnlyMemory<GemSpoolSelection> Selections { get; init; }