Class MergePreferred<T>

Merge several streams, taking elements as they arrive from input streams (picking from preferred when several have elements ready).

A MergePreferred<T> has one Out port, one Preferred input port and 0 or more secondary In(Int32) ports.

Emits when one of the inputs has an element available, preferring a specified input if multiple have elements available

Backpressures when downstream backpressures

Completes when all upstreams complete (eagerComplete=false) or one upstream completes (eagerComplete=true)

Cancels when downstream cancels

Inheritance
Object
GraphStageWithMaterializedValue<MergePreferred.MergePreferredShape<>, NotUsed>
GraphStage<MergePreferred.MergePreferredShape<>>
MergePreferred<T>
Implements
Inherited Members
Namespace: Akka.Streams.Dsl
Assembly: Akka.Streams.dll
Syntax
public sealed class MergePreferred<T> : GraphStage<MergePreferred<T>.MergePreferredShape>, IGraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>, IGraph<MergePreferred<T>.MergePreferredShape, NotUsed>, IGraph<MergePreferred<T>.MergePreferredShape>
Type Parameters
Name Description
T

TBD

Constructors

| Improve this Doc View Source

MergePreferred(Int32, Boolean)

Initializes a new instance of the MergePreferred<T> class.

Declaration
public MergePreferred(int secondaryPorts, bool eagerClose = false)
Parameters
Type Name Description
Int32 secondaryPorts

TBD
Boolean eagerClose

TBD
Exceptions
Type Condition
ArgumentException

This exception is thrown when the specified secondaryPorts is less than one.

Properties

| Improve this Doc View Source

InitialAttributes

TBD

Declaration
protected override Attributes InitialAttributes { get; }
Property Value
Type Description
Attributes
Overrides
Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.Dsl.MergePreferred<T>.MergePreferredShape, Akka.NotUsed>.InitialAttributes
| Improve this Doc View Source

Out

TBD

Declaration
public Outlet<T> Out { get; }
Property Value
Type Description
Outlet<T>
| Improve this Doc View Source

Preferred

TBD

Declaration
public Inlet<T> Preferred { get; }
Property Value
Type Description
Inlet<T>
| Improve this Doc View Source

Shape

TBD

Declaration
public override MergePreferred<T>.MergePreferredShape Shape { get; }
Property Value
Type Description
MergePreferred.MergePreferredShape<>
Overrides
Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.Dsl.MergePreferred<T>.MergePreferredShape, Akka.NotUsed>.Shape

Methods

| Improve this Doc View Source

CreateLogic(Attributes)

TBD

Declaration
protected override GraphStageLogic CreateLogic(Attributes inheritedAttributes)
Parameters
Type Name Description
Attributes inheritedAttributes

TBD
Returns
Type Description
GraphStageLogic

TBD
Overrides
Akka.Streams.Stage.GraphStage<Akka.Streams.Dsl.MergePreferred<T>.MergePreferredShape>.CreateLogic(Akka.Streams.Attributes)
| Improve this Doc View Source

In(Int32)

TBD

Declaration
public Inlet<T> In(int id)
Parameters
Type Name Description
Int32 id

TBD
Returns
Type Description
Inlet<T>

TBD

Implements

Extension Methods