diff options
| -rw-r--r-- | README.md | 28 |
1 files changed, 27 insertions, 1 deletions
@@ -1,3 +1,29 @@ # Clawflake -🦀 Rust-based Snowflake generator on a gRPC server
\ No newline at end of file +Clawflake is a Rust application which implements [Twitter's Snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) and communicates using [gRPC](https://grpc.io/). + +Snowflake ID numbers are 63 bits integers stored as `i64`. + +An ID number is composed of: + +- a timestamp (which is the difference between the current time and the epoch) [`41 bits`] +- a configured machine ID (Data center ID and Worker ID) [`10 bits`] +- a sequence number which rolls over every 4096 per machine (with protection to avoid rollover in the same ms) [`12 bits`] + +## Usage + +Build the container + +```sh +docker build --tag clawflake:1.0 . +``` + +Run the container + +```sh +docker run -e CLAWFLAKE_EPOCH=<epoch> -e CLAWFLAKE_WORKER_ID=<worker_id> -e CLAWFLAKE_DATACENTER_ID=<datacenter_id> -p <host port>:50051 clawflake:1.0 +``` + +You can then create your client using [clawflake.rs](clawflake.rs) and start communicate with the service. + +An example client can be found [here](src/client.rs)! |