 | FlowTIn, TOut, TMat Class |
A FlowTIn, TOut, TMat is a set of stream processing steps that has one open input and one open output.
Inheritance HierarchyNamespace: Akka.Streams.Dsl
Assembly: Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntaxpublic sealed class Flow<TIn, TOut, TMat> : IFlow<TOut, TMat>, IGraph<FlowShape<TIn, TOut>, TMat>, IGraph<FlowShape<TIn, TOut>>
Type Parameters
- TIn
- Type of the flow input.
- TOut
- Type of the flow output.
- TMat
- Type of value, flow graph may materialize to.
The FlowTIn, TOut, TMat type exposes the following members.
Properties
Methods| Name | Description | |
|---|---|---|
 | AddAttributes |
Add the given attributes to this FlowTIn, TOut, TMat.
Further calls to WithAttributes(Attributes)
will not remove these attributes. Note that this
operation has no effect on an empty Flow (because the attributes apply
only to the contained processing stages).
|
| Async |
Put an asynchronous boundary around this Source.
|
| ConcatMaterializedTMat2, TMat3 |
Concatenate the given to this , meaning that once this
Flow’s input is exhausted and all result elements have been generated,
the Source’s elements will be produced.
Note that the is materialized together with this Flow and just kept
from producing elements by asserting back-pressure until its time comes.
If this gets upstream error - no elements from the given will be pulled.
@see .
It is recommended to use the internally optimized LeftTLeft, TRight(TLeft, TRight) and RightTLeft, TRight(TLeft, TRight) combiners
where appropriate instead of manually writing functions that pass through one of the values.
|
| 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.) |
| JoinTMat2(IGraphFlowShapeTOut, TIn, TMat2) |
Join this FlowTIn, TOut, TMat to another FlowTIn, TOut, TMat, by cross connecting the inputs and outputs,
creating a IRunnableGraphTMat.
The materialized value of the combined FlowTIn, TOut, TMat will be the materialized
value of the current flow (ignoring the other Flow’s value), use
JoinMaterializedTMat2, TMat3(IGraphFlowShapeTOut, TIn, TMat2, FuncTMat, TMat2, TMat3) if a different strategy is needed.
|
| JoinTIn2, TOut2, TMat2(IGraphBidiShapeTOut, TOut2, TIn2, TIn, TMat2) |
TBD
|
| JoinMaterializedTMat2, TMat3(IGraphFlowShapeTOut, TIn, TMat2, FuncTMat, TMat2, TMat3) |
Join this FlowTIn, TOut, TMat to another FlowTIn, TOut, TMat, by cross connecting the inputs and outputs, creating a IRunnableGraphTMat
The combine function is used to compose the materialized values of this flow and that
Flow into the materialized value of the resulting Flow.
|
| JoinMaterializedTIn2, TOut2, TMat2, TMatRes(IGraphBidiShapeTOut, TOut2, TIn2, TIn, TMat2, FuncTMat, TMat2, TMatRes) |
TBD
|
| MapMaterializedValueTMat2 |
Transform the materialized value of this Flow, leaving all other properties as they were.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Named |
Add a name attribute to this Flow.
|
| RunWithTMat1, TMat2 |
Connect the SourceTOut, TMat to this FlowTIn, TOut, TMat and then connect it to the SinkTIn, TMat and run it.
The returned tuple contains the materialized values of the source and sink, e.g. the ISubscriber
of a AsSubscriberT and IPublisher of a PublisherTIn.
|
| ToTMat2 |
Connect this FlowTIn, TOut, TMat to a SinkTIn, TMat, concatenating the processing steps of both.
The materialized value of the combined SinkTIn, TMat will be the materialized
value of the current flow (ignoring the given Sink’s value), use
ToMaterializedTMat2, TMat3(IGraphSinkShapeTOut, TMat2, FuncTMat, TMat2, TMat3) if a different strategy is needed.
|
| ToMaterializedTMat2, TMat3 |
Connect this FlowTIn, TOut, TMat to a SinkTIn, TMat, concatenating the processing steps of both.
The combine function is used to compose the materialized values of this flow and that
Sink into the materialized value of the resulting Sink.
It is recommended to use the internally optimized LeftTLeft, TRight(TLeft, TRight) and RightTLeft, TRight(TLeft, TRight) combiners
where appropriate instead of manually writing functions that pass through one of the values.
|
| ToProcessor |
Converts this Flow to a IRunnableGraphTMat that materializes to a Reactive Streams IProcessor
which implements the operations encapsulated by this Flow. Every materialization results in a new Processor
instance, i.e. the returned IRunnableGraphTMat is reusable.
|
| ToString |
TBD
(Overrides ObjectToString.) |
| ViaT2, TMat2 |
Transform this FlowTIn, TOut, TMat by appending the given processing steps.
The materialized value of the combined FlowTIn, TOut, TMat will be the materialized
value of the current flow (ignoring the other flow’s value), use
ViaMaterializedTOut2, TMat2, TMat3(IGraphFlowShapeTOut, TOut2, TMat2, FuncTMat, TMat2, TMat3) if a different strategy is needed.
|
| ViaMaterializedTOut2, TMat2, TMat3 |
Transform this FlowTIn, TOut, TMat by appending the given processing steps.
The combine function is used to compose the materialized values of this flow and that
flow into the materialized value of the resulting Flow.
|
| WithAttributes |
Change the attributes of this FlowTIn, TOut, TMat to the given ones. Note that this
operation has no effect on an empty Flow (because the attributes apply
only to the contained processing stages).
|
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