batch

Documentation

Index

• type Batcher
  • 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
  • func NewEntry[IN, OUT any](v IN, callbackFn func(out OUT)) Entry[IN, OUT]
• type Func
• type MultiBatcher
  • func NewMulti[IN, OUT any](f Func[IN, OUT], opt ...Option) *MultiBatcher[IN, OUT]
  • 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
• type Option
  • func WithBatchSize(batchSize int32) Option
  • func WithMaxWorkers(maxWorkers int32) Option
  • func WithMinWaitTime(minWaitTime time.Duration) Option

Types

type Batcher

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

func NewBatcher

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

func (*Batcher[IN, OUT]) Enter

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

func (*Batcher[IN, OUT]) EnterAndWait

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

type Entry

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

func NewEntry

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

type Func

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

type MultiBatcher

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

func NewMulti

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 (*MultiBatcher[IN, OUT]) Enter

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

func (*MultiBatcher[IN, OUT]) EnterAndWait

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

type NA

type NA = struct{}

type Option

type Option func(*config)

func WithBatchSize

func WithBatchSize(batchSize int32) Option

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

func WithMaxWorkers

func WithMaxWorkers(maxWorkers int32) Option

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

func WithMinWaitTime

func WithMinWaitTime(minWaitTime time.Duration) Option

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