< Back

Packages

package root

Definition Classes
root
package akka

Definition Classes
root
package stream

Definition Classes
akka
package actor

Definition Classes
stream
package extra

Definition Classes
stream
package javadsl

Definition Classes
stream
package scaladsl
Scala API: The flow DSL allows the formulation of stream transformations based on some input.
Scala API: The flow DSL allows the formulation of stream transformations based on some input. The starting point is called Source and can be a collection, an iterator, a block of code which is evaluated repeatedly or a org.reactivestreams.Publisher. A flow with an attached input and open output is also a Source.
A flow may also be defined without an attached input or output and that is then a Flow. The Flow can be connected to the Source later by using Source#via with the flow as argument, and it remains a Source.
Transformations can be appended to Source and Flow with the operations defined in FlowOps. Each DSL element produces a new flow that can be further transformed, building up a description of the complete transformation pipeline.
The termination point of a flow is called Sink and can for example be a Future or org.reactivestreams.Subscriber. A flow with an attached output and open input is also a Sink.
If a flow has both an attached input and an attached output it becomes a RunnableGraph. In order to execute this pipeline the flow must be materialized by calling RunnableGraph#run on it.
You can create your Source, Flow and Sink in any order and then wire them together before they are materialized by connecting them using Flow#via and Flow#to, or connecting them into a GraphDSL with fan-in and fan-out elements.
See Reactive Streams for details on org.reactivestreams.Publisher and org.reactivestreams.Subscriber.
It should be noted that the streams modeled by this library are “hot”, meaning that they asynchronously flow through a series of processors without detailed control by the user. In particular it is not predictable how many elements a given transformation step might buffer before handing elements downstream, which means that transformation functions may be invoked more often than for corresponding transformations on strict collections like List. *An important consequence* is that elements that were produced into a stream may be discarded by later processors, e.g. when using the #take operator.
By default every operation is executed within its own akka.actor.Actor to enable full pipelining of the chained set of computations. This behavior is determined by the akka.stream.Materializer which is required by those methods that materialize the Flow into a series of org.reactivestreams.Processor instances. The returned reactive stream is fully started and active.

Definition Classes
stream
package stage

Definition Classes
stream
package testkit

Definition Classes
stream
package typed

Definition Classes
stream
AbruptIOTerminationException
AbruptStageTerminationException
AbruptTerminationException
AbstractShape
ActorAttributes
ActorMaterializer
ActorMaterializerSettings
AmorphousShape
Attributes
BidiShape
BindFailedException
BufferOverflowException
Client
ClosedShape
ConnectionException
DelayOverflowStrategy
EagerClose
FanInShape
FanInShape10
FanInShape11
FanInShape12
FanInShape13
FanInShape14
FanInShape15
FanInShape16
FanInShape17
FanInShape18
FanInShape19
FanInShape1N
FanInShape2
FanInShape20
FanInShape21
FanInShape22
FanInShape3
FanInShape4
FanInShape5
FanInShape6
FanInShape7
FanInShape8
FanInShape9
FanOutShape
FanOutShape10
FanOutShape11
FanOutShape12
FanOutShape13
FanOutShape14
FanOutShape15
FanOutShape16
FanOutShape17
FanOutShape18
FanOutShape19
FanOutShape2
FanOutShape20
FanOutShape21
FanOutShape22
FanOutShape3
FanOutShape4
FanOutShape5
FanOutShape6
FanOutShape7
FanOutShape8
FanOutShape9
FlowMonitor
FlowMonitorState
FlowShape
Graph
IOResult
IOSettings
IgnoreBoth
IgnoreCancel
IgnoreComplete
InPort
Inlet
InvalidPartnerActorException
InvalidSequenceNumberException
KillSwitch
KillSwitches
MaterializationException
Materializer
MaterializerLoggingProvider
OutPort
Outlet
OverflowStrategy
QueueOfferResult
RateExceededException
RemoteStreamRefActorTerminatedException
Server
Shape
SharedKillSwitch
SinkRef
SinkShape
SourceRef
SourceShape
StreamDetachedException
StreamLimitReachedException
StreamRefAttributes
StreamRefMessages
StreamRefSettings
StreamRefSubscriptionTimeoutException
StreamSubscriptionTimeoutSettings
StreamSubscriptionTimeoutTerminationMode
StreamTcpException
SubstreamCancelStrategy
Supervision
TLSClientAuth
TLSClosing
TLSProtocol
TLSRole
TargetRefNotInitializedYetException
ThrottleMode
TooManySubstreamsOpenException
UniformFanInShape
UniformFanOutShape
UniqueKillSwitch
WatchedActorTerminatedException

o

StreamRefAttributes

object StreamRefAttributes

Attributes for stream refs (akka.stream.SourceRef and akka.stream.SinkRef). Note that more attributes defined in Attributes and ActorAttributes.

Source: Attributes.scala

Linear Supertypes

Ordering

Alphabetic
By Inheritance

Inherited

StreamRefAttributes
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

sealed trait StreamRefAttribute extends Attribute
Attributes specific to stream refs.
final case class SubscriptionTimeout(timeout: FiniteDuration) extends StreamRefAttribute with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
def subscriptionTimeout(timeout: FiniteDuration): Attributes
Specifies the subscription timeout within which the remote side MUST subscribe to the handed out stream reference.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )