root
API
Generated with
root/play/play.api/play.api.internal.libs.concurrent/CoordinatedShutdownSupport

CoordinatedShutdownSupport

play.api.internal.libs.concurrent.CoordinatedShutdownSupport
@InternalApi
object CoordinatedShutdownSupport

INTERNAL API: provides ways to call Pekko's CoordinatedShutdown.

This should not be necessary by user code and it is an internal API subject to change without following our deprecation policy.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def asyncShutdown(actorSystem: ActorSystem, reason: Reason): Future[Done]

Shuts down the provided ActorSystem asynchronously, starting from the configured phase.

Shuts down the provided ActorSystem asynchronously, starting from the configured phase.

Value parameters

actorSystem

the actor system to shut down

reason

the reason the actor system is shutting down

Attributes

Returns

a future that completes with Done when the actor system has fully shut down

def syncShutdown(actorSystem: ActorSystem, reason: Reason): Unit

Shuts down the provided ActorSystem synchronously, starting from the configured phase. This method blocks until the actor system has fully shut down, or the duration exceeds timeouts for all coordinated shutdown phases.

Shuts down the provided ActorSystem synchronously, starting from the configured phase. This method blocks until the actor system has fully shut down, or the duration exceeds timeouts for all coordinated shutdown phases.

Value parameters

actorSystem

the actor system to shut down

reason

the reason the actor system is shutting down

Attributes

Throws
InterruptedException

if the current thread is interrupted while waiting

TimeoutException

if after waiting for the specified time awaitable is still not ready

Generated with