SubSourceOutlet

org.apache.pekko.stream.stage.GraphStageLogic.SubSourceOutlet
class SubSourceOutlet[T](name: String)

INTERNAL API

This allows the dynamic creation of an Outlet for a GraphStage which is connected to a Source that is available for materialization (e.g. using the subFusingMaterializer). Completion, cancellation and failure of the parent operator is automatically delegated to instances of SubSourceOutlet to avoid resource leaks.

Even so it is good practice to use the timeout method to cancel this Outlet in case the corresponding Source is not materialized within a given time limit, see e.g. ActorMaterializerSettings.

To be thread safe this method 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
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def complete(): Unit

Complete this output port.

Complete this output port.

Attributes

Source
GraphStage.scala
def fail(ex: Throwable): Unit

Fail this output port.

Fail this output port.

Attributes

Source
GraphStage.scala

Returns true if this output port can be pushed.

Returns true if this output port can be pushed.

Attributes

Source
GraphStage.scala

Returns true if this output port is closed, but caution THIS WORKS DIFFERENTLY THAN THE NORMAL isClosed(out). Due to possibly asynchronous shutdown it may not return true immediately after complete() or fail() have returned.

Returns true if this output port is closed, but caution THIS WORKS DIFFERENTLY THAN THE NORMAL isClosed(out). Due to possibly asynchronous shutdown it may not return true immediately after complete() or fail() have returned.

Attributes

Source
GraphStage.scala
def push(elem: T): Unit

Push to this output port.

Push to this output port.

Attributes

Source
GraphStage.scala
def setHandler(handler: OutHandler): Unit

Set OutHandler for this dynamic output port; this needs to be done before the first substream callback can arrive.

Set OutHandler for this dynamic output port; this needs to be done before the first substream callback can arrive.

Attributes

Source
GraphStage.scala

Get the Source for this dynamic output port.

Get the Source for this dynamic output port.

Attributes

Source
GraphStage.scala

Set the source into timed-out mode if it has not yet been materialized.

Set the source into timed-out mode if it has not yet been materialized.

Attributes

Source
GraphStage.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
GraphStage.scala