akka.contrib.pattern

ClusterSharding

class ClusterSharding extends Extension

Source
ClusterSharding.scala
See also

ClusterSharding companion object

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ClusterSharding
  2. Extension
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClusterSharding(system: ExtendedActorSystem)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ClusterSharding, B)

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to ArrowAssoc[ClusterSharding] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (ClusterSharding) ⇒ Boolean, msg: ⇒ Any): ClusterSharding

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to Ensuring[ClusterSharding] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ClusterSharding) ⇒ Boolean): ClusterSharding

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to Ensuring[ClusterSharding] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): ClusterSharding

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to Ensuring[ClusterSharding] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ClusterSharding

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to Ensuring[ClusterSharding] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def shardRegion(typeName: String): ActorRef

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

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

  25. def start(typeName: String, entryProps: Props, messageExtractor: MessageExtractor): ActorRef

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

    Java API: Register a named entry type by defining the akka.actor.Props of the entry actor and functions to extract entry 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.

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

    typeName

    the name of the entry type

    entryProps

    the Props of the entry actors that will be created by the ShardRegion, if not defined (null) the ShardRegion on this node will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entry actors itself

    messageExtractor

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

    returns

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

  26. def start(typeName: String, entryProps: Props, messageExtractor: MessageExtractor, allocationStrategy: ShardAllocationStrategy): ActorRef

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

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

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

    typeName

    the name of the entry type

    entryProps

    the Props of the entry actors that will be created by the ShardRegion, if not defined (null) the ShardRegion on this node will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entry actors itself

    messageExtractor

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

    allocationStrategy

    possibility to use a custom shard allocation and rebalancing logic

    returns

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

  27. def start(typeName: String, entryProps: Option[Props], idExtractor: IdExtractor, shardResolver: (Msg) ⇒ ShardId): ActorRef

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

    Register a named entry type by defining the akka.actor.Props of the entry actor and functions to extract entry 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.

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

    typeName

    the name of the entry type

    entryProps

    the Props of the entry actors that will be created by the ShardRegion, if not defined (None) the ShardRegion on this node will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entry actors itself

    idExtractor

    partial function to extract the entry id and the message to send to the entry 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

    shardResolver

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

    returns

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

  28. def start(typeName: String, entryProps: Option[Props], idExtractor: IdExtractor, shardResolver: (Msg) ⇒ ShardId, allocationStrategy: ShardAllocationStrategy): ActorRef

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

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

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

    typeName

    the name of the entry type

    entryProps

    the Props of the entry actors that will be created by the ShardRegion, if not defined (None) the ShardRegion on this node will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entry actors itself

    idExtractor

    partial function to extract the entry id and the message to send to the entry 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

    shardResolver

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

    allocationStrategy

    possibility to use a custom shard allocation and rebalancing logic

    returns

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

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

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (ClusterSharding, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterSharding: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterSharding: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ClusterSharding

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to ArrowAssoc[ClusterSharding] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterSharding: ArrowAssoc[ClusterSharding]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ClusterSharding

    Implicit information
    This member is added by an implicit conversion from ClusterSharding to Ensuring[ClusterSharding] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterSharding: Ensuring[ClusterSharding]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterSharding to StringAdd

Inherited by implicit conversion any2stringfmt from ClusterSharding to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ClusterSharding to ArrowAssoc[ClusterSharding]

Inherited by implicit conversion any2Ensuring from ClusterSharding to Ensuring[ClusterSharding]

Ungrouped