Class ShutdownOptions

Namespace

AnyProtocol.Abstraction

Assembly

AnyProtocol.Abstraction.dll

Configures bounded AnyProtocol shutdown draining.

public sealed record ShutdownOptions : IEquatable<ShutdownOptions>

Inheritance

object

ShutdownOptions

Implements

IEquatable<ShutdownOptions>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ShutdownOptions()

public ShutdownOptions()

Fields

DefaultDrainTimeout

The default time allowed for admitted handlers to complete.

public static readonly TimeSpan DefaultDrainTimeout

Field Value

TimeSpan

DefaultForcedCancellationTimeout

The default time allowed for forced cancellation cleanup.

public static readonly TimeSpan DefaultForcedCancellationTimeout

Field Value

TimeSpan

Properties

DrainTimeout

Gets or initializes the time allowed for admitted work to drain.

public TimeSpan DrainTimeout { get; init; }

Property Value

TimeSpan

ForcedCancellationTimeout

Gets or initializes the time allowed for forced-cancellation cleanup.

public TimeSpan ForcedCancellationTimeout { get; init; }

Property Value

TimeSpan

Methods

Equals(ShutdownOptions?)

public bool Equals(ShutdownOptions? other)

Parameters

other ShutdownOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Validate()

Validates the shutdown policy.

public void Validate()

Operators

operator ==(ShutdownOptions?, ShutdownOptions?)

public static bool operator ==(ShutdownOptions? left, ShutdownOptions? right)

Parameters

left ShutdownOptions

right ShutdownOptions

Returns

bool

operator !=(ShutdownOptions?, ShutdownOptions?)

public static bool operator !=(ShutdownOptions? left, ShutdownOptions? right)

Parameters

left ShutdownOptions

right ShutdownOptions

Returns

bool