Influxdata
/
chronograf
mirror of https://github.com/influxdata/chronograf.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: add comments to exported bits

pull/5360/head
greg linton 2020-01-23 10:40:35 -07:00 committed by Greg
parent 8ecae3c41f
commit 1f1e1eebc9
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
snowflake/gen.go
View File

@ -25,11 +25,13 @@ const (
timeMask = ^(-1 << timeBits) timeMask = ^(-1 << timeBits)
) )
// Generator defines a snowflake generator structure.
type Generator struct { type Generator struct {
state uint64 state uint64
machine uint64 machine uint64
} }
// New creates a new generator.
func New(machineID int) *Generator { func New(machineID int) *Generator {
if machineID < 0 || machineID > serverMax { if machineID < 0 || machineID > serverMax {
panic(fmt.Errorf("invalid machine id; must be 0 ≤ id < %d", serverMax)) panic(fmt.Errorf("invalid machine id; must be 0 ≤ id < %d", serverMax))
@ -40,10 +42,12 @@ func New(machineID int) *Generator {
} }
} }
// MachineID returns the machine's ID.
func (g *Generator) MachineID() int { func (g *Generator) MachineID() int {
return int(g.machine >> serverShift) return int(g.machine >> serverShift)
} }
// Next generates and returns a universally unique uint64.
func (g *Generator) Next() uint64 { func (g *Generator) Next() uint64 {
var state uint64 var state uint64
@ -95,12 +99,14 @@ func (g *Generator) Next() uint64 {
return state | g.machine return state | g.machine
} }
// NextString generates and returns a universally unique uint64 as a string.
func (g *Generator) NextString() string { func (g *Generator) NextString() string {
var s [11]byte var s [11]byte
encode(&s, g.Next()) encode(&s, g.Next())
return string(s[:]) return string(s[:])
} }
// AppendNext appends the byte slice of a unique uint64 to s.
func (g *Generator) AppendNext(s *[11]byte) { func (g *Generator) AppendNext(s *[11]byte) {
encode(s, g.Next()) encode(s, g.Next())
} }