Interface ITransformerLike<TIn, TOut>

TBD

Namespace: Akka.Streams
Assembly: Akka.Streams.dll
Syntax
public interface ITransformerLike<in TIn, out TOut>
Type Parameters
Name Description
TIn

TBD
TOut

TBD

Properties

| Improve this Doc 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
bool IsComplete { get; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

Cleanup()

Invoked after normal completion or failure.

Declaration
void Cleanup()
| Improve this Doc 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
void OnError(Exception cause)
Parameters
Type Name Description
Exception cause

TBD
| Improve this Doc View Source

OnNext(TIn)

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

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

TBD
Returns
Type Description
IEnumerable<TOut>
| Improve this Doc 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
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>

Extension Methods