abstract class HashCodeMessageExtractor extends MessageExtractor

Convenience implementation of ShardRegion.MessageExtractor that construct shardId based on the hashCode of the entityId. The number of unique shards is limited by the given maxNumberOfShards.

Source
ShardRegion.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HashCodeMessageExtractor
  2. MessageExtractor
  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(maxNumberOfShards: Int)

Abstract Value Members

  1. abstract def entityId(message: Any): 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
    MessageExtractor

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

    Default implementation pass on the message as is.

    Default implementation pass on the message as is.

    Definition Classes
    HashCodeMessageExtractorMessageExtractor
  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. def shardId(message: Any): String

    Extract the shard id from an incoming message.

    Extract the shard id from an incoming message. Only messages that passed the #entityId function will be used as input to this function.

    Definition Classes
    HashCodeMessageExtractorMessageExtractor
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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 toStringFormat[HashCodeMessageExtractor] 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, B)
    Implicit
    This member is added by an implicit conversion from HashCodeMessageExtractor toArrowAssoc[HashCodeMessageExtractor] 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 MessageExtractor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHashCodeMessageExtractor to any2stringadd[HashCodeMessageExtractor]

Inherited by implicit conversion StringFormat fromHashCodeMessageExtractor to StringFormat[HashCodeMessageExtractor]

Inherited by implicit conversion Ensuring fromHashCodeMessageExtractor to Ensuring[HashCodeMessageExtractor]

Inherited by implicit conversion ArrowAssoc fromHashCodeMessageExtractor to ArrowAssoc[HashCodeMessageExtractor]

Ungrouped