Categorygithub.com/minami14/idgo
modulepackage
1.1.1
Repository: https://github.com/minami14/idgo.git
Documentation: pkg.go.dev

# README

idgo

GoDoc CircleCI Travis Go Report Card

idgo is a very fast id generator that generates an int id that can specify the maximum value

Install

go get github.com/minami14/idgo

Usage

package main

import (
	"fmt"
	"log"
	"math"

	"github.com/minami14/idgo/idgo"
)

func main() {
	store := idgo.NewLocalStore(math.MaxInt16)
	gen, err := idgo.NewIDGenerator(store)
	if err != nil {
		log.Fatal(err)
	}

	// Generate a id.
	id, err := gen.Generate()
	if err != nil {
		log.Println(err)
	}

	// Generated id.
	fmt.Println(id)

	// Allocated id count.
	fmt.Println(gen.GetAllocatedIDCount())

	// id is allocated.
	fmt.Println(gen.IsAllocated(id))
	isAllocated, err := gen.IsAllocated(id)
	if err != nil {
		log.Println(err)
	}
	fmt.Println(isAllocated)

	// Free the id.
	if err := gen.Free(id); err != nil {
		log.Println(err)
	}

	// Allocate the id.
	if err := gen.Allocate(id); err != nil {
		log.Println(err)
	}

	// Free all id.
	if err := gen.FreeAll(); err != nil {
		log.Println(err)
	}
}

Server

Build

go build -o idgo-server ./cmd/server/main.go
chmod +x idgo-server

Show usage

./idgo-server -h

Run server

./idgo-server -m [maximum value of id] -p [port number]

Client

package main

import (
	"fmt"
	"log"
	"net"

	"github.com/minami14/idgo/idgo"
)

func main() {
	tcpAddr, err := net.ResolveTCPAddr("tcp", ":49152")
	if err != nil {
		log.Fatal(err)
	}
	
	client := idgo.NewClient()
	if err := client.Connect(tcpAddr); err != nil {
		log.Fatal(err)
	}
	
	id, err := client.Generate()
	if err != nil {
		log.Println(id)
	}
	
	if err := client.Free(id); err != nil {
		log.Println(err)
	}
}

License

MIT License

idgo uses the following libraries

# Packages

No description provided by the author

# Functions

NewClient is IDGenerateClient constructed.
NewIDGenerator is IDGenerator constructed.
NewLocalStore is LocalStore constructed.
NewRedisStore is RedisStore constructed.
NewServer is IDGenerateServer constructed.

# Structs

IDGenerateClient requests new id to server.
IDGenerateServer generate id when requested by client.
IDGenerator generate a id.
LocalStore stores allocated id to byte slice.
RedisStore stores allocated id to redis.

# Interfaces

AllocatedIDStore stores allocated id.