batch

package

v0.14.2 Latest Latest Go to latest Published: May 9, 2024 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Batcher[IN, OUT any] struct {
	utils.SpinLock
	// contains filtered or unexported fields
}

func NewBatcher[IN, OUT any](f Func[IN, OUT], tagID string, opt ...Option) *Batcher[IN, OUT]

func (f *Batcher[IN, OUT]) Enter(entry Entry[IN, OUT])

func (f *Batcher[IN, OUT]) EnterAndWait(entry Entry[IN, OUT])

type Entry[IN, OUT any] interface {
	Value() IN
	Callback(out OUT)
	// contains filtered or unexported methods
}

func NewEntry[IN, OUT any](v IN, callbackFn func(out OUT)) Entry[IN, OUT]

type Func[IN, OUT any] func(targetID string, entries []Entry[IN, OUT])

type MultiBatcher[IN, OUT any] struct {
	// contains filtered or unexported fields
}

func NewMulti[IN, OUT any](f Func[IN, OUT], opt ...Option) *MultiBatcher[IN, OUT]

NewMulti creates a pool of Batcher functions. By calling Enter or EnterAndWait you add the item into the Batcher which is identified by 'tagID'.

func (fp *MultiBatcher[IN, OUT]) Enter(targetID string, entry Entry[IN, OUT])

func (fp *MultiBatcher[IN, OUT]) EnterAndWait(targetID string, entry Entry[IN, OUT])

type NA = struct{}

type Option func(*config)

func WithBatchSize(batchSize int32) Option

WithBatchSize sets the maximum number of entries to batch together. Defaults to 100.

func WithMaxWorkers(maxWorkers int32) Option

WithMaxWorkers sets the maximum number of workers to use. Defaults to runtime.NumCPU() * 10.

func WithMinWaitTime(minWaitTime time.Duration) Option

WithMinWaitTime sets the minimum amount of time to wait before flushing a batch. Defaults to 0.