c

akka.cluster.sharding.typed

HashCodeMessageExtractor

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. Protected

Instance Constructors

  1. new HashCodeMessageExtractor(numberOfShards: Int)

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 HashCodeMessageExtractor[M] toany2stringadd[HashCodeMessageExtractor[M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HashCodeMessageExtractor[M], B)
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] toArrowAssoc[HashCodeMessageExtractor[M]] 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 ensuring(cond: (HashCodeMessageExtractor[M]) => Boolean, msg: => Any): HashCodeMessageExtractor[M]
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] toEnsuring[HashCodeMessageExtractor[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HashCodeMessageExtractor[M]) => Boolean): HashCodeMessageExtractor[M]
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] toEnsuring[HashCodeMessageExtractor[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): HashCodeMessageExtractor[M]
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] toEnsuring[HashCodeMessageExtractor[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HashCodeMessageExtractor[M]
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] toEnsuring[HashCodeMessageExtractor[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def entityId(envelope: ShardingEnvelope[M]): String

    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
    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 hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. val numberOfShards: Int
  22. def shardId(entityId: String): String

    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
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def unwrapMessage(envelope: ShardingEnvelope[M]): M

    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
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. 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 HashCodeMessageExtractor[M] toStringFormat[HashCodeMessageExtractor[M]] 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 →[B](y: B): (HashCodeMessageExtractor[M], B)
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor[M] toArrowAssoc[HashCodeMessageExtractor[M]] 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 ShardingMessageExtractor[ShardingEnvelope[M], M]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped