batch

README

go-batch

Batch goroutine helper

Documentation

Index

• Constants
• Variables
• type DrainFunc
  • func (df DrainFunc) Drain(ctx context.Context, batch []interface{}) error
• type Drainer
• type Queue
  • func (s *Queue) Add(x interface{}) error
  • func (s *Queue) Flush(ctx context.Context, batch []interface{}) (err error)
  • func (s *Queue) IsUp() bool
  • func (s *Queue) MustAdd(x interface{})
  • func (s *Queue) MustRun(ctx context.Context)
  • func (s *Queue) Run(ctx context.Context) error
  • func (s *Queue) Stats() (total, flush_size, flush_tick, flush_err uint64)

Constants

const (
	DefaultInterval = time.Second
	DefaultSize     = 1000
)

Variables

var (
	AlreadyRunningError = errors.New("Queue already running.")
)

var (
	NoDrainerError = errors.New("No Drainer in Queue")
)

var (
	NotRunningError = errors.New("Queue is not running")
)

Types

type DrainFunc

type DrainFunc func(context.Context, []interface{}) error

func (DrainFunc) Drain

func (df DrainFunc) Drain(ctx context.Context, batch []interface{}) error

type Drainer

type Drainer interface {
	Drain(context.Context, []interface{}) error
}

type Queue

type Queue struct {
	Size     int
	Interval time.Duration
	Drainer  Drainer
	Retries  int
	// contains filtered or unexported fields
}

func (*Queue) Add

func (s *Queue) Add(x interface{}) error

func (*Queue) Flush

func (s *Queue) Flush(ctx context.Context, batch []interface{}) (err error)

func (*Queue) IsUp

func (s *Queue) IsUp() bool

func (*Queue) MustAdd

func (s *Queue) MustAdd(x interface{})

func (*Queue) MustRun

func (s *Queue) MustRun(ctx context.Context)

func (*Queue) Run

func (s *Queue) Run(ctx context.Context) error

func (*Queue) Stats

func (s *Queue) Stats() (total, flush_size, flush_tick, flush_err uint64)