Packages

final case class ConsistentHashableEnvelope(message: Any, hashKey: Any) extends ConsistentHashable with RouterEnvelope with WrappedMessage with Product with Serializable

If you don't define the hashMapping when constructing the pekko.routing.ConsistentHashingRouter and messages can't implement pekko.routing.ConsistentHashingRouter.ConsistentHashable themselves they can we wrapped by this envelope instead. The router will only send the wrapped message to the destination, i.e. the envelope will be stripped off.

Annotations
@SerialVersionUID()
Source
ConsistentHashing.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsistentHashableEnvelope
  2. Serializable
  3. Product
  4. Equals
  5. RouterEnvelope
  6. WrappedMessage
  7. ConsistentHashable
  8. AnyRef
  9. 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 ConsistentHashableEnvelope(message: Any, hashKey: Any)

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 ConsistentHashableEnvelope toany2stringadd[ConsistentHashableEnvelope] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConsistentHashableEnvelope, B)
    Implicit
    This member is added by an implicit conversion from ConsistentHashableEnvelope toArrowAssoc[ConsistentHashableEnvelope] 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 consistentHashKey: Any
  9. def ensuring(cond: (ConsistentHashableEnvelope) => Boolean, msg: => Any): ConsistentHashableEnvelope
    Implicit
    This member is added by an implicit conversion from ConsistentHashableEnvelope toEnsuring[ConsistentHashableEnvelope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ConsistentHashableEnvelope) => Boolean): ConsistentHashableEnvelope
    Implicit
    This member is added by an implicit conversion from ConsistentHashableEnvelope toEnsuring[ConsistentHashableEnvelope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ConsistentHashableEnvelope
    Implicit
    This member is added by an implicit conversion from ConsistentHashableEnvelope toEnsuring[ConsistentHashableEnvelope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ConsistentHashableEnvelope
    Implicit
    This member is added by an implicit conversion from ConsistentHashableEnvelope toEnsuring[ConsistentHashableEnvelope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. val hashKey: Any
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val message: 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 productElementNames: Iterator[String]
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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 ConsistentHashableEnvelope toStringFormat[ConsistentHashableEnvelope] 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): (ConsistentHashableEnvelope, B)
    Implicit
    This member is added by an implicit conversion from ConsistentHashableEnvelope toArrowAssoc[ConsistentHashableEnvelope] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from RouterEnvelope

Inherited from WrappedMessage

Inherited from ConsistentHashable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromConsistentHashableEnvelope to any2stringadd[ConsistentHashableEnvelope]

Inherited by implicit conversion StringFormat fromConsistentHashableEnvelope to StringFormat[ConsistentHashableEnvelope]

Inherited by implicit conversion Ensuring fromConsistentHashableEnvelope to Ensuring[ConsistentHashableEnvelope]

Inherited by implicit conversion ArrowAssoc fromConsistentHashableEnvelope to ArrowAssoc[ConsistentHashableEnvelope]

Ungrouped