Search Results for

    Show / Hide Table of Contents

    Class UniqueKillSwitch

    A UniqueKillSwitch is always a result of a materialization (unlike SharedKillSwitch which is constructed before any materialization) and it always controls that graph and stage which yielded the materialized value.

    After calling Shutdown() the running instance of the IGraph<TShape> of FlowShape<TIn, TOut> that materialized to the UniqueKillSwitch will complete its downstream and cancel its upstream (unless if finished or failed already in which case the command is ignored). Subsequent invocations of completion commands will be ignored.

    After calling Abort(Exception) the running instance of the IGraph<TShape> of FlowShape<TIn, TOut> that materialized to the UniqueKillSwitch will fail its downstream with the provided exception and cancel its upstream (unless if finished or failed already in which case the command is ignored). Subsequent invocations of completion commands will be ignored.

    It is also possible to individually cancel, complete or fail upstream and downstream parts by calling the corresponding methods.

    Inheritance
    object
    UniqueKillSwitch
    Implements
    IKillSwitch
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Akka.Streams
    Assembly: Akka.Streams.dll
    Syntax
    public sealed class UniqueKillSwitch : IKillSwitch

    Methods

    | Edit this page View Source

    Abort(Exception)

    After calling Abort(Exception) the running instance of the IGraph<TShape> of FlowShape<TIn, TOut> that materialized to the UniqueKillSwitch will fail its downstream with the provided exception and cancel its upstream (unless if finished or failed already in which case the command is ignored). Subsequent invocations of completion commands will be ignored.

    Declaration
    public void Abort(Exception cause)
    Parameters
    Type Name Description
    Exception cause

    TBD

    | Edit this page View Source

    Shutdown()

    After calling Shutdown() the running instance of the IGraph<TShape> of FlowShape<TIn, TOut> that materialized to the UniqueKillSwitch will complete its downstream and cancel its upstream (unless if finished or failed already in which case the command is ignored). Subsequent invocations of completion commands will be ignored.

    Declaration
    public void Shutdown()
    | Edit this page View Source

    ToString()

    TBD

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    TBD

    Overrides
    object.ToString()

    Implements

    IKillSwitch

    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