Search Results for

    Show / Hide Table of Contents

    Class TransformerLikeBase<TIn, TOut>

    TBD

    Inheritance
    object
    TransformerLikeBase<TIn, TOut>
    Implements
    ITransformerLike<TIn, TOut>
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Akka.Streams
    Assembly: Akka.Streams.dll
    Syntax
    public abstract class TransformerLikeBase<TIn, TOut> : ITransformerLike<TIn, TOut>
    Type Parameters
    Name Description
    TIn

    TBD

    TOut

    TBD

    Properties

    | Edit this page View Source

    IsComplete

    Invoked after handing off the elements produced from one input element to the downstream subscribers to determine whether to end stream processing at this point; in that case the upstream subscription is canceled.

    Declaration
    public virtual bool IsComplete { get; }
    Property Value
    Type Description
    bool

    Methods

    | Edit this page View Source

    Cleanup()

    Invoked after normal completion or failure.

    Declaration
    public virtual void Cleanup()
    | Edit this page View Source

    OnError(Exception)

    Invoked when failure is signaled from upstream. If this method throws an exception, then onError is immediately propagated downstream. If this method completes normally then OnTermination(Exception) is invoked as a final step, passing the original cause.

    Declaration
    public virtual void OnError(Exception cause)
    Parameters
    Type Name Description
    Exception cause

    TBD

    | Edit this page View Source

    OnNext(TIn)

    Invoked for each element to produce a (possibly empty) sequence of output elements.

    Declaration
    public abstract IEnumerable<TOut> OnNext(TIn element)
    Parameters
    Type Name Description
    TIn element

    TBD

    Returns
    Type Description
    IEnumerable<TOut>
    | Edit this page View Source

    OnTermination(Exception)

    Invoked before the Transformer terminates (either normal completion or after an onError) to produce a (possibly empty) sequence of elements in response to the end-of-stream event.

    This method is only called if OnError(Exception) does not throw an exception. The default implementation of OnError(Exception) throws the received cause forcing the failure to propagate downstream immediately.

    Declaration
    public virtual IEnumerable<TOut> OnTermination(Exception cause)
    Parameters
    Type Name Description
    Exception cause

    Contains a non-empty option with the error causing the termination or an empty option if the Transformer was completed normally

    Returns
    Type Description
    IEnumerable<TOut>

    Implements

    ITransformerLike<TIn, TOut>

    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