Table of Contents

Class Snowflake

Namespace
SnowflakeID
Assembly
SnowflakeIDGenerator.dll

This class represents the Snowflake object. Wikipedia article about SnowflakeId

public class Snowflake : IEquatable<Snowflake>, IComparable<Snowflake>, IComparable
Inheritance
Snowflake
Implements
Inherited Members

Remarks

NuGet

Source

API

Site

Constructors

Snowflake()

Initializes a new instance of the Snowflake class using the default epoch (UNIX time 1-1-1970).

public Snowflake()

Snowflake(DateTime)

Initializes a new instance of the Snowflake class using a custom date as epoch.

public Snowflake(DateTime epoch)

Parameters

epoch DateTime

The date to use as the epoch.

Fields

MaxMachineId

Max number of machines / servers allowed. Range from 0 to MaxMachineId-1

public const long MaxMachineId = 1024

Field Value

long

MaxSequence

The maximum sequence number that can be generated per millisecond. When this value is reached, the sequence is reset to 0.

public const long MaxSequence = 4096

Field Value

long

MaxTimestamp

Max number of milliseconds since epoch. Range from 0 to MaxTimestamp-1

public const long MaxTimestamp = 4398046511104

Field Value

long

NumberOfDigits

Total number of digits for the generated code.

public static readonly int NumberOfDigits

Field Value

int

An int representing the number of digits.

Properties

Code

Gets the Snowflake ID as a string.

public string Code { get; }

Property Value

string

A string representing the Snowflake ID.

Epoch

Gets the current epoch being used.

public DateTime Epoch { get; }

Property Value

DateTime

A DateTime representing the current epoch.

Id

Gets the Snowflake ID.

[CLSCompliant(false)]
public virtual ulong Id { get; }

Property Value

ulong

A ulong representing the Snowflake ID.

MachineId

Gets or sets the machine/server number.

[CLSCompliant(false)]
public ulong MachineId { get; set; }

Property Value

ulong

Exceptions

ArgumentOutOfRangeException

Thrown when the value is greater than or equal to MaxMachineId.

MachineIdInt32

Gets or sets the machine/server number as an integer.

public int MachineIdInt32 { get; set; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

Thrown when the value is negative or greater than or equal to MaxMachineId.

Sequence

Gets or sets the sequence number.

[CLSCompliant(false)]
public ulong Sequence { get; set; }

Property Value

ulong

Exceptions

ArgumentOutOfRangeException

Thrown when the value is greater than or equal to MaxSequence.

SequenceInt32

Gets or sets the sequence number as an integer.

public int SequenceInt32 { get; set; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

Thrown when the value is negative or greater than or equal to MaxSequence.

Timestamp

Gets or sets the timestamp as the number of milliseconds since the selected epoch.

[CLSCompliant(false)]
public ulong Timestamp { get; set; }

Property Value

ulong

Exceptions

ArgumentOutOfRangeException

Thrown when the value is greater than or equal to MaxTimestamp.

TimestampInt64

Gets or sets the timestamp as the number of milliseconds since the selected epoch.

public long TimestampInt64 { get; set; }

Property Value

long

Exceptions

ArgumentOutOfRangeException

Thrown when the value is less than 0 or greater than or equal to MaxTimestamp.

UtcDateTime

Sets the timeStamp portion of the snowflake based on current time and selected epoch. Gets real time of the snowflake based on selected epoch.

public DateTime UtcDateTime { get; set; }

Property Value

DateTime

Methods

ChangeEpoch(DateTime)

Changes the snowflake's epoch keeping the code intact. This will adjust the represented UtcDateTime to match the new epoch.

public void ChangeEpoch(DateTime newEpoch)

Parameters

newEpoch DateTime

The new epoch to set.

CompareTo(Snowflake)

Compares the current Snowflake object with another Snowflake object.

public int CompareTo(Snowflake other)

Parameters

other Snowflake

The Snowflake object to compare with the current Snowflake object.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

  • Less than zero: This object is less than the other parameter.
  • Zero: This object is equal to other.
  • Greater than zero: This object is greater than other.

Exceptions

SnowflakesUsingDifferentEpochsException

Thrown when comparing Snowflake objects generated using different epochs.

CompareTo(object)

Compares the current Snowflake object with another object.

public int CompareTo(object obj)

Parameters

obj object

The object to compare with the current Snowflake object.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

  • Less than zero: This object is less than the obj parameter.
  • Zero: This object is equal to obj.
  • Greater than zero: This object is greater than obj.

Exceptions

SnowflakesUsingDifferentEpochsException

Thrown when comparing Snowflake objects generated using different epochs.

Equals(Snowflake)

Checks equality between this Snowflake object and another Snowflake object.

public virtual bool Equals(Snowflake other)

Parameters

other Snowflake

The Snowflake object to compare with the current Snowflake object.

Returns

bool

true if the specified Snowflake object is equal to the current Snowflake object; otherwise, false.

Equals(object)

Checks equality between this Snowflake object and another object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current Snowflake object.

Returns

bool

true if the specified object is equal to the current Snowflake object; otherwise, false.

FromString(string)

Creates a Snowflake instance from the specified string.

public static Snowflake FromString(string s)

Parameters

s string

The string representation of the Snowflake.

Returns

Snowflake

A Snowflake instance that corresponds to the specified string.

FromUInt64(ulong)

Creates a Snowflake instance from the specified unsigned long integer.

[CLSCompliant(false)]
public static Snowflake FromUInt64(ulong s)

Parameters

s ulong

The unsigned long integer representation of the Snowflake.

Returns

Snowflake

A Snowflake instance that corresponds to the specified unsigned long integer.

GetHashCode()

Serves as the default hash function. Override of GetHashCode().

public override int GetHashCode()

Returns

int

A hash code for the current Snowflake object.

Parse(string)

Creates a SnowflakeId object from a SnowflakeId code.

public static Snowflake Parse(string s)

Parameters

s string

The SnowflakeId code as a string.

Returns

Snowflake

A new instance of the Snowflake class.

Parse(string, DateTime)

Creates a SnowflakeId object from a SnowflakeId code using a custom epoch.

public static Snowflake Parse(string s, DateTime customEpoch)

Parameters

s string

The SnowflakeId code as a string.

customEpoch DateTime

The custom date to use as the epoch.

Returns

Snowflake

A new instance of the Snowflake class.

Parse(ulong)

Creates a SnowflakeId object from a SnowflakeId code.

[CLSCompliant(false)]
public static Snowflake Parse(ulong b)

Parameters

b ulong

The SnowflakeId code as a ulong.

Returns

Snowflake

A new instance of the Snowflake class.

Parse(ulong, DateTime)

Creates a SnowflakeId object from a SnowflakeId code using a custom epoch.

[CLSCompliant(false)]
public static Snowflake Parse(ulong b, DateTime customEpoch)

Parameters

b ulong

The SnowflakeId code as a ulong.

customEpoch DateTime

The custom date to use as the epoch.

Returns

Snowflake

A new instance of the Snowflake class.

RebaseEpoch(DateTime)

Rebase the Snowflake to a new epoch CHANGING THE GENERATED CODE but keeping the same date and time.

public void RebaseEpoch(DateTime newEpoch)

Parameters

newEpoch DateTime

The new epoch to set.

ToString()

Gets the Snowflake ID as a string.

public override string ToString()

Returns

string

A string representing the Snowflake ID.

ToUInt64()

Converts the current Snowflake instance to its unsigned long integer representation.

[CLSCompliant(false)]
public ulong ToUInt64()

Returns

ulong

An unsigned long integer representation of the current Snowflake instance.

Remarks

If a loosely typed language (or a language that doesn't differentiate between number types, i.e.: Typescript) is part of your workflow, use ToString() to avoid issues regarding floating-point underflow and rounding.

Operators

operator ==(Snowflake, Snowflake)

Determines whether two specified instances of Snowflake are equal.

public static bool operator ==(Snowflake s1, Snowflake s2)

Parameters

s1 Snowflake

The first Snowflake to compare.

s2 Snowflake

The second Snowflake to compare.

Returns

bool

true if the two Snowflake instances are equal; otherwise, false.

explicit operator Snowflake(string)

Converts the specified string to a Snowflake instance.

public static explicit operator Snowflake(string s)

Parameters

s string

The string to convert.

Returns

Snowflake

A Snowflake instance that is equivalent to the specified string.

explicit operator Snowflake(ulong)

Converts the specified unsigned long integer to a Snowflake instance.

[CLSCompliant(false)]
public static explicit operator Snowflake(ulong s)

Parameters

s ulong

The unsigned long integer to convert.

Returns

Snowflake

A Snowflake instance that is equivalent to the specified unsigned long integer.

operator >(Snowflake, Snowflake)

Determines whether the first specified Snowflake is greater than the second specified Snowflake.

public static bool operator >(Snowflake s1, Snowflake s2)

Parameters

s1 Snowflake

The first Snowflake to compare.

s2 Snowflake

The second Snowflake to compare.

Returns

bool

true if the first Snowflake is greater than the second Snowflake; otherwise, false.

Exceptions

SnowflakesUsingDifferentEpochsException

Thrown when comparing Snowflake objects generated using different epochs.

operator >=(Snowflake, Snowflake)

Determines whether the first specified Snowflake is greater than or equal to the second specified Snowflake.

public static bool operator >=(Snowflake s1, Snowflake s2)

Parameters

s1 Snowflake

The first Snowflake to compare.

s2 Snowflake

The second Snowflake to compare.

Returns

bool

true if the first Snowflake is greater than or equal to the second Snowflake; otherwise, false.

Exceptions

SnowflakesUsingDifferentEpochsException

Thrown when comparing Snowflake objects generated using different epochs.

implicit operator string(Snowflake)

Converts the specified Snowflake instance to its string representation.

public static implicit operator string(Snowflake s)

Parameters

s Snowflake

The Snowflake instance to convert.

Returns

string

A string representation of the specified Snowflake instance.

implicit operator ulong(Snowflake)

Converts the specified Snowflake instance to its unsigned long integer representation.

[CLSCompliant(false)]
public static implicit operator ulong(Snowflake s)

Parameters

s Snowflake

The Snowflake instance to convert.

Returns

ulong

An unsigned long integer representation of the specified Snowflake instance.

Remarks

If a loosely typed language (or a language that doesn't differentiate between number types, i.e.: Typescript) is part of your workflow, use the string representation to avoid issues regarding floating-point underflow and rounding.

operator !=(Snowflake, Snowflake)

Determines whether two specified instances of Snowflake are not equal.

public static bool operator !=(Snowflake s1, Snowflake s2)

Parameters

s1 Snowflake

The first Snowflake to compare.

s2 Snowflake

The second Snowflake to compare.

Returns

bool

true if the two Snowflake instances are not equal; otherwise, false.

operator <(Snowflake, Snowflake)

Determines whether the first specified Snowflake is less than the second specified Snowflake.

public static bool operator <(Snowflake s1, Snowflake s2)

Parameters

s1 Snowflake

The first Snowflake to compare.

s2 Snowflake

The second Snowflake to compare.

Returns

bool

true if the first Snowflake is less than the second Snowflake; otherwise, false.

Exceptions

SnowflakesUsingDifferentEpochsException

Thrown when comparing Snowflake objects generated using different epochs.

operator <=(Snowflake, Snowflake)

Determines whether the first specified Snowflake is less than or equal to the second specified Snowflake.

public static bool operator <=(Snowflake s1, Snowflake s2)

Parameters

s1 Snowflake

The first Snowflake to compare.

s2 Snowflake

The second Snowflake to compare.

Returns

bool

true if the first Snowflake is less than or equal to the second Snowflake; otherwise, false.

Exceptions

SnowflakesUsingDifferentEpochsException

Thrown when comparing Snowflake objects generated using different epochs.

Edit this page