batcher

README

batcher

batcher collect a data and flush it if the batch is full or the interval is elapsed.

Installation

go get github.com/gotidy/batcher

Examples

batch := New(flusher)
batch.Put("some data")

Documentation

GoDoc

License

Apache 2.0

Documentation

Index

• Constants
• func WithBatchSize(size int) func(*Batcher)
• func WithFlushInterval(interval time.Duration) func(*Batcher)
• type Batcher
  • func New(f Flusher, opts ...Option) *Batcher
  • func (b *Batcher) Close()
  • func (b *Batcher) Put(v interface{})
  • func (b *Batcher) Recuperate(batch []interface{})
• type Flusher
• type Option

Constants

const (
	DefaultBatchSize     = 100
	DefaultFlushInterval = time.Second
)

Functions

func WithBatchSize

func WithBatchSize(size int) func(*Batcher)

func WithFlushInterval

func WithFlushInterval(interval time.Duration) func(*Batcher)

Types

type Batcher

type Batcher struct {
	BatchSize     int
	FlushInterval time.Duration
	// contains filtered or unexported fields
}

func New

func New(f Flusher, opts ...Option) *Batcher

func (*Batcher) Close

func (b *Batcher) Close()

func (*Batcher) Put

func (b *Batcher) Put(v interface{})

func (*Batcher) Recuperate

func (b *Batcher) Recuperate(batch []interface{})

type Flusher

type Flusher interface {
	Flush(batch []interface{}) (recuperate bool)
}

type Option

type Option func(*Batcher)