Class/Object

com.lightbend.lagom.internal.persistence.cluster

ClusterDistribution

Related Docs: object ClusterDistribution | package cluster

Permalink

class ClusterDistribution extends Extension

Distributes a static list of entities evenly over a cluster, ensuring that they are all continuously active.

This uses cluster sharding underneath, using a scheduled tick sent to each entity as a mechanism to ensure they are active.

Entities are cluster sharding entities, so they can discover their ID by inspecting their name. Additionally, entities should handle the com.lightbend.lagom.internal.persistence.cluster.ClusterDistribution.EnsureActive message, typically they can do nothing in response to it.

Source
ClusterDistribution.scala
Linear Supertypes
Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterDistribution
  2. Extension
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClusterDistribution(system: ExtendedActorSystem)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to any2stringadd[ClusterDistribution] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ClusterDistribution, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to ArrowAssoc[ClusterDistribution] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (ClusterDistribution) ⇒ Boolean, msg: ⇒ Any): ClusterDistribution

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to Ensuring[ClusterDistribution] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (ClusterDistribution) ⇒ Boolean): ClusterDistribution

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to Ensuring[ClusterDistribution] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ClusterDistribution

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to Ensuring[ClusterDistribution] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): ClusterDistribution

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to Ensuring[ClusterDistribution] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to StringFormat[ClusterDistribution] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def start(typeName: String, entityProps: Props, entityIds: Set[EntityId], settings: ClusterDistributionSettings): ActorRef

    Permalink

    Start a cluster distribution.

    Start a cluster distribution.

    typeName

    The name of the type of entity. This is used as the cluster sharding type name.

    entityProps

    The props for the entity actor.

    entityIds

    The entity ids to distribute over the cluster.

    settings

    The cluster distribution settings.

    returns

    the actor ref of the ShardRegion that is to be responsible for the shard

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. def →[B](y: B): (ClusterDistribution, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterDistribution to ArrowAssoc[ClusterDistribution] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterDistribution to any2stringadd[ClusterDistribution]

Inherited by implicit conversion StringFormat from ClusterDistribution to StringFormat[ClusterDistribution]

Inherited by implicit conversion Ensuring from ClusterDistribution to Ensuring[ClusterDistribution]

Inherited by implicit conversion ArrowAssoc from ClusterDistribution to ArrowAssoc[ClusterDistribution]

Ungrouped