Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gbuffer

package module

Go to main page

Versions in this module

v0

v0.2.0

Aug 26, 2026

Changes in this version

type AggregatorOption

+ func WithAggregatorOnError[K comparable, V any](onError func(error)) AggregatorOption[K, V]

type BatcherOption

+ func WithBatchOnError[T any](onError func(error)) BatcherOption[T]

v0.1.0

Jul 12, 2026

Changes in this version

+ var ErrClosed = errors.New("gbuffer: closed")

+ var ErrDropped = errors.New("gbuffer: dropped")

+ var ErrFull = errors.New("gbuffer: full")

+ var ErrInvalidConfig = errors.New("gbuffer: invalid config")

+ var ErrRejected = errors.New("gbuffer: rejected")

+ func SumInt64(old, next int64) int64

+ type AddFunc func(context.Context, T) error

+ type AddMiddleware func(AddFunc[T]) AddFunc[T]

+ type AggregateAddFunc func(context.Context, K, V) error

+ type AggregateAddMiddleware func(AggregateAddFunc[K, V]) AggregateAddFunc[K, V]

+ type Aggregator struct

+ func NewAggregator[K comparable, V any](sink Sinker[map[K]V], combine Combiner[V], opts ...AggregatorOption[K, V]) (*Aggregator[K, V], error)

+ func (a *Aggregator[K, V]) Add(ctx context.Context, key K, value V) error

+ func (a *Aggregator[K, V]) Close(ctx context.Context) error

+ func (a *Aggregator[K, V]) Flush(ctx context.Context) error

+ type AggregatorOption func(*Aggregator[K, V])

+ func WithAggregatorFlushInterval[K comparable, V any](d time.Duration) AggregatorOption[K, V]

+ func WithAggregatorPool[K comparable, V any](pool WorkerPool) AggregatorOption[K, V]

+ func WithAggregatorPriority[K comparable, V any](priority int) AggregatorOption[K, V]

+ func WithEventThreshold[K comparable, V any](n int) AggregatorOption[K, V]

+ func WithKeyThreshold[K comparable, V any](n int) AggregatorOption[K, V]

+ type Batcher struct

+ func NewBatcher[T any](sink Sinker[[]T], opts ...BatcherOption[T]) (*Batcher[T], error)

+ func (b *Batcher[T]) Add(ctx context.Context, value T) error

+ func (b *Batcher[T]) Close(ctx context.Context) error

+ func (b *Batcher[T]) Flush(ctx context.Context) error

+ type BatcherOption func(*Batcher[T])

+ func WithBatchFlushInterval[T any](d time.Duration) BatcherOption[T]

+ func WithBatchMaxPending[T any](n int) BatcherOption[T]

+ func WithBatchPool[T any](pool WorkerPool) BatcherOption[T]

+ func WithBatchPriority[T any](priority int) BatcherOption[T]

+ func WithBatchSinkMiddleware[T any](middleware ...Middleware[[]T]) BatcherOption[T]

+ func WithBatchSize[T any](size int) BatcherOption[T]

+ type Combiner func(old V, next V) V

+ type Job interface

+ Priority func() int

+ Run func(context.Context) error

+ type Middleware func(Sinker[T]) Sinker[T]

+ type PoolOption func(*PriorityWorkerPool)

+ func WithQueueSize(n int) PoolOption

+ func WithWorkers(n int) PoolOption

+ type PriorityWorkerPool struct

+ func NewPriorityWorkerPool(opts ...PoolOption) *PriorityWorkerPool

+ func (p *PriorityWorkerPool) Close(ctx context.Context) error

+ func (p *PriorityWorkerPool) Submit(ctx context.Context, job Job) error

+ type SinkJob struct

+ func NewSinkJob[T any](priority int, payload T, sink Sinker[T]) SinkJob[T]

+ func (j SinkJob[T]) Priority() int

+ func (j SinkJob[T]) Run(ctx context.Context) error

+ type Sinker func(context.Context, T) error

+ func Use[T any](sink Sinker[T], middleware ...Middleware[T]) Sinker[T]

+ type WorkerPool interface

+ Close func(context.Context) error

+ Submit func(context.Context, Job) error