batch

Documentation

Index

• type Callback
• type Writer
  • func NewWriter(cfg WriterConfig, cb Callback) *Writer
  • func (w *Writer) Start()
  • func (w *Writer) Stop()
  • func (w *Writer) Submit(items ...interface{})
• type WriterConfig

Types

type Callback

type Callback func(ctx context.Context, items []interface{}) []bool

type Writer

type Writer struct {
	Handler Callback
	// contains filtered or unexported fields
}

Writer allows to buffer some items and call the Handler function either when the buffer is full or the timeout is reached. There will also be support for concurrency for high volume. The handler function is supposed to return an array of booleans to indicate whether the transfer was successful or not. It can be replaced with status codes in the future to differentiate I/O errors, rate limiting, authorization issues.

func NewWriter

func NewWriter(cfg WriterConfig, cb Callback) *Writer

func (*Writer) Start

func (w *Writer) Start()

Indicates the start to accept the

func (*Writer) Stop

func (w *Writer) Stop()

Used to signal writer to stop processing items and exit.

func (*Writer) Submit

func (w *Writer) Submit(items ...interface{})

Submit pushes the items to the income buffer and they are placed onto the actual buffer from there.

type WriterConfig

type WriterConfig struct {
	BatchSize  int
	MaxRetries int
	Interval   time.Duration
	Timeout    time.Duration
}