batcher

Documentation

Overview

batcher is a package that provides a simple batching mechanism the buffer can be configured with a max capacity and a flush interval the buffer will invoke a callback function when the buffer is full or the flush interval is reached

Index

• type Batcher
  • func New[T any](maxCapacity int, flushInterval time.Duration, fn FlushCallback[T]) *Batcher[T]
  • func (b *Batcher[T]) Append(d ...T)
  • func (b *Batcher[T]) Run()
  • func (b *Batcher[T]) Stop()
  • func (b *Batcher[T]) WaitDone()
• type FlushCallback

Types

type Batcher

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

func New

func New[T any](maxCapacity int, flushInterval time.Duration, fn FlushCallback[T]) *Batcher[T]

New creates a new batcher

func (*Batcher[T]) Append

func (b *Batcher[T]) Append(d ...T)

Append appends data to the batcher

func (*Batcher[T]) Run

func (b *Batcher[T]) Run()

Run starts the batcher

func (*Batcher[T]) Stop

func (b *Batcher[T]) Stop()

Stop stops the batcher

func (*Batcher[T]) WaitDone

func (b *Batcher[T]) WaitDone()

WaitDone waits until the batcher is done

type FlushCallback

type FlushCallback[T any] func([]T)

FlushCallback is the callback function that will be called when the batcher is full or the flush interval is reached