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
- Alphabetic
- By Inheritance
- ConsistentHash
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- 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.
- 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.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def isEmpty: Boolean
Is the node ring empty, i.e.
Is the node ring empty, i.e. no nodes added or all removed.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- val virtualNodesFactor: Int
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
Inherited from Any
Inherited by implicit conversion any2stringadd fromConsistentHash[T] to any2stringadd[ConsistentHash[T]]
Value Members
- 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
Inherited by implicit conversion StringFormat fromConsistentHash[T] to StringFormat[ConsistentHash[T]]
Value Members
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
Inherited by implicit conversion Ensuring fromConsistentHash[T] to Ensuring[ConsistentHash[T]]
Value Members
- 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
- 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
- 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
- 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
Inherited by implicit conversion ArrowAssoc fromConsistentHash[T] to ArrowAssoc[ConsistentHash[T]]
Value Members
- 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()
- 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.
Ungrouped
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- 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.
- 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.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def isEmpty: Boolean
Is the node ring empty, i.e.
Is the node ring empty, i.e. no nodes added or all removed.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- val virtualNodesFactor: Int
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.