PDComm.Secs1WorkerOptions

Class

Queue capacities and timing for a Secs1Worker.

public sealed record Secs1WorkerOptions

Parameters

Name	Description
CommandCapacity	The largest number of commands waiting to run; must be positive.
MaxCommandBytes	The largest total body size, in bytes, of waiting submissions; must not be negative.
EventCapacity	The largest number of events buffered for reading; must be positive.
MaxEventBytes	The largest total body size, in bytes, of buffered events; must be at least Secs1Options.MaxBodyBytes.
PollIntervalMilliseconds	How long, in milliseconds, the worker sleeps after each loop; each loop runs at most one queued command. Must be positive.
ShutdownTimeoutMilliseconds	How long, in milliseconds, Secs1Worker.DisposeAsync waits for the worker thread; must be positive.

Members

Secs1WorkerOptions

Constructor

Queue capacities and timing for a Secs1Worker.

public Secs1WorkerOptions(int CommandCapacity, long MaxCommandBytes, int EventCapacity, long MaxEventBytes, int PollIntervalMilliseconds = 2, int ShutdownTimeoutMilliseconds = 5000)

Parameters

Name	Description
CommandCapacity	The largest number of commands waiting to run; must be positive.
MaxCommandBytes	The largest total body size, in bytes, of waiting submissions; must not be negative.
EventCapacity	The largest number of events buffered for reading; must be positive.
MaxEventBytes	The largest total body size, in bytes, of buffered events; must be at least Secs1Options.MaxBodyBytes.
PollIntervalMilliseconds	How long, in milliseconds, the worker sleeps after each loop; each loop runs at most one queued command. Must be positive.
ShutdownTimeoutMilliseconds	How long, in milliseconds, Secs1Worker.DisposeAsync waits for the worker thread; must be positive.

CommandCapacity

Property

The largest number of commands waiting to run; must be positive.

public int CommandCapacity { get; init; }

EventCapacity

Property

The largest number of events buffered for reading; must be positive.

public int EventCapacity { get; init; }

MaxCommandBytes

Property

The largest total body size, in bytes, of waiting submissions; must not be negative.

public long MaxCommandBytes { get; init; }

MaxEventBytes

Property

The largest total body size, in bytes, of buffered events; must be at least Secs1Options.MaxBodyBytes.

public long MaxEventBytes { get; init; }

PollIntervalMilliseconds

Property

How long, in milliseconds, the worker sleeps after each loop; each loop runs at most one queued command. Must be positive.

public int PollIntervalMilliseconds { get; init; }

ShutdownTimeoutMilliseconds

Property

How long, in milliseconds, Secs1Worker.DisposeAsync waits for the worker thread; must be positive.

public int ShutdownTimeoutMilliseconds { get; init; }