RunnableGraph

org.apache.pekko.stream.javadsl.RunnableGraph
See theRunnableGraph companion object
abstract class RunnableGraph[+Mat] extends Graph[ClosedShape, Mat]

Java API

Flow with attached input and output, can be executed.

Attributes

Companion
object
Source
Flow.scala
Graph
Supertypes
trait Graph[ClosedShape, Mat]
class Object
trait Matchable
class Any

Members list

Type members

Inherited types

Type-level accessor for the shape parameter of this graph.

Type-level accessor for the shape parameter of this graph.

Attributes

Inherited from:
Graph
Source
Graph.scala

Value members

Abstract methods

Converts this Java DSL element to its Scala DSL counterpart.

Converts this Java DSL element to its Scala DSL counterpart.

Attributes

Source
Flow.scala
def mapMaterializedValue[Mat2](f: Function[Mat, Mat2]): RunnableGraph[Mat2]

Transform only the materialized value of this RunnableGraph, leaving all other properties as they were.

Transform only the materialized value of this RunnableGraph, leaving all other properties as they were.

Attributes

Source
Flow.scala
def run(materializer: Materializer): Mat

Run this flow using a special materializer and return the materialized values of the flow.

Run this flow using a special materializer and return the materialized values of the flow.

Prefer the method taking an ActorSystem unless you have special requirements.

Attributes

Source
Flow.scala
override def withAttributes(attr: Attributes): RunnableGraph[Mat]

Replace the attributes of this Flow with the given ones. If this Flow is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

Replace the attributes of this Flow with the given ones. If this Flow is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

Attributes

Definition Classes
Source
Flow.scala

Concrete methods

override def addAttributes(attr: Attributes): RunnableGraph[Mat]

Add the given attributes to this Graph. If the specific attribute was already present on this graph this means the added attribute will be more specific than the existing one. If this Source is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

Add the given attributes to this Graph. If the specific attribute was already present on this graph this means the added attribute will be more specific than the existing one. If this Source is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

Attributes

Definition Classes
Source
Flow.scala
override def named(name: String): RunnableGraph[Mat]

Specifies the name of the Graph. If the name is null or empty the name is ignored, i.e. Attributes.none is returned.

Specifies the name of the Graph. If the name is null or empty the name is ignored, i.e. Attributes.none is returned.

Attributes

Definition Classes
Source
Flow.scala
def run(systemProvider: ClassicActorSystemProvider): Mat

Run this flow and return the materialized values of the flow.

Run this flow and return the materialized values of the flow.

Uses the system materializer.

Attributes

Source
Flow.scala

Inherited methods

def async(dispatcher: String, inputBufferSize: Int): Graph[ClosedShape, Mat]

Put an asynchronous boundary around this Graph

Put an asynchronous boundary around this Graph

Value parameters

dispatcher

Run the graph on this dispatcher

inputBufferSize

Set the input buffer to this size for the graph

Attributes

Inherited from:
Graph
Source
Graph.scala
def async(dispatcher: String): Graph[ClosedShape, Mat]

Put an asynchronous boundary around this Graph

Put an asynchronous boundary around this Graph

Value parameters

dispatcher

Run the graph on this dispatcher

Attributes

Inherited from:
Graph
Source
Graph.scala
def async: Graph[ClosedShape, Mat]

Put an asynchronous boundary around this Graph

Put an asynchronous boundary around this Graph

Attributes

Inherited from:
Graph
Source
Graph.scala

Attributes

Inherited from:
Graph
Source
Graph.scala

The shape of a graph is all that is externally visible: its inlets and outlets.

The shape of a graph is all that is externally visible: its inlets and outlets.

Attributes

Inherited from:
Graph
Source
Graph.scala