batchease

README

batchease

Golang library for processing batches of items, support multi worker, load-balancer, and middleware.

Documentation

Index

• Variables
• type Batcher
  • func New[T any](opts ...BatcherOption[T]) (*Batcher[T], error)
  • func (b *Batcher[T]) AddItem(item T)
  • func (b *Batcher[T]) AddWorker(w *Worker[T]) error
  • func (b *Batcher[T]) Run()
  • func (b *Batcher[T]) SetHandleFn(handleFn HandleFunc[T])
  • func (b *Batcher[T]) Shutdown()
• type BatcherOption
  • func WithDefaultConfig[T any]() BatcherOption[T]
  • func WithSize[T any](size int) BatcherOption[T]
  • func WithWait[T any](wait time.Duration) BatcherOption[T]
  • func WithWorkers[T any](n int, handleFn HandleFunc[T]) BatcherOption[T]
• type HandleFunc
• type LoadBalancer
• type RoundRobinLB
  • func (lb *RoundRobinLB[T]) Resolve(workers []*Worker[T]) *Worker[T]
• type Worker
  • func NewWorker[T any](id string, opts ...WorkerOption[T]) (*Worker[T], error)
• type WorkerOption
  • func WorkerWithHandleFn[T any](handleFn HandleFunc[T]) WorkerOption[T]

Variables

var (
	ErrInvalidBatchSize      = errors.New("invalid batch size")
	ErrInvalidHandleFn       = errors.New("invalid handle function")
	ErrInvalidNumberOfWorker = errors.New("invalid number of workers")
)

Types

type Batcher

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

func New

func New[T any](opts ...BatcherOption[T]) (*Batcher[T], error)

func (*Batcher[T]) AddItem

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

func (*Batcher[T]) AddWorker

func (b *Batcher[T]) AddWorker(w *Worker[T]) error

func (*Batcher[T]) Run

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

func (*Batcher[T]) SetHandleFn

func (b *Batcher[T]) SetHandleFn(handleFn HandleFunc[T])

func (*Batcher[T]) Shutdown

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

type BatcherOption

type BatcherOption[T any] func(b *Batcher[T]) error

BatcherOption

func WithDefaultConfig

func WithDefaultConfig[T any]() BatcherOption[T]

func WithSize

func WithSize[T any](size int) BatcherOption[T]

func WithWait

func WithWait[T any](wait time.Duration) BatcherOption[T]

func WithWorkers

func WithWorkers[T any](n int, handleFn HandleFunc[T]) BatcherOption[T]

type HandleFunc

type HandleFunc[T any] func(worker *Worker[T], data []T)

type LoadBalancer

type LoadBalancer[T any] interface {
	Resolve(workers []*Worker[T]) *Worker[T]
}

type RoundRobinLB

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

func (*RoundRobinLB[T]) Resolve

func (lb *RoundRobinLB[T]) Resolve(workers []*Worker[T]) *Worker[T]

type Worker

type Worker[T any] struct {
	ID string
	// contains filtered or unexported fields
}

func NewWorker

func NewWorker[T any](id string, opts ...WorkerOption[T]) (*Worker[T], error)

type WorkerOption

type WorkerOption[T any] func(w *Worker[T]) error

WorkerOption

func WorkerWithHandleFn

func WorkerWithHandleFn[T any](handleFn HandleFunc[T]) WorkerOption[T]