Class Valve<T>

Materializes into a task of IValveSwitch which provides a method that will stop or restart the flow of elements passing through the stage. As long as the valve is closed it will backpressure. Note that closing the valve could result in one element being buffered inside the stage, and if the stream completes or fails while being closed, that element may be lost.

Inheritance

object

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>

Valve<T>

Implements

IGraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>

IGraph<FlowShape<T, T>, Task<IValveSwitch>>

IGraph<FlowShape<T, T>>

Inherited Members

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.InitialAttributes

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.Shape

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.WithAttributes(Attributes)

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.CreateLogicAndMaterializedValue(Attributes)

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.Module

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.AddAttributes(Attributes)

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.Named(string)

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.Async()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Streams.Dsl

Assembly: Akka.Streams.dll

Syntax

public class Valve<T> : GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>, IGraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>, IGraph<FlowShape<T, T>, Task<IValveSwitch>>, IGraph<FlowShape<T, T>>

Type Parameters

Name	Description
T	type of element

Constructors

Valve()

Creates already open Valve<T>

Declaration

public Valve()

Valve(SwitchMode)

Creates Valve<T> with inital mode

Declaration

public Valve(SwitchMode mode)

Parameters

Type	Name	Description
SwitchMode	mode	state of the valve at the startup of the flow

Properties

In

Declaration

public Inlet<T> In { get; }

Property Value

Type	Description
Inlet<T>

Out

Declaration

public Outlet<T> Out { get; }

Property Value

Type	Description
Outlet<T>

Shape

TBD

Declaration

public override FlowShape<T, T> Shape { get; }

Property Value

Type	Description
FlowShape<T, T>

Overrides

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.Shape

Methods

CreateLogicAndMaterializedValue(Attributes)

TBD

Declaration

public override ILogicAndMaterializedValue<Task<IValveSwitch>> CreateLogicAndMaterializedValue(Attributes inheritedAttributes)

Parameters

Type	Name	Description
Attributes	inheritedAttributes	TBD

Returns

Type	Description
ILogicAndMaterializedValue<Task<IValveSwitch>>	TBD

Overrides

GraphStageWithMaterializedValue<FlowShape<T, T>, Task<IValveSwitch>>.CreateLogicAndMaterializedValue(Attributes)

Implements

IGraphStageWithMaterializedValue<TShape, TMaterialized>

IGraph<TShape, TMaterialized>

IGraph<TShape>

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)