akka.stream

Interface KillSwitch

All Known Implementing Classes:

SharedKillSwitch, UniqueKillSwitch

public interface KillSwitch

A KillSwitch allows completion of Graphs from the outside by completing Graphs of FlowShape linked to the switch. Depending on whether the KillSwitch is a UniqueKillSwitch or a SharedKillSwitch one or multiple streams might be linked with the switch. For details see the documentation of the concrete subclasses of this interface.

Method Summary

Modifier and Type	Method and Description
void	abort(java.lang.Throwable ex) After calling KillSwitch#abort() the linked Graphs of FlowShape are failed.
void	shutdown() After calling shutdown() the linked Graphs of FlowShape are completed normally.

Method Detail

shutdown

void shutdown()

After calling shutdown() the linked Graphs of FlowShape are completed normally.

abort

void abort(java.lang.Throwable ex)

After calling KillSwitch#abort() the linked Graphs of FlowShape are failed.

Parameters:

ex - (undocumented)