Packages

object AkkaCluster extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AkkaCluster
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def managedResource[F[_]](createActorSystem: => ActorSystem[_], catsEffectReleaseTimeout: Duration = 5.seconds, akkaReleaseTimeout: Duration = 5.seconds)(implicit arg0: Async[F], arg1: Logger[F]): Resource[F, AkkaCluster[F]]

    Create a resource that manages the lifetime of an Akka actor system with cluster sharding extension.

    Create a resource that manages the lifetime of an Akka actor system with cluster sharding extension. The actor system is created when the resource is acquired and shutdown when the resource is released.

    createActorSystem

    Actor system creator. It is recommended to use the IO execution context (IO.executionContext) for the actor system, as it supports Akka operation and it's simpler to have a single application execution context

    catsEffectReleaseTimeout

    Maximum amount of time Akka coordinated shutdown is allowed to wait for cats-effect to finish, typically when Akka initiates shutdown following a SBR decision. This value should not be higher than the actual timeout for before-service-unbind phase of Akka coordinated shutdown. See Akka coordinated shutdown documentation to learn how to configure the timeouts of individual phases. Default (5 seconds) is the same as the default-phase-timeout of Akka coordinated shutdown.

    akkaReleaseTimeout

    Maximum amount of time to wait for the actor system to terminate during resource release (5 seconds by default).

    See also

    Some elements borrowed from https://alexn.org/blog/2023/04/17/integrating-akka-with-cats-effect-3/

  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped