Class SnowflakeIDGenerator

Namespace

SnowflakeID

Assembly

SnowflakeIDGenerator.dll

Generator class for Snowflake.

This keeps track of time, machine number and sequence.

public class SnowflakeIDGenerator : ISnowflakeIDGenerator, ISnowflakeIDGeneratorClsCompliant

Inheritance

object

SnowflakeIDGenerator

Implements

ISnowflakeIDGenerator

ISnowflakeIDGeneratorClsCompliant

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

NuGet

Source

API

Site

Constructors

SnowflakeIDGenerator(int)

Creates a SnowflakeIDGenerator for a given machine number.

public SnowflakeIDGenerator(int machineId)

Parameters

machineId int

Machine number

Remarks

This constructor initializes the generator with a specific machine ID and uses the default epoch date. It ensures that the machine ID is within the valid range and sets the initial timestamp to prevent overflow issues.

Exceptions

ArgumentOutOfRangeException

Thrown when machineId is greater than or equal to MaxMachineId.

SnowflakeIDGenerator(int, DateTime)

Creates a SnowflakeIDGenerator for a given machine number using a custom date as epoch.

public SnowflakeIDGenerator(int machineId, DateTime customEpoch)

Parameters

machineId int

Machine number

customEpoch DateTime

Date to use as epoch

Remarks

This constructor initializes the generator with a specific machine ID and a custom epoch date. It ensures that the machine ID is within the valid range and sets the initial timestamp to prevent overflow issues.

Exceptions

ArgumentOutOfRangeException

Thrown when machineId is greater than or equal to MaxMachineId.

SnowflakeIDGenerator(ulong)

Creates a SnowflakeIDGenerator for a given machine number.

[CLSCompliant(false)]
public SnowflakeIDGenerator(ulong machineId)

Parameters

machineId ulong

Machine number

Remarks

This constructor initializes the generator with a specific machine ID and uses the default epoch date. It ensures that the machine ID is within the valid range and sets the initial timestamp to prevent overflow issues.

Exceptions

ArgumentOutOfRangeException

Thrown when machineId is greater than or equal to MaxMachineId.

SnowflakeIDGenerator(ulong, DateTime)

Creates a SnowflakeIDGenerator for a given machine number using a custom date as epoch.

[CLSCompliant(false)]
public SnowflakeIDGenerator(ulong machineId, DateTime customEpoch)

Parameters

machineId ulong

Machine number

customEpoch DateTime

Date to use as epoch

Remarks

This constructor initializes the generator with a specific machine ID and a custom epoch date. It ensures that the machine ID is within the valid range and sets the initial timestamp to prevent overflow issues.

Exceptions

ArgumentOutOfRangeException

Thrown when machineId is greater than or equal to MaxMachineId.

Properties

ConfiguredEpoch

Gets the date configured as the epoch for the generator.

public DateTime ConfiguredEpoch { get; }

Property Value

DateTime

The DateTime value representing the custom epoch date.

Remarks

The epoch date is used as the starting point for generating unique IDs.

ConfiguredMachineId

Gets the configured machine ID for the generator.

public int ConfiguredMachineId { get; }

Property Value

int

The int value representing the machine ID.

Remarks

The machine ID is used to ensure uniqueness across different instances of the generator.

Methods

GetCode()

Gets the next Snowflake ID as a number.

[CLSCompliant(false)]
public ulong GetCode()

Returns

ulong

A ulong representing the next Snowflake ID.

Remarks

This method generates a new Snowflake ID and returns it as a numeric value.

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

GetCode(ulong)

Static method to get the next Snowflake ID as a number for a given machine ID.

[CLSCompliant(false)]
public static ulong GetCode(ulong machineId)

Parameters

machineId ulong

The machine ID as a ulong.

Returns

ulong

A ulong representing the next Snowflake ID.

Remarks

This method generates a new Snowflake ID and returns it as a numeric value.

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

GetCode(ulong, DateTime)

Static method to get the next Snowflake ID as a number for a given machine ID using a custom epoch date.

[CLSCompliant(false)]
public static ulong GetCode(ulong machineId, DateTime customEpoch)

Parameters

machineId ulong

The machine ID as a ulong.

customEpoch DateTime

The custom epoch date as a DateTime.

Returns

ulong

A ulong representing the next Snowflake ID.

Remarks

This method generates a new Snowflake ID and returns it as a numeric value.

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

GetCodeString()

Gets the next Snowflake ID as a string.

public string GetCodeString()

Returns

string

A string representing the next Snowflake ID.

Remarks

This method generates a new Snowflake ID and returns it as a string value.

GetCodeString(int)

Gets the next Snowflake ID as a string for a given machine ID.

public static string GetCodeString(int machineId)

Parameters

machineId int

The machine ID as an int.

Returns

string

A string representing the next Snowflake ID.

GetCodeString(int, DateTime)

Gets the next Snowflake ID as a string for a given machine ID using a custom epoch date.

public static string GetCodeString(int machineId, DateTime customEpoch)

Parameters

machineId int

The machine ID as an int.

customEpoch DateTime

The custom epoch date as a DateTime.

Returns

string

A string representing the next Snowflake ID.

GetCodeString(ulong)

Gets the next Snowflake ID as a string for a given machine ID.

[CLSCompliant(false)]
public static string GetCodeString(ulong machineId)

Parameters

machineId ulong

The machine ID as a ulong.

Returns

string

A string representing the next Snowflake ID.

GetCodeString(ulong, DateTime)

Gets the next Snowflake ID as a string for a given machine ID using a custom epoch date.

[CLSCompliant(false)]
public static string GetCodeString(ulong machineId, DateTime customEpoch)

Parameters

machineId ulong

The machine ID as a ulong.

customEpoch DateTime

The custom epoch date as a DateTime.

Returns

string

A string representing the next Snowflake ID.

GetSnowflake()

Generates the next Snowflake ID.

public Snowflake GetSnowflake()

Returns

Snowflake

A Snowflake object containing the generated ID.

Exceptions

InvalidOperationException

Thrown when the system clock is moved backwards.

GetSnowflake(int)

Static method to get the next Snowflake ID for a given machine ID.

public static Snowflake GetSnowflake(int machineId)

Parameters

machineId int

The machine ID as an int.

Returns

Snowflake

A Snowflake object containing the generated ID.

GetSnowflake(int, DateTime)

Static method to get the next Snowflake ID for a given machine ID using a custom epoch date.

public static Snowflake GetSnowflake(int machineId, DateTime customEpoch)

Parameters

machineId int

The machine ID as an int.

customEpoch DateTime

The custom epoch date as a DateTime.

Returns

Snowflake

A Snowflake object containing the generated ID.

GetSnowflake(ulong)

Static method to get the next Snowflake ID for a given machine ID.

[CLSCompliant(false)]
public static Snowflake GetSnowflake(ulong machineId)

Parameters

machineId ulong

The machine ID as a ulong.

Returns

Snowflake

A Snowflake object containing the generated ID.

Remarks

This method generates a new Snowflake ID and returns it as a Snowflake object.

GetSnowflake(ulong, DateTime)

Static method to get the next Snowflake ID for a given machine ID using a custom epoch date.

[CLSCompliant(false)]
public static Snowflake GetSnowflake(ulong machineId, DateTime customEpoch)

Parameters

machineId ulong

The machine ID as a ulong.

customEpoch DateTime

The custom epoch date as a DateTime.

Returns

Snowflake

A Snowflake object containing the generated ID.