 | AbstractStageTIn, TOut Class |
Note: This API is now obsolete.
Inheritance HierarchyAkka.Streams.StageAbstractStageTIn, TOut
Akka.Streams.StageAbstractStageTIn, TOut, TPushDirective, TPullDirective, TContext
Namespace: Akka.Streams.Stage
Assembly: Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax[ObsoleteAttribute("Please use GraphStage instead. [1.1.2]")] public abstract class AbstractStage<TIn, TOut> : IStage<TIn, TOut>
Type Parameters
- TIn
- TBD
- TOut
- TBD
The AbstractStageTIn, TOut type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AbstractStageTIn, TOut | Initializes a new instance of the AbstractStageTIn, TOut class |
Properties| Name | Description | |
|---|---|---|
 | IsDetached |
TBD
|
Methods| Name | Description | |
|---|---|---|
 | Decide |
If an exception is thrown from OnPush(TIn, IContext) this method is invoked to decide how
to handle the exception. By default this method returns Stop.
If an exception is thrown from OnPull(IContext) the stream will always be completed with failure, because it is not always possible to recover from that state. In concrete stages it is of course possible to use ordinary try-catch-recover inside OnPull(IContext) when it is know how to recover from such exceptions. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDownstreamFinish |
This method is called when downstream has cancelled.
By default the cancel signal is immediately propagated with Finish.
|
| OnPull |
This method is called when there is demand from downstream, i.e. you are allowed to push one element
downstreams with Push(Object), or request elements from upstreams with Pull |
| OnPush | This method is called when an element from upstream is available and there is demand from downstream, i.e. in OnPush(TIn, IContext) you are allowed to call Push(Object) to emit one element downstreams, or you can absorb the element by calling Pull. Note that you can only emit zero or one element downstream from OnPull(IContext). To emit more than one element you have to push the remaining elements from OnPull(IContext), one-by-one. OnPush(TIn, IContext) is not called again until OnPull(IContext) has requested more elements with Pull. |
| OnUpstreamFailure | OnUpstreamFailure(Exception, IContext) is called when upstream has signaled that the stream is completed with failure. It is not called if OnPull(IContext) or OnPush(TIn, IContext) of the stage itself throws an exception. Note that elements that were emitted by upstream before the failure happened might not have been received by this stage when OnUpstreamFailure(Exception, IContext) is called, i.e. failures are not backpressured and might be propagated as soon as possible. Here you cannot call Push(Object), because there might not be any demand from downstream. To emit additional elements before terminating you can use AbsorbTermination and push final elements from OnPull(IContext). The stage will then be in finishing state, which can be checked with IsFinishing. |
| OnUpstreamFinish | This method is called when upstream has signaled that the stream is successfully completed. Here you cannot call Push(Object), because there might not be any demand from downstream. To emit additional elements before terminating you can use AbsorbTermination and push final elements from OnPull(IContext). The stage will then be in finishing state, which can be checked with IsFinishing. By default the finish signal is immediately propagated with Finish. IMPORTANT NOTICE: this signal is not back-pressured, it might arrive from upstream even though the last action by this stage was a "push". |
| PostStop |
User overridable callback.
Is called after the Stages final action is performed.
Empty default implementation.
|
| PreStart |
User overridable callback.
It is called before any other method defined on the IStageTIn, TOut. Empty default implementation. |
| Restart |
Used to create a fresh instance of the stage after an error resulting in a Restart
directive. By default it will return the same instance untouched, so you must override it
if there are any state that should be cleared before restarting, e.g. by returning a new instance.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsInstanceOfT |
TBD
(Defined by Extensions.) |
| Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) |
| MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |
See Also