snowflakeid

README

Snowflake id

A distributed unique ID generator inspired by Twitter's Snowflake.

Documentation

Index

• Variables
• type Snowflake
  • func NewSnowflake(workerID uint32) (*Snowflake, error)
  • func (sf *Snowflake) ID() (uint64, error)
  • func (sf *Snowflake) WorkerID() uint32
• type SnowflakeFactory
  • func NewSnowflakeFactory(bitLenWorkerID, bitLenSequence, gapMs uint, startTime time.Time) *SnowflakeFactory
  • func (f *SnowflakeFactory) BuildID(workerID uint32, elapsedTime uint64, sequence uint32) (uint64, error)
  • func (f *SnowflakeFactory) CurrentElapsedTime() uint64
  • func (f *SnowflakeFactory) FlakeTimestamp(t time.Time) uint64
  • func (f *SnowflakeFactory) MaskSequence(sequence uint32) uint32
  • func (f *SnowflakeFactory) MaxSequence() uint32
  • func (f *SnowflakeFactory) MaxTime() time.Time
  • func (f *SnowflakeFactory) MaxWorkerID() uint32
  • func (f *SnowflakeFactory) NewSnowflake(workerID uint32) (*Snowflake, error)
  • func (f *SnowflakeFactory) SleepTime(overtime time.Duration) time.Duration

Variables

var (
	InvalidSystemClock = errors.New("invalid system clock")
)

Types

type Snowflake

type Snowflake struct {
	// contains filtered or unexported fields
}

func NewSnowflake

func NewSnowflake(workerID uint32) (*Snowflake, error)

func (*Snowflake) ID

func (sf *Snowflake) ID() (uint64, error)

func (*Snowflake) WorkerID

func (sf *Snowflake) WorkerID() uint32

type SnowflakeFactory

type SnowflakeFactory struct {
	// contains filtered or unexported fields
}

func NewSnowflakeFactory

func NewSnowflakeFactory(bitLenWorkerID, bitLenSequence, gapMs uint, startTime time.Time) *SnowflakeFactory

func (*SnowflakeFactory) BuildID

func (f *SnowflakeFactory) BuildID(workerID uint32, elapsedTime uint64, sequence uint32) (uint64, error)

func (*SnowflakeFactory) CurrentElapsedTime

func (f *SnowflakeFactory) CurrentElapsedTime() uint64

func (*SnowflakeFactory) FlakeTimestamp

func (f *SnowflakeFactory) FlakeTimestamp(t time.Time) uint64

func (*SnowflakeFactory) MaskSequence

func (f *SnowflakeFactory) MaskSequence(sequence uint32) uint32

func (*SnowflakeFactory) MaxSequence

func (f *SnowflakeFactory) MaxSequence() uint32

func (*SnowflakeFactory) MaxTime

func (f *SnowflakeFactory) MaxTime() time.Time

func (*SnowflakeFactory) MaxWorkerID

func (f *SnowflakeFactory) MaxWorkerID() uint32

func (*SnowflakeFactory) NewSnowflake

func (f *SnowflakeFactory) NewSnowflake(workerID uint32) (*Snowflake, error)

func (*SnowflakeFactory) SleepTime

func (f *SnowflakeFactory) SleepTime(overtime time.Duration) time.Duration