o

akka.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.

Source
KillSwitch.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KillSwitches
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract class KillableGraphStageLogic extends GraphStageLogic

Value Members

  1. def shared(name: String): SharedKillSwitch

    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.

    See also

    SharedKillSwitch

  2. def single[T]: [FlowShape[T, T], UniqueKillSwitch]

    Creates a new of FlowShape that materializes to an external switch that allows external completion of that unique materialization.

    Creates a new 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

  3. def singleBidi[T1, T2]: [BidiShape[T1, T1, T2, T2], UniqueKillSwitch]

    Creates a new of FlowShape that materializes to an external switch that allows external completion of that unique materialization.

    Creates a new 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