milvus/pkg/util/uniquegenerator/unique_int_generator.go

// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package uniquegenerator

import "sync"

type (
	// UniqueIntGenerator provide methods to generate unique integers
	UniqueIntGenerator interface {
		GetInt() int
		GetInts(count int) (int, int)
	}
	// NaiveUniqueIntGenerator is a native implement of UniqueIntGenerator
	NaiveUniqueIntGenerator struct {
		now int
		mtx sync.Mutex
	}
)

// GetInts returns the begin and end of a batch of unique integers
func (generator *NaiveUniqueIntGenerator) GetInts(count int) (int, int) {
	generator.mtx.Lock()
	defer func() {
		generator.now += count
		generator.mtx.Unlock()
	}()
	return generator.now, generator.now + count
}

// GetInt returns a unique integer
func (generator *NaiveUniqueIntGenerator) GetInt() int {
	begin, _ := generator.GetInts(1)
	return begin
}

// NewNaiveUniqueIntGenerator returns a new NaiveUniqueIntGenerator object
func NewNaiveUniqueIntGenerator() *NaiveUniqueIntGenerator {
	return &NaiveUniqueIntGenerator{
		now: 0,
	}
}

var uniqueIntGeneratorIns UniqueIntGenerator

var getUniqueIntGeneratorInsOnce sync.Once

// GetUniqueIntGeneratorIns returns a singleton of UniqueIntGenerator
func GetUniqueIntGeneratorIns() UniqueIntGenerator {
	getUniqueIntGeneratorInsOnce.Do(func() {
		uniqueIntGeneratorIns = NewNaiveUniqueIntGenerator()
	})
	return uniqueIntGeneratorIns
}