o

play.api.internal.libs.concurrent

CoordinatedShutdownSupport

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.

Annotations
@InternalApi()
Source
CoordinatedShutdownSupport.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CoordinatedShutdownSupport
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. 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.

    actorSystem

    the actor system to shut down

    reason

    the reason the actor system is shutting down

    returns

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

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

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

    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.

    actorSystem

    the actor system to shut down

    reason

    the reason the actor system is shutting down

    Annotations
    @throws(classOf[TimeoutException]) @throws(classOf[InterruptedException])
    Exceptions thrown

    InterruptedException if the current thread is interrupted while waiting

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