akka.routing.ConsistentHashingRouter

ConsistentHashableEnvelope

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

If you don't define the hashMapping when constructing the akka.routing.ConsistentHashingRouter and messages can't implement akka.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( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, RouterEnvelope, ConsistentHashable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashableEnvelope
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RouterEnvelope
  7. ConsistentHashable
  8. AnyRef
  9. 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 ConsistentHashableEnvelope(message: Any, hashKey: Any)

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 ConsistentHashableEnvelope to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (ConsistentHashableEnvelope, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashableEnvelope to ArrowAssoc[ConsistentHashableEnvelope] 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 consistentHashKey: Any

    Definition Classes
    ConsistentHashableEnvelope → ConsistentHashable

  11. def ensuring(cond: (ConsistentHashableEnvelope) ⇒ Boolean, msg: ⇒ Any): ConsistentHashableEnvelope

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

  12. def ensuring(cond: (ConsistentHashableEnvelope) ⇒ Boolean): ConsistentHashableEnvelope

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

  13. def ensuring(cond: Boolean, msg: ⇒ Any): ConsistentHashableEnvelope

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

  14. def ensuring(cond: Boolean): ConsistentHashableEnvelope

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

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

    Definition Classes
    AnyRef

  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 ConsistentHashableEnvelope to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  19. val hashKey: Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. val message: Any

    Definition Classes
    ConsistentHashableEnvelope → RouterEnvelope

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

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (ConsistentHashableEnvelope, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashableEnvelope to ArrowAssoc[ConsistentHashableEnvelope] 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 ConsistentHashableEnvelope 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:
    (consistentHashableEnvelope: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ConsistentHashableEnvelope 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:
    (consistentHashableEnvelope: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ConsistentHashableEnvelope

    Implicit information
    This member is added by an implicit conversion from ConsistentHashableEnvelope to ArrowAssoc[ConsistentHashableEnvelope] 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:
    (consistentHashableEnvelope: ArrowAssoc[ConsistentHashableEnvelope]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ConsistentHashableEnvelope

    Implicit information
    This member is added by an implicit conversion from ConsistentHashableEnvelope to Ensuring[ConsistentHashableEnvelope] 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:
    (consistentHashableEnvelope: Ensuring[ConsistentHashableEnvelope]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RouterEnvelope

Inherited from ConsistentHashable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConsistentHashableEnvelope to StringAdd

Inherited by implicit conversion any2stringfmt from ConsistentHashableEnvelope to StringFormat

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

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

Ungrouped