# IdGen
**Repository Path**: miskiller/IdGen
## Basic Information
- **Project Name**: IdGen
- **Description**: No description available
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-05-18
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
#  IdGen
Twitter Snowflake-alike ID generator for .Net. Available as [Nuget package](https://www.nuget.org/packages/IdGen)
## Why
In certain situations you need a low-latency uncoordinated, (roughly) time ordered, compact and highly available Id generation system. This project was inspired by [Twitter's Snowflake](https://github.com/twitter/snowflake) project which has been retired. Note that this project was inspired by Snowflake but is not an *exact* implementation. This library provides a basis for Id generation; it does **not** provide a service for handing out these Id's nor does it provide generator-id ('worker-id') coordination.
## How it works
IdGen generates, like Snowflake, 64 bit Id's. The [Sign Bit](https://en.wikipedia.org/wiki/Sign_bit) is unused since this can cause incorrect ordering on some systems that cannot use unsigned types and/or make it hard to get correct ordering. So, in effect, IdGen generates 63 bit Id's. An Id consists of 3 parts:
* Timestamp
* Generator-id
* Sequence
An Id generated with a **Default** `MaskConfig` is structured as follows:
However, using the `MaskConfig` class you can tune the structure of the created Id's to your own needs; you can use 45 bits for the timestamp (≈1114 years), 2 bits for the generator-id and 16 bits for the sequence to allow, for example, generating 65536 id's per millisecond per generator distributed over 4 hosts/threads giving you a total of 262144 id's per millisecond. As long as all 3 parts (timestamp, generator and sequence) add up to 63 bits you're good to go!
The **timestamp**-part of the Id should speak for itself; by default this is incremented every millisecond and represents the number of milliseconds since a certain epoch. However, IdGen relies on an [`ITimeSource`](IdGen/ITimeSource.cs) which uses a 'tick' that can be defined to be anything; be it a millisecond (default), a second or even a day or nanosecond (hardware support etc. permitting). By default IdGen uses 2015-01-01 0:00:00Z as epoch, but you can specify a custom epoch too.
The **generator-id**-part of the Id is the part that you 'configure'; it could correspond to a host, thread, datacenter or continent: it's up to you. However, the generator-id should be unique in the system: if you have several hosts generating Id's, each host should have it's own generator-id. This could be based on the hostname, a config-file value or even be retrieved from an coordinating service. Remember: a generator-id should be unique within the entire system to avoid collisions!
The **sequence**-part is simply a value that is incremented each time a new Id is generated within the same tick (again, by default, a millisecond but can be anything); it is reset every time the tick changes.
## System Clock Dependency
We recommend you use NTP to keep your system clock accurate. IdGen protects from non-monotonic clocks, i.e. clocks that run backwards. The [`DefaultTimeSource`](IdGen/DefaultTimeSource.cs) relies on a 64bit monotonic, increasing only, system counter. However, we still recommend you use NTP to keep your system clock accurate; this will prevent duplicate Id's between system restarts for example.
The [`DefaultTimeSource`](IdGen/DefaultTimeSource.cs) relies on a [`Stopwatch`](https://msdn.microsoft.com/en-us/library/system.diagnostics.stopwatch.aspx) for calculating the 'ticks' but you can implement your own time source by simply implementing the [`ITimeSource`](IdGen/ITimeSource.cs) interface.
## Getting started
Install the [Nuget package](https://www.nuget.org/packages/IdGen) and write the following code:
```c#
using IdGen;
using System.Linq;
class Program
{
static void Main(string[] args)
{
var generator = new IdGenerator(0);
var id = generator.CreateId();
}
}
```
Voila. You have created your first Id! Want to create 100 Id's? Instead of:
`var id = generator.CreateId();`
write:
`var id = generator.Take(100);`
This is because the `IdGenerator()` implements `IEnumerable` providing you with a never-ending stream of Id's (so you might want to be careful doing a `.Select(...)` or `Count()` on it!).
The above example creates a default `IdGenerator` with the GeneratorId (or: 'Worker Id') set to 0 and using a [`DefaultTimeSource`](IdGen/DefaultTimeSource.cs). If you're using multiple generators (across machines or in separate threads or...) you'll want to make sure each generator is assigned it's own unique Id. One way of doing this is by simply storing a value in your configuration file for example, another way may involve a service handing out GeneratorId's to machines/threads. IdGen **does not** provide a solution for this since each project or setup may have different requirements or infrastructure to provide these generator-id's.
The below sample is a bit more complicated; we set a custom epoch, define our own (bit)mask configuration for generated Id's and then display some information about the setup:
```c#
using IdGen;
using System;
class Program
{
static void Main(string[] args)
{
// Let's say we take april 1st 2015 as our epoch
var epoch = new DateTime(2015, 4, 1, 0, 0, 0, DateTimeKind.Utc);
// Create a mask configuration of 45 bits for timestamp, 2 for generator-id
// and 16 for sequence
var mc = new MaskConfig(45, 2, 16);
// Create an IdGenerator with it's generator-id set to 0, our custom epoch
// and mask configuration
var generator = new IdGenerator(0, epoch, mc);
// Let's ask the mask configuration how many generators we could instantiate
// in this setup (2 bits)
Console.WriteLine("Max. generators : {0}", mc.MaxGenerators);
// Let's ask the mask configuration how many sequential Id's we could generate
// in a single ms in this setup (16 bits)
Console.WriteLine("Id's/ms per generator : {0}", mc.MaxSequenceIds);
// Let's calculate the number of Id's we could generate, per ms, should we use
// the maximum number of generators
Console.WriteLine("Id's/ms total : {0}", mc.MaxGenerators * mc.MaxSequenceIds);
// Let's ask the mask configuration for how long we could generate Id's before
// we experience a 'wraparound' of the timestamp
Console.WriteLine("Wraparound interval : {0}", mc.WraparoundInterval(generator.TimeSource));
// And finally: let's ask the mask configuration when this wraparound will happen
// (we'll have to tell it the generator's epoch)
Console.WriteLine("Wraparound date : {0}", mc.WraparoundDate(generator.Epoch, generator.TimeSource).ToString("O"));
}
}
```
Output:
```
Max. generators : 4
Id's/ms per generator : 65536
Id's/ms total : 262144
Wraparound interval : 407226.12:41:28.8320000 (about 1114 years)
Wraparound date : 3130-03-13T12:41:28.8320000Z
```
IdGen also provides an `ITimeSouce` interface; this can be handy for [unittesting](IdGenTests/IdGenTests.cs) purposes or if you want to provide a time-source for the timestamp part of your Id's that is not based on the system time. For unittesting we use our own [`MockTimeSource`](IdGenTests/MockTimeSource.cs).
The following constructor overloads are available:
```c#
IdGenerator(int generatorId)
IdGenerator(int generatorId, DateTimeOffset epoch)
IdGenerator(int generatorId, DateTimeOffset epoch, MaskConfig maskConfi)
IdGenerator(int generatorId, ITimeSource timeSource)
IdGenerator(int generatorId, MaskConfig maskConfig)
IdGenerator(int generatorId, MaskConfig maskConfig, ITimeSource timeSource)
```
All properties are read-only to prevent changes once an `IdGenerator` has been instantiated.
The `IdGenerator` class provides a 'factory method' to quickly create an IdGenerator based on configuration file. To use this, add the following to your configuration:
```xml
```
The attributes (`name`, `id`, `epoch`, `timestampBits`, `generatorIdBits` and `sequenceBits`) are required. The tickDuration is optional and defaults to the default tickduration from a `DefaultTimeSource`. Valid DateTime notations for the epoch are:
* `yyyy-MM-ddTHH:mm:ss`
* `yyyy-MM-dd HH:mm:ss`
* `yyyy-MM-dd`
You can get the IdGenerator from the config using the following code:
`var generator = IdGenerator.GetFromConfig("foo");`
[](https://ci.appveyor.com/project/RobIII/idgen) 
Icon made by [Freepik](http://www.flaticon.com/authors/freepik) from [www.flaticon.com](http://www.flaticon.com) is licensed by [CC 3.0](http://creativecommons.org/licenses/by/3.0/).