batcher

Documentation

Index

• type Batcher
  • func New[T any](size int, timeout time.Duration, fn func(batch []*T), background bool) *Batcher[T]
  • func (b *Batcher[T]) Put(item *T)

Types

type Batcher

type Batcher[T any] struct {
	// contains filtered or unexported fields
}

Batcher is a utility that batches items together and then invokes the provided function on that whenever it reaches the specified size or the timeout is reached.

func New

func New[T any](size int, timeout time.Duration, fn func(batch []*T), background bool) *Batcher[T]

New creates a new Batcher that will invoke the provided function when the batch size is reached. The size is the maximum number of items that can be batched before processing the batch. The timeout is the duration that will be waited before processing the batch.

func (*Batcher[T]) Put

func (b *Batcher[T]) Put(item *T)

Put adds an item to the batch. If the batch is full, or the timeout is reached the batch will be processed.