Package akka.stream

Class KillSwitches


  • public class KillSwitches
    extends java.lang.Object
    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.

    • Constructor Detail

      • KillSwitches

        public KillSwitches()
    • Method Detail

      • shared

        public static SharedKillSwitch shared​(java.lang.String name)
        Creates a new SharedKillSwitch with the given name that can be used to control the completion of multiple streams from the outside simultaneously.

        Parameters:
        name - (undocumented)
        Returns:
        (undocumented)
        See Also:
        SharedKillSwitch
      • single

        public static <T> Graph<FlowShape<T,​T>,​UniqueKillSwitch> single()
        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

        Returns:
        (undocumented)
      • singleBidi

        public static <T1,​T2> Graph<BidiShape<T1,​T1,​T2,​T2>,​UniqueKillSwitch> singleBidi()
        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

        Returns:
        (undocumented)