Class PipelineFlowControlStatus

Namespace

Pipelinez.Core.FlowControl

Assembly

Pipelinez.dll

Represents the current flow-control state of the pipeline as a whole.

public sealed class PipelineFlowControlStatus

Inheritance

object

PipelineFlowControlStatus

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PipelineFlowControlStatus(PipelineOverflowPolicy, bool, double, int, int?, IReadOnlyList<PipelineComponentFlowStatus>)

Initializes a new flow-control snapshot.

public PipelineFlowControlStatus(PipelineOverflowPolicy overflowPolicy, bool isSaturated, double saturationRatio, int totalBufferedCount, int? totalCapacity, IReadOnlyList<PipelineComponentFlowStatus> components)

Parameters

overflowPolicy PipelineOverflowPolicy

isSaturated bool

saturationRatio double

totalBufferedCount int

totalCapacity int?

components IReadOnlyList<PipelineComponentFlowStatus>

Properties

Components

Gets the component-level flow snapshots.

public IReadOnlyList<PipelineComponentFlowStatus> Components { get; }

Property Value

IReadOnlyList<PipelineComponentFlowStatus>

IsSaturated

Gets a value indicating whether any component is currently saturated.

public bool IsSaturated { get; }

Property Value

bool

OverflowPolicy

Gets the default overflow policy applied by the pipeline.

public PipelineOverflowPolicy OverflowPolicy { get; }

Property Value

PipelineOverflowPolicy

SaturationRatio

Gets the overall saturation ratio across bounded components.

public double SaturationRatio { get; }

Property Value

double

TotalBufferedCount

Gets the total buffered record count across observed components.

public int TotalBufferedCount { get; }

Property Value

int

TotalCapacity

Gets the total bounded capacity across observed components, if one exists.

public int? TotalCapacity { get; }

Property Value

int?