Scheme

Specification of an Id implementation.

An Id encodes its generation time and the node which created it. Ids also include an incremental number in order to differentiate Ids produced on the same time unit. The timestamp, node and the sequence data are packed into 64-bits and the Scheme specifies the number of bits of each parameter. Additionally, a Scheme specifies the beginning of time of the Id implementation, a.k.a. its epoch.

A Scheme is required by various parts of this library so it's suggested to define it implicitly.

timestampBits: The number of bits devoted to the Id timestamp.
nodeBits: The number of bits devoted to the Id node.
sequenceBits: The number of bits devoted to the Id sequence.
epoch: The beginning of time, in the Unix timeline, for this Scheme in milliseconds (milliseconds since Unix epoch).

Annotations: @throws( classOf[IllegalArgumentException] ) @SerialVersionUID( 0L )
Exceptions thrown: IllegalArgumentException
If timestamp, node and sequence bits aren't greater than 0, their sum isn't 64 or epoch is negative.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Scheme(timestampBits: Long, nodeBits: Long, sequenceBits: Long, epoch: Long)

timestampBits
The number of bits devoted to the Id timestamp.
nodeBits
The number of bits devoted to the Id node.
sequenceBits
The number of bits devoted to the Id sequence.
epoch
The beginning of time, in the Unix timeline, for this Scheme in milliseconds (milliseconds since Unix epoch).

Exceptions thrown
IllegalArgumentException
If timestamp, node and sequence bits aren't greater than 0, their sum isn't 64 or epoch is negative.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
val epoch: Long

The beginning of time, in the Unix timeline, for this Scheme in milliseconds (milliseconds since Unix epoch).
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

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

Definition Classes
Any
def isValidNode(node: Long): Boolean

Checks if a node is valid for this Scheme.
def isValidSequence(sequence: Long): Boolean

Checks if a sequence is valid for this Scheme.
def isValidTimestamp(timestamp: Long): Boolean

Checks if a timestamp is valid for this Scheme.
val maxNode: Long

The max node of this Id Scheme.
val maxSequence: Long

The max sequence of this Id Scheme.
val maxTimestamp: Long

The max timestamp, in the Unix timeline, of this Id Scheme.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val nodeBits: Long

The number of bits devoted to the Id node.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val sequenceBits: Long

The number of bits devoted to the Id sequence.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timestampBits: Long

The number of bits devoted to the Id timestamp.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws()

final case class Scheme(timestampBits: Long, nodeBits: Long, sequenceBits: Long, epoch: Long) extends Product with Serializable

Instance Constructors

new Scheme(timestampBits: Long, nodeBits: Long, sequenceBits: Long, epoch: Long)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val epoch: Long

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

def isValidNode(node: Long): Boolean

def isValidSequence(sequence: Long): Boolean

def isValidTimestamp(timestamp: Long): Boolean

val maxNode: Long

val maxSequence: Long

val maxTimestamp: Long

final def ne(arg0: AnyRef): Boolean

val nodeBits: Long

final def notify(): Unit

final def notifyAll(): Unit

val sequenceBits: Long

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

val timestampBits: Long

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped