akka.routing

ConsistentHashingRouter

Related Docs: class ConsistentHashingRouter | package routing

object ConsistentHashingRouter extends Serializable

Source
ConsistentHashing.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashingRouter
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait ConsistentHashMapper extends AnyRef

    JAVA API Mapping from message to the data to use for the consistent hash key.

    JAVA API Mapping from message to the data to use for the consistent hash key. Note that it's not the hash that is to be returned, but the data to be hashed.

    May return null to indicate that the message is not handled by this mapping.

    If returning an Array[Byte] or String it will be used as is, otherwise the configured akka.serialization.Serializer will be applied to the returned data.

  2. type ConsistentHashMapping = PartialFunction[Any, Any]

    Partial function from message to the data to use for the consistent hash key.

    Partial function from message to the data to use for the consistent hash key. Note that it's not the hash that is to be returned, but the data to be hashed.

    If returning an Array[Byte] or String it will be used as is, otherwise the configured akka.serialization.Serializer will be applied to the returned data.

  3. trait ConsistentHashable extends AnyRef

    If you don't define the hashMapping when constructing the akka.routing.ConsistentHashingRouter the messages need to implement this interface to define what data to use for the consistent hash key.

    If you don't define the hashMapping when constructing the akka.routing.ConsistentHashingRouter the messages need to implement this interface to define what data to use for the consistent hash key. Note that it's not the hash, but the data to be hashed.

    If returning an Array[Byte] or String it will be used as is, otherwise the configured akka.serialization.Serializer will be applied to the returned data.

    If messages can't implement this interface themselves, it's possible to wrap the messages in akka.routing.ConsistentHashingRouter.ConsistentHashableEnvelope, or use akka.routing.ConsistentHashingRouter.ConsistentHashableEnvelope

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

    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()

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. object emptyConsistentHashMapping extends ConsistentHashMapping

    Annotations
    @SerialVersionUID()
  7. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  17. def toString(): String

    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def apply(routees: Iterable[ActorRef]): ConsistentHashingRouter

    Creates a new ConsistentHashingRouter, routing to the specified routees

    Creates a new ConsistentHashingRouter, routing to the specified routees

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use ConsistentHashingGroup

  2. def create(routees: Iterable[ActorRef]): ConsistentHashingRouter

    Java API to create router with the supplied 'routees' actors.

    Java API to create router with the supplied 'routees' actors.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use ConsistentHashingGroup

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped