Package akka.stream

Class SharedKillSwitch

  • All Implemented Interfaces:
    KillSwitch

    public final class SharedKillSwitch
    extends java.lang.Object
    implements KillSwitch
    A SharedKillSwitch is a provider for Graphs of FlowShape that can be completed or failed from the outside. A Graph returned by the switch can be materialized arbitrary amount of times: every newly materialized Graph belongs to the switch from which it was acquired. Multiple SharedKillSwitch instances are isolated from each other, shutting down or aborting on instance does not affect the Graphs provided by another instance.

    After calling shutdown() all materialized, running instances of all Graphs provided by the SharedKillSwitch will complete their downstreams and cancel their upstreams (unless if finished or failed already in which case the command is ignored). Subsequent invocations of shutdown() and SharedKillSwitch#abort() will be ignored.

    After calling SharedKillSwitch#abort() all materialized, running instances of all Graphs provided by the SharedKillSwitch will fail their downstreams with the provided exception and cancel their upstreams (unless it finished or failed already in which case the command is ignored). Subsequent invocations of shutdown() and SharedKillSwitch#abort() will be ignored.

    The Graphs provided by the SharedKillSwitch do not modify the passed through elements in any way or affect backpressure in the stream. All provided Graphs provide the parent SharedKillSwitch as materialized value.

    This class is thread-safe, the instance can be passed safely among threads and its methods may be invoked concurrently.

    • Constructor Summary

      Constructors 
      Constructor Description
      SharedKillSwitch​(java.lang.String name)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abort​(java.lang.Throwable reason)
      After calling SharedKillSwitch#abort() all materialized, running instances of all Graphs provided by the SharedKillSwitch will fail their downstreams with the provided exception and cancel their upstreams (unless it finished or failed already in which case the command is ignored).
      <T> Graph<FlowShape<T,​T>,​SharedKillSwitch> flow()
      Returns a typed Flow of a requested type that will be linked to this SharedKillSwitch instance.
      java.lang.String name()  
      void shutdown()
      After calling shutdown() all materialized, running instances of all Graphs provided by the SharedKillSwitch will complete their downstreams and cancel their upstreams (unless if finished or failed already in which case the command is ignored).
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • SharedKillSwitch

        public SharedKillSwitch​(java.lang.String name)
    • Method Detail

      • abort

        public void abort​(java.lang.Throwable reason)
        After calling SharedKillSwitch#abort() all materialized, running instances of all Graphs provided by the SharedKillSwitch will fail their downstreams with the provided exception and cancel their upstreams (unless it finished or failed already in which case the command is ignored). Subsequent invocations of shutdown() and SharedKillSwitch#abort() will be ignored.

        These provided Graphs materialize to their owning switch. This might make certain integrations simpler than passing around the switch instance itself.

        Specified by:
        abort in interface KillSwitch
        Parameters:
        reason - The exception to be used for failing the linked Graphs
      • flow

        public <T> Graph<FlowShape<T,​T>,​SharedKillSwitch> flow()
        Returns a typed Flow of a requested type that will be linked to this SharedKillSwitch instance. By invoking shutdown() or SharedKillSwitch#abort() all running instances of all provided Graphs by this switch will be stopped normally or failed.

        Returns:
        A reusable Graph that is linked with the switch. The materialized value provided is this switch itself.
      • name

        public java.lang.String name()
      • shutdown

        public void shutdown()
        After calling shutdown() all materialized, running instances of all Graphs provided by the SharedKillSwitch will complete their downstreams and cancel their upstreams (unless if finished or failed already in which case the command is ignored). Subsequent invocations of shutdown() and SharedKillSwitch#abort() will be ignored.
        Specified by:
        shutdown in interface KillSwitch
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object