Search Results for

    Show / Hide Table of Contents

    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(int) 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<T>.MergePreferredShape, NotUsed>
    GraphStage<MergePreferred<T>.MergePreferredShape>
    MergePreferred<T>
    Implements
    IGraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>
    IGraph<MergePreferred<T>.MergePreferredShape, NotUsed>
    IGraph<MergePreferred<T>.MergePreferredShape>
    Inherited Members
    GraphStage<MergePreferred<T>.MergePreferredShape>.CreateLogicAndMaterializedValue(Attributes)
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.Shape
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.WithAttributes(Attributes)
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.CreateLogicAndMaterializedValue(Attributes)
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.Module
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.AddAttributes(Attributes)
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.Named(string)
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.Async()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    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

    | Edit this page View Source

    MergePreferred(int, bool)

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

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

    TBD

    bool eagerClose

    TBD

    Exceptions
    Type Condition
    ArgumentException

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

    Properties

    | Edit this page View Source

    InitialAttributes

    TBD

    Declaration
    protected override Attributes InitialAttributes { get; }
    Property Value
    Type Description
    Attributes
    Overrides
    GraphStageWithMaterializedValue<MergePreferred<T>.MergePreferredShape, NotUsed>.InitialAttributes
    | Edit this page View Source

    Out

    TBD

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

    Preferred

    TBD

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

    Shape

    TBD

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

    Methods

    | Edit this page 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
    GraphStage<MergePreferred<T>.MergePreferredShape>.CreateLogic(Attributes)
    | Edit this page View Source

    In(int)

    TBD

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

    TBD

    Returns
    Type Description
    Inlet<T>

    TBD

    Implements

    IGraphStageWithMaterializedValue<TShape, TMaterialized>
    IGraph<TShape, TMaterialized>
    IGraph<TShape>

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET