Class

akka.cluster.sharding.typed

HashCodeMessageExtractor

Related Doc: package typed

Permalink

final class HashCodeMessageExtractor[M] extends ShardingMessageExtractor[ShardingEnvelope[M], M]

Default message extractor type, using envelopes to identify what entity a message is for and the hashcode of the entityId to decide which shard an entity belongs to.

This is recommended since it does not force details about sharding into the entity protocol

M

The type of message accepted by the entity actor

Source
ShardingMessageExtractor.scala
Linear Supertypes
ShardingMessageExtractor[ShardingEnvelope[M], M], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HashCodeMessageExtractor
  2. ShardingMessageExtractor
  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 HashCodeMessageExtractor(numberOfShards: Int)

    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 HashCodeMessageExtractor[M] to any2stringadd[HashCodeMessageExtractor[M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] to ArrowAssoc[HashCodeMessageExtractor[M]] 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: (HashCodeMessageExtractor[M]) ⇒ Boolean, msg: ⇒ Any): HashCodeMessageExtractor[M]

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

  9. def ensuring(cond: (HashCodeMessageExtractor[M]) ⇒ Boolean): HashCodeMessageExtractor[M]

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): HashCodeMessageExtractor[M]

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

  11. def ensuring(cond: Boolean): HashCodeMessageExtractor[M]

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

  12. def entityId(envelope: ShardingEnvelope[M]): String

    Permalink

    Extract the entity id from an incoming message.

    Extract the entity id from an incoming message. If null is returned the message will be unhandled, i.e. posted as Unhandled messages on the event stream

    Definition Classes
    HashCodeMessageExtractor → ShardingMessageExtractor

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

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

  16. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. val numberOfShards: Int

    Permalink

  24. def shardId(entityId: String): String

    Permalink

    The shard identifier for a given entity id.

    The shard identifier for a given entity id. Only messages that passed the ShardingMessageExtractor#entityId function will be used as input to this function.

    Definition Classes
    HashCodeMessageExtractor → ShardingMessageExtractor

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

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. def unwrapMessage(envelope: ShardingEnvelope[M]): M

    Permalink

    Extract the message to send to the entity from an incoming message.

    Extract the message to send to the entity from an incoming message. Note that the extracted message does not have to be the same as the incoming message to support wrapping in message envelope that is unwrapped before sending to the entity actor.

    Definition Classes
    HashCodeMessageExtractor → ShardingMessageExtractor

  28. final def wait(): Unit

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

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

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

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

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

  31. def →[B](y: B): (HashCodeMessageExtractor[M], B)

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

Inherited from ShardingMessageExtractor[ShardingEnvelope[M], M]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HashCodeMessageExtractor[M] to any2stringadd[HashCodeMessageExtractor[M]]

Inherited by implicit conversion StringFormat from HashCodeMessageExtractor[M] to StringFormat[HashCodeMessageExtractor[M]]

Inherited by implicit conversion Ensuring from HashCodeMessageExtractor[M] to Ensuring[HashCodeMessageExtractor[M]]

Inherited by implicit conversion ArrowAssoc from HashCodeMessageExtractor[M] to ArrowAssoc[HashCodeMessageExtractor[M]]

Ungrouped