batch

Documentation

Index

• Constants
• type Batcher
• type ConditionalExecutor
  • func NewConditionalExecutor(logger logging.Logger) *ConditionalExecutor
  • func (c *ConditionalExecutor) BatchFor(ctx context.Context, key string, timeout time.Duration, exec Executer) (interface{}, error)
  • func (c *ConditionalExecutor) Run(ctx context.Context)
• type DelayFn
• type Executer
• type ExecuterFunc
  • func (b ExecuterFunc) Execute() (interface{}, error)
• type Executor
  • func NewExecutor(logger logging.Logger) *Executor
  • func (e *Executor) BatchFor(ctx context.Context, key string, timeout time.Duration, exec Executer) (interface{}, error)
  • func (e *Executor) Run(ctx context.Context)
• type NoOpBatchingExecutor
  • func NopExecutor() *NoOpBatchingExecutor
  • func (n *NoOpBatchingExecutor) BatchFor(_ context.Context, _ string, _ time.Duration, exec Executer) (interface{}, error)
• type Tracker
• type WaitFor
• type Waiters

Constants

const RequestBufferSize = 1 << 17

RequestBufferSize is the amount of requests users can dispatch that haven't been processed yet before dispatching new ones would start blocking.

const SkipBatchContextKey contextKey = "skip_batch"

SkipBatchContextKey existence on a context will eliminate the request batching

Types

type Batcher

type Batcher interface {
	BatchFor(ctx context.Context, key string, dur time.Duration, exec Executer) (interface{}, error)
}

type ConditionalExecutor

type ConditionalExecutor struct {
	// contains filtered or unexported fields
}

ConditionalExecutor will batch requests only if SkipBatchContextKey is not on the context of the batch request.

func NewConditionalExecutor

func NewConditionalExecutor(logger logging.Logger) *ConditionalExecutor

func (*ConditionalExecutor) BatchFor

func (c *ConditionalExecutor) BatchFor(ctx context.Context, key string, timeout time.Duration, exec Executer) (interface{}, error)

func (*ConditionalExecutor) Run

func (c *ConditionalExecutor) Run(ctx context.Context)

type DelayFn

type DelayFn func(dur time.Duration)

type Executer

type Executer interface {
	Execute() (interface{}, error)
}

type ExecuterFunc

type ExecuterFunc func() (interface{}, error)

func (ExecuterFunc) Execute

func (b ExecuterFunc) Execute() (interface{}, error)

type Executor

type Executor struct {
	Logger logging.Logger
	Delay  DelayFn
	// contains filtered or unexported fields
}

func NewExecutor

func NewExecutor(logger logging.Logger) *Executor

func (*Executor) BatchFor

func (e *Executor) BatchFor(ctx context.Context, key string, timeout time.Duration, exec Executer) (interface{}, error)

func (*Executor) Run

func (e *Executor) Run(ctx context.Context)

type NoOpBatchingExecutor

type NoOpBatchingExecutor struct{}

func NopExecutor

func NopExecutor() *NoOpBatchingExecutor

func (*NoOpBatchingExecutor) BatchFor

func (n *NoOpBatchingExecutor) BatchFor(_ context.Context, _ string, _ time.Duration, exec Executer) (interface{}, error)

type Tracker

type Tracker interface {
	// Batched is called when a request is added to an existing batch.
	Batched()
}

type WaitFor

type WaitFor struct {
	// contains filtered or unexported fields
}

WaitFor holds a request and its original context.

type Waiters

type Waiters struct {
	// contains filtered or unexported fields
}

Waiters holds waiting requests.