Apache Pekko
1.1.0
API
Generated with
Apache Pekko/org.apache.pekko.stream/org.apache.pekko.stream.stage

org.apache.pekko.stream.stage

package org.apache.pekko.stream.stage

Members list

Type members

Classlikes

abstract class AbstractGraphStageWithMaterializedValue[+S <: Shape, M] extends GraphStageWithMaterializedValue[S, M]

Java API: A GraphStage represents a reusable graph stream processing operator.

Java API: A GraphStage represents a reusable graph stream processing operator.

Extend this AbstractGraphStageWithMaterializedValue if you want to provide a materialized value, represented by the type parameter M. If your GraphStage does not need to provide a materialized value you can instead extend GraphStage which materializes a NotUsed value.

A GraphStage consists of a Shape which describes its input and output ports and a factory function that creates a GraphStageLogic which implements the processing logic that ties the ports together.

See also GraphStageWithMaterializedValue for Scala DSL for this operator.

Attributes

Source
GraphStage.scala
Supertypes
trait Graph[S, M]
class Object
trait Matchable
class Any
abstract class AbstractInHandler extends InHandler

Java API: callbacks for an input port where termination logic is predefined (completing when upstream completes, failing when upstream fails).

Java API: callbacks for an input port where termination logic is predefined (completing when upstream completes, failing when upstream fails).

Attributes

Source
GraphStage.scala
Supertypes
trait InHandler
class Object
trait Matchable
class Any
abstract class AbstractInOutHandler extends InHandler, OutHandler

Java API: callback combination for output and input ports where termination logic is predefined (completing when upstream completes, failing when upstream fails, completing when downstream cancels).

Java API: callback combination for output and input ports where termination logic is predefined (completing when upstream completes, failing when upstream fails, completing when downstream cancels).

Attributes

Source
GraphStage.scala
Supertypes
trait OutHandler
trait InHandler
class Object
trait Matchable
class Any
abstract class AbstractOutHandler extends OutHandler

Java API: callbacks for an output port where termination logic is predefined (completing when downstream cancels).

Java API: callbacks for an output port where termination logic is predefined (completing when downstream cancels).

Attributes

Source
GraphStage.scala
Supertypes
trait OutHandler
class Object
trait Matchable
class Any
trait AsyncCallback[T]

An asynchronous callback holder that is attached to a GraphStageLogic. Initializing AsyncCallback#invoke will eventually lead to the registered handler being called.

An asynchronous callback holder that is attached to a GraphStageLogic. Initializing AsyncCallback#invoke will eventually lead to the registered handler being called.

This holder has the same lifecycle as a stream and cannot be used before materialization is done.

Typical use cases are exchanging messages between stream and substreams or invoking from external world sending event to a stream

Attributes

Source
GraphStage.scala
Supertypes
class Object
trait Matchable
class Any
abstract class GraphStage[S <: Shape] extends GraphStageWithMaterializedValue[S, NotUsed]

A GraphStage represents a reusable graph stream processing operator.

A GraphStage represents a reusable graph stream processing operator.

A GraphStage consists of a Shape which describes its input and output ports and a factory function that creates a GraphStageLogic which implements the processing logic that ties the ports together.

Attributes

Source
GraphStage.scala
Supertypes
trait Graph[S, NotUsed]
class Object
trait Matchable
class Any
Known subtypes
class Balance[T]
class Broadcast[T]
class Concat[T]
class Interleave[T]
class Merge[T]
class MergeLatest[T, M]
class MergePreferred[T]
class MergePrioritized[T]
class MergeSequence[T]
class MergeSorted[T]
class Partition[T]
class UnzipWith10[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10]
class UnzipWith11[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11]
class UnzipWith12[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12]
class UnzipWith13[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13]
class UnzipWith14[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14]
class UnzipWith15[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15]
class UnzipWith16[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16]
class UnzipWith17[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17]
class UnzipWith18[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18]
class UnzipWith19[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19]
class UnzipWith2[In, A1, A2]
class Unzip[A, B]
class UnzipWith20[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20]
class UnzipWith21[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21]
class UnzipWith22[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22]
class UnzipWith3[In, A1, A2, A3]
class UnzipWith4[In, A1, A2, A3, A4]
class UnzipWith5[In, A1, A2, A3, A4, A5]
class UnzipWith6[In, A1, A2, A3, A4, A5, A6]
class UnzipWith7[In, A1, A2, A3, A4, A5, A6, A7]
class UnzipWith8[In, A1, A2, A3, A4, A5, A6, A7, A8]
class UnzipWith9[In, A1, A2, A3, A4, A5, A6, A7, A8, A9]
class ZipLatestWith10[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, O]
class ZipLatestWith11[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, O]
class ZipLatestWith12[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, O]
class ZipLatestWith13[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, O]
class ZipLatestWith14[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, O]
class ZipLatestWith15[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, O]
class ZipLatestWith16[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, O]
class ZipLatestWith17[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, O]
class ZipLatestWith18[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, O]
class ZipLatestWith19[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, O]
class ZipLatestWith2[A1, A2, O]
class ZipLatest[A, B]
class ZipLatestWith20[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, O]
class ZipLatestWith21[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, O]
class ZipLatestWith22[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22, O]
class ZipLatestWith3[A1, A2, A3, O]
class ZipLatestWith4[A1, A2, A3, A4, O]
class ZipLatestWith5[A1, A2, A3, A4, A5, O]
class ZipLatestWith6[A1, A2, A3, A4, A5, A6, O]
class ZipLatestWith7[A1, A2, A3, A4, A5, A6, A7, O]
class ZipLatestWith8[A1, A2, A3, A4, A5, A6, A7, A8, O]
class ZipLatestWith9[A1, A2, A3, A4, A5, A6, A7, A8, A9, O]
class ZipWith10[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, O]
class ZipWith11[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, O]
class ZipWith12[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, O]
class ZipWith13[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, O]
class ZipWith14[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, O]
class ZipWith15[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, O]
class ZipWith16[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, O]
class ZipWith17[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, O]
class ZipWith18[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, O]
class ZipWith19[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, O]
class ZipWith2[A1, A2, O]
class Zip[A, B]
class ZipWith20[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, O]
class ZipWith21[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, O]
class ZipWith22[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22, O]
class ZipWith3[A1, A2, A3, O]
class ZipWith4[A1, A2, A3, A4, O]
class ZipWith5[A1, A2, A3, A4, A5, O]
class ZipWith6[A1, A2, A3, A4, A5, A6, O]
class ZipWith7[A1, A2, A3, A4, A5, A6, A7, O]
class ZipWith8[A1, A2, A3, A4, A5, A6, A7, A8, O]
class ZipWith9[A1, A2, A3, A4, A5, A6, A7, A8, A9, O]
class ZipWithN[A, O]
class ZipN[A]
Show all
object GraphStageLogic

Attributes

Companion
class
Source
GraphStage.scala
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class GraphStageLogic

Represents the processing logic behind a GraphStage. Roughly speaking, a subclass of GraphStageLogic is a collection of the following parts:

Represents the processing logic behind a GraphStage. Roughly speaking, a subclass of GraphStageLogic is a collection of the following parts:

  • A set of InHandler and OutHandler instances and their assignments to the Inlets and Outlets of the enclosing GraphStage
  • Possible mutable state, accessible from the InHandler and OutHandler callbacks, but not from anywhere else (as such access would not be thread-safe)
  • The lifecycle hooks preStart and postStop
  • Methods for performing stream processing actions, like pulling or pushing elements

The operator logic is completed once all its input and output ports have been closed. This can be changed by setting setKeepGoing to true.

The postStop lifecycle hook on the logic itself is called once all ports are closed. This is the only tear down callback that is guaranteed to happen, if the actor system or the materializer is terminated the handlers may never see any callbacks to onUpstreamFailure, onUpstreamFinish or onDownstreamFinish. Therefore operator resource cleanup should always be done in postStop.

Attributes

Companion
object
Source
GraphStage.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
abstract class GraphStageLogicWithLogging(_shape: Shape) extends GraphStageLogic, StageLogging

Java API: GraphStageLogic with StageLogging.

Java API: GraphStageLogic with StageLogging.

Attributes

Source
GraphStage.scala
Supertypes
trait StageLogging
class Object
trait Matchable
class Any
abstract class GraphStageWithMaterializedValue[+S <: Shape, +M] extends Graph[S, M]

Scala API: A GraphStage represents a reusable graph stream processing operator.

Scala API: A GraphStage represents a reusable graph stream processing operator.

Extend this GraphStageWithMaterializedValue if you want to provide a materialized value, represented by the type parameter M. If your GraphStage does not need to provide a materialized value you can instead extende GraphStage which materializes a NotUsed value.

A GraphStage consists of a Shape which describes its input and output ports and a factory function that creates a GraphStageLogic which implements the processing logic that ties the ports together.

See also AbstractGraphStageWithMaterializedValue for Java DSL for this operator.

Attributes

Source
GraphStage.scala
Supertypes
trait Graph[S, M]
class Object
trait Matchable
class Any
Known subtypes
class GraphStage[S]
class Balance[T]
class Broadcast[T]
class Concat[T]
class Interleave[T]
class Merge[T]
class MergeLatest[T, M]
class MergePreferred[T]
class MergePrioritized[T]
class MergeSequence[T]
class MergeSorted[T]
class Partition[T]
class UnzipWith10[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10]
class UnzipWith11[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11]
class UnzipWith12[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12]
class UnzipWith13[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13]
class UnzipWith14[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14]
class UnzipWith15[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15]
class UnzipWith16[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16]
class UnzipWith17[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17]
class UnzipWith18[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18]
class UnzipWith19[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19]
class UnzipWith2[In, A1, A2]
class Unzip[A, B]
class UnzipWith20[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20]
class UnzipWith21[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21]
class UnzipWith22[In, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22]
class UnzipWith3[In, A1, A2, A3]
class UnzipWith4[In, A1, A2, A3, A4]
class UnzipWith5[In, A1, A2, A3, A4, A5]
class UnzipWith6[In, A1, A2, A3, A4, A5, A6]
class UnzipWith7[In, A1, A2, A3, A4, A5, A6, A7]
class UnzipWith8[In, A1, A2, A3, A4, A5, A6, A7, A8]
class UnzipWith9[In, A1, A2, A3, A4, A5, A6, A7, A8, A9]
class ZipLatestWith10[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, O]
class ZipLatestWith11[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, O]
class ZipLatestWith12[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, O]
class ZipLatestWith13[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, O]
class ZipLatestWith14[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, O]
class ZipLatestWith15[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, O]
class ZipLatestWith16[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, O]
class ZipLatestWith17[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, O]
class ZipLatestWith18[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, O]
class ZipLatestWith19[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, O]
class ZipLatestWith2[A1, A2, O]
class ZipLatest[A, B]
class ZipLatestWith20[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, O]
class ZipLatestWith21[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, O]
class ZipLatestWith22[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22, O]
class ZipLatestWith3[A1, A2, A3, O]
class ZipLatestWith4[A1, A2, A3, A4, O]
class ZipLatestWith5[A1, A2, A3, A4, A5, O]
class ZipLatestWith6[A1, A2, A3, A4, A5, A6, O]
class ZipLatestWith7[A1, A2, A3, A4, A5, A6, A7, O]
class ZipLatestWith8[A1, A2, A3, A4, A5, A6, A7, A8, O]
class ZipLatestWith9[A1, A2, A3, A4, A5, A6, A7, A8, A9, O]
class ZipWith10[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, O]
class ZipWith11[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, O]
class ZipWith12[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, O]
class ZipWith13[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, O]
class ZipWith14[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, O]
class ZipWith15[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, O]
class ZipWith16[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, O]
class ZipWith17[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, O]
class ZipWith18[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, O]
class ZipWith19[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, O]
class ZipWith2[A1, A2, O]
class Zip[A, B]
class ZipWith20[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, O]
class ZipWith21[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, O]
class ZipWith22[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22, O]
class ZipWith3[A1, A2, A3, O]
class ZipWith4[A1, A2, A3, A4, O]
class ZipWith5[A1, A2, A3, A4, A5, O]
class ZipWith6[A1, A2, A3, A4, A5, A6, O]
class ZipWith7[A1, A2, A3, A4, A5, A6, A7, O]
class ZipWith8[A1, A2, A3, A4, A5, A6, A7, A8, O]
class ZipWith9[A1, A2, A3, A4, A5, A6, A7, A8, A9, O]
class ZipWithN[A, O]
class ZipN[A]
Show all
trait InHandler

Collection of callbacks for an input port of a GraphStage

Collection of callbacks for an input port of a GraphStage

Attributes

Source
GraphStage.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
trait OutHandler

Collection of callbacks for an output port of a GraphStage

Collection of callbacks for an output port of a GraphStage

Attributes

Source
GraphStage.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait StageLogging

Simple way to obtain a pekko.event.LoggingAdapter when used together with an pekko.stream.Materializer. If used with a different materializer pekko.event.NoLogging will be returned.

Simple way to obtain a pekko.event.LoggingAdapter when used together with an pekko.stream.Materializer. If used with a different materializer pekko.event.NoLogging will be returned.

Make sure to only access log from GraphStage callbacks (such as pull, push or the async-callback).

Note, abiding to pekko.stream.ActorAttributes.logLevels has to be done manually, the logger itself is configured based on the logSource provided to it. Also, the log itself would not know if you're calling it from a "on element" context or not, which is why these decisions have to be handled by the operator itself.

Attributes

Source
StageLogging.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Self type
abstract class TimerGraphStageLogic(_shape: Shape) extends GraphStageLogic

Provides timer related facilities to a GraphStageLogic.

Provides timer related facilities to a GraphStageLogic.

To be thread safe the methods of this class must only be called from either the constructor of the graph operator during materialization or one of the methods invoked by the graph operator machinery, such as onPush and onPull.

Attributes

Source
GraphStage.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
abstract class TimerGraphStageLogicWithLogging(_shape: Shape) extends TimerGraphStageLogic, StageLogging

Java API: TimerGraphStageLogic with StageLogging.

Java API: TimerGraphStageLogic with StageLogging.

Attributes

Source
GraphStage.scala
Supertypes
trait StageLogging
class Object
trait Matchable
class Any
Show all
Generated with