KillSwitches

org.apache.pekko.stream.KillSwitches
object KillSwitches

Creates shared or single kill switches which can be used to control completion of graphs from the outside.

  • The factory shared() returns a SharedKillSwitch which provides a Graph of FlowShape that can be used in arbitrary number of graphs and materializations. The switch simultaneously controls completion in all of those graphs.
  • The factory single() returns a Graph of FlowShape that materializes to a UniqueKillSwitch which is always unique to that materialized Flow itself.

Creates a SharedKillSwitch that can be used to externally control the completion of various streams.

Attributes

Source
KillSwitch.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

abstract class KillableGraphStageLogic(val terminationSignal: Future[Done], _shape: Shape) extends GraphStageLogic

Attributes

Source
KillSwitch.scala
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

Creates a new SharedKillSwitch with the given name that can be used to control the completion of multiple streams from the outside simultaneously.

Creates a new SharedKillSwitch with the given name that can be used to control the completion of multiple streams from the outside simultaneously.

Attributes

See also

SharedKillSwitch

Source
KillSwitch.scala

Creates a new Graph of FlowShape that materializes to an external switch that allows external completion of that unique materialization. Different materializations result in different, independent switches.

Creates a new Graph of FlowShape that materializes to an external switch that allows external completion of that unique materialization. Different materializations result in different, independent switches.

For a Bidi version see KillSwitch#singleBidi

Attributes

Source
KillSwitch.scala
def singleBidi[T1, T2]: Graph[BidiShape[T1, T1, T2, T2], UniqueKillSwitch]

Creates a new Graph of FlowShape that materializes to an external switch that allows external completion of that unique materialization. Different materializations result in different, independent switches.

Creates a new Graph of FlowShape that materializes to an external switch that allows external completion of that unique materialization. Different materializations result in different, independent switches.

For a Flow version see KillSwitch#single

Attributes

Source
KillSwitch.scala