class ClusterSharding extends Extension

Annotations
@nowarn()
Source
ClusterSharding.scala
See also

ClusterSharding companion object

Linear Supertypes
Extension, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterSharding
  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. Protected

Instance Constructors

  1. new ClusterSharding(system: ExtendedActorSystem)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ClusterSharding toany2stringadd[ClusterSharding] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterSharding, B)
    Implicit
    This member is added by an implicit conversion from ClusterSharding toArrowAssoc[ClusterSharding] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def defaultShardAllocationStrategy(settings: ClusterShardingSettings): ShardAllocationStrategy

    The default ShardAllocationStrategy is configured by least-shard-allocation-strategy properties.

  9. def ensuring(cond: (ClusterSharding) => Boolean, msg: => Any): ClusterSharding
    Implicit
    This member is added by an implicit conversion from ClusterSharding toEnsuring[ClusterSharding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ClusterSharding) => Boolean): ClusterSharding
    Implicit
    This member is added by an implicit conversion from ClusterSharding toEnsuring[ClusterSharding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ClusterSharding
    Implicit
    This member is added by an implicit conversion from ClusterSharding toEnsuring[ClusterSharding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ClusterSharding
    Implicit
    This member is added by an implicit conversion from ClusterSharding toEnsuring[ClusterSharding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def getShardTypeNames: Set[String]

    Java API: get all currently defined sharding type names.

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def shardRegion(typeName: String): ActorRef

    Retrieve the actor reference of the ShardRegion actor responsible for the named entity type.

    Retrieve the actor reference of the ShardRegion actor responsible for the named entity type. The entity type must be registered with the #start or #startProxy method before it can be used here. Messages to the entity is always sent via the ShardRegion.

  23. def shardTypeNames: Set[String]

    Scala API: get all currently defined sharding type names.

  24. def start(typeName: String, entityProps: Props, messageExtractor: MessageExtractor): ActorRef

    Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy is used. akka.actor.PoisonPill is used as handOffStopMessage.

    This method will start a ShardRegion in proxy mode when there is no match between the node roles and the role specified in the ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    messageExtractor

    functions to extract the entity id, shard id, and the message to send to the entity from the incoming message

    returns

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

  25. def start(typeName: String, entityProps: Props, settings: ClusterShardingSettings, messageExtractor: MessageExtractor): ActorRef

    Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy is used. akka.actor.PoisonPill is used as handOffStopMessage.

    This method will start a ShardRegion in proxy mode when there is no match between the node roles and the role specified in the ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    settings

    configuration settings, see ClusterShardingSettings

    messageExtractor

    functions to extract the entity id, shard id, and the message to send to the entity from the incoming message

    returns

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

  26. def start(typeName: String, entityProps: Props, settings: ClusterShardingSettings, messageExtractor: MessageExtractor, allocationStrategy: ShardAllocationStrategy, handOffStopMessage: Any): ActorRef

    Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    This method will start a ShardRegion in proxy mode when there is no match between the node roles and the role specified in the ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    settings

    configuration settings, see ClusterShardingSettings

    messageExtractor

    functions to extract the entity id, shard id, and the message to send to the entity from the incoming message, see ShardRegion.MessageExtractor

    allocationStrategy

    possibility to use a custom shard allocation and rebalancing logic

    handOffStopMessage

    the message that will be sent to entities when they are to be stopped for a rebalance or graceful shutdown of a ShardRegion, e.g. PoisonPill.

    returns

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

  27. def start(typeName: String, entityProps: Props, extractEntityId: ExtractEntityId, extractShardId: ExtractShardId): ActorRef

    Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion method.

    The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy is used. akka.actor.PoisonPill is used as handOffStopMessage.

    This method will start a ShardRegion in proxy mode when there is no match between the node roles and the role specified in the ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    extractEntityId

    partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    extractShardId

    function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

    returns

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

  28. def start(typeName: String, entityProps: Props, settings: ClusterShardingSettings, extractEntityId: ExtractEntityId, extractShardId: ExtractShardId): ActorRef

    Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion method.

    The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy is used. akka.actor.PoisonPill is used as handOffStopMessage.

    This method will start a ShardRegion in proxy mode when there is no match between the node roles and the role specified in the ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    settings

    configuration settings, see ClusterShardingSettings

    extractEntityId

    partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    extractShardId

    function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

    returns

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

  29. def start(typeName: String, entityProps: Props, extractEntityId: ExtractEntityId, extractShardId: ExtractShardId, allocationStrategy: ShardAllocationStrategy, handOffStopMessage: Any): ActorRef

    Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion method.

    This method will start a ShardRegion in proxy mode when there is no match between the roles of the current cluster node and the role specified in ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    extractEntityId

    partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    extractShardId

    function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

    allocationStrategy

    possibility to use a custom shard allocation and rebalancing logic

    handOffStopMessage

    the message that will be sent to entities when they are to be stopped for a rebalance or graceful shutdown of a ShardRegion, e.g. PoisonPill.

    returns

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

  30. def start(typeName: String, entityProps: Props, settings: ClusterShardingSettings, extractEntityId: ExtractEntityId, extractShardId: ExtractShardId, allocationStrategy: ShardAllocationStrategy, handOffStopMessage: Any): ActorRef

    Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.

    Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion method.

    This method will start a ShardRegion in proxy mode when there is no match between the roles of the current cluster node and the role specified in ClusterShardingSettings passed to this method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    entityProps

    the Props of the entity actors that will be created by the ShardRegion

    settings

    configuration settings, see ClusterShardingSettings

    extractEntityId

    partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    extractShardId

    function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

    allocationStrategy

    possibility to use a custom shard allocation and rebalancing logic

    handOffStopMessage

    the message that will be sent to entities when they are to be stopped for a rebalance or graceful shutdown of a ShardRegion, e.g. PoisonPill.

    returns

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

  31. def startProxy(typeName: String, role: Optional[String], messageExtractor: MessageExtractor): ActorRef

    Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e.

    Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entity actors itself. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    role

    specifies that this entity type is located on cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

    messageExtractor

    functions to extract the entity id, shard id, and the message to send to the entity from the incoming message

    returns

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

  32. def startProxy(typeName: String, role: Option[String], extractEntityId: ExtractEntityId, extractShardId: ExtractShardId): ActorRef

    Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e.

    Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entity actors itself. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    role

    specifies that this entity type is located on cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

    extractEntityId

    partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    extractShardId

    function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

    returns

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

  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. 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)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterSharding toStringFormat[ClusterSharding] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def shardRegionProxy(typeName: String, dataCenter: DataCenter): ActorRef

    Retrieve the actor reference of the ShardRegion actor that will act as a proxy to the named entity type running in another data center.

    Retrieve the actor reference of the ShardRegion actor that will act as a proxy to the named entity type running in another data center. A proxy within the same data center can be accessed with #shardRegion instead of this method. The entity type must be registered with the #startProxy method before it can be used here. Messages to the entity is always sent via the ShardRegion.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  4. def startProxy(typeName: String, role: Optional[String], dataCenter: Optional[String], messageExtractor: MessageExtractor): ActorRef

    Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e.

    Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entity actors itself. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    role

    specifies that this entity type is located on cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

    dataCenter

    The data center of the cluster nodes where the cluster sharding is running. If None then the same data center as current node.

    messageExtractor

    functions to extract the entity id, shard id, and the message to send to the entity from the incoming message

    returns

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  5. def startProxy(typeName: String, role: Option[String], dataCenter: Option[DataCenter], extractEntityId: ExtractEntityId, extractShardId: ExtractShardId): ActorRef

    Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e.

    Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entity actors itself. The ShardRegion actor for this type can later be retrieved with the #shardRegion method.

    Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

    typeName

    the name of the entity type

    role

    specifies that this entity type is located on cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

    dataCenter

    The data center of the cluster nodes where the cluster sharding is running. If None then the same data center as current node.

    extractEntityId

    partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    extractShardId

    function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

    returns

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  6. def →[B](y: B): (ClusterSharding, B)
    Implicit
    This member is added by an implicit conversion from ClusterSharding toArrowAssoc[ClusterSharding] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterSharding to any2stringadd[ClusterSharding]

Inherited by implicit conversion StringFormat fromClusterSharding to StringFormat[ClusterSharding]

Inherited by implicit conversion Ensuring fromClusterSharding to Ensuring[ClusterSharding]

Inherited by implicit conversion ArrowAssoc fromClusterSharding to ArrowAssoc[ClusterSharding]

Ungrouped