class ConsistentHash[T] extends AnyRef

Consistent Hashing node ring implementation.

A good explanation of Consistent Hashing: https://tom-e-white.com/2007/11/consistent-hashing.html

Note that toString of the ring nodes are used for the node hash, i.e. make sure it is different for different nodes.

Source
ConsistentHash.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsistentHash
  2. AnyRef
  3. 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

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 ConsistentHash[T] toany2stringadd[ConsistentHash[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConsistentHash[T], B)
    Implicit
    This member is added by an implicit conversion from ConsistentHash[T] toArrowAssoc[ConsistentHash[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def :+(node: T): ConsistentHash[T]

    Adds a node to the node ring.

    Adds a node to the node ring. Note that the instance is immutable and this operation returns a new instance.

  6. def :-(node: T): ConsistentHash[T]

    Removes a node from the node ring.

    Removes a node from the node ring. Note that the instance is immutable and this operation returns a new instance.

  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def add(node: T): ConsistentHash[T]

    Java API: Adds a node to the node ring.

    Java API: Adds a node to the node ring. Note that the instance is immutable and this operation returns a new instance.

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. def ensuring(cond: (ConsistentHash[T]) => Boolean, msg: => Any): ConsistentHash[T]
    Implicit
    This member is added by an implicit conversion from ConsistentHash[T] toEnsuring[ConsistentHash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ConsistentHash[T]) => Boolean): ConsistentHash[T]
    Implicit
    This member is added by an implicit conversion from ConsistentHash[T] toEnsuring[ConsistentHash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ConsistentHash[T]
    Implicit
    This member is added by an implicit conversion from ConsistentHash[T] toEnsuring[ConsistentHash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ConsistentHash[T]
    Implicit
    This member is added by an implicit conversion from ConsistentHash[T] toEnsuring[ConsistentHash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def isEmpty: Boolean

    Is the node ring empty, i.e.

    Is the node ring empty, i.e. no nodes added or all removed.

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def nodeFor(key: String): T

    Get the node responsible for the data key.

    Get the node responsible for the data key. Can only be used if nodes exists in the node ring, otherwise throws IllegalStateException

  23. def nodeFor(key: Array[Byte]): T

    Get the node responsible for the data key.

    Get the node responsible for the data key. Can only be used if nodes exists in the node ring, otherwise throws IllegalStateException

  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. def remove(node: T): ConsistentHash[T]

    Java API: Removes a node from the node ring.

    Java API: Removes a node from the node ring. Note that the instance is immutable and this operation returns a new instance.

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. val virtualNodesFactor: Int
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. 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 ConsistentHash[T] toStringFormat[ConsistentHash[T]] 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): (ConsistentHash[T], B)
    Implicit
    This member is added by an implicit conversion from ConsistentHash[T] toArrowAssoc[ConsistentHash[T]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromConsistentHash[T] to any2stringadd[ConsistentHash[T]]

Inherited by implicit conversion StringFormat fromConsistentHash[T] to StringFormat[ConsistentHash[T]]

Inherited by implicit conversion Ensuring fromConsistentHash[T] to Ensuring[ConsistentHash[T]]

Inherited by implicit conversion ArrowAssoc fromConsistentHash[T] to ArrowAssoc[ConsistentHash[T]]

Ungrouped