Package akka.stream
Class SharedKillSwitch
- java.lang.Object
-
- akka.stream.SharedKillSwitch
-
- All Implemented Interfaces:
KillSwitch
public final class SharedKillSwitch extends java.lang.Object implements KillSwitch
After callingshutdown()
all materialized, running instances of allGraph
s provided by theSharedKillSwitch
will complete their downstreams and cancel their upstreams (unless if finished or failed already in which case the command is ignored). Subsequent invocations ofshutdown()
andSharedKillSwitch#abort()
will be ignored.
-
-
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 callingSharedKillSwitch#abort()
all materialized, running instances of allGraph
s provided by theSharedKillSwitch
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 thisSharedKillSwitch
instance.java.lang.String
name()
void
shutdown()
java.lang.String
toString()
-
-
-
Method Detail
-
abort
public void abort(java.lang.Throwable reason)
After callingSharedKillSwitch#abort()
all materialized, running instances of allGraph
s provided by theSharedKillSwitch
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 ofshutdown()
andSharedKillSwitch#abort()
will be ignored.These provided
Graph
s materialize to their owning switch. This might make certain integrations simpler than passing around the switch instance itself.- Specified by:
abort
in interfaceKillSwitch
- Parameters:
reason
- The exception to be used for failing the linkedGraph
s
-
flow
public <T> Graph<FlowShape<T,T>,SharedKillSwitch> flow()
Returns a typed Flow of a requested type that will be linked to thisSharedKillSwitch
instance. By invokingshutdown()
orSharedKillSwitch#abort()
all running instances of all providedGraph
s 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()
- Specified by:
shutdown
in interfaceKillSwitch
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-