batcher

Documentation

Index

• func New(batcher *policy.Batcher, child output.Streamed, log log.Modular, ...) output.Streamed
• func NewFromConfig(conf batchconfig.Config, child output.Streamed, mgr bundle.NewManagement, ...) (output.Streamed, error)
• type Impl
  • func (m *Impl) CloseAsync()
  • func (m *Impl) Connected() bool
  • func (m *Impl) Consume(msgs <-chan message.Transaction) error
  • func (m *Impl) WaitForClose(timeout time.Duration) error

Functions

func New

func New(
	batcher *policy.Batcher,
	child output.Streamed, log log.Modular,
	stats metrics.Type,
) output.Streamed

New creates a new output preceded by a batching mechanism that enforces a given batching policy.

func NewFromConfig

func NewFromConfig(
	conf batchconfig.Config,
	child output.Streamed, mgr bundle.NewManagement,
	log log.Modular,
	stats metrics.Type,
) (output.Streamed, error)

NewFromConfig creates a new output preceded by a batching mechanism that enforces a given batching policy configuration.

Types

type Impl

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

Impl wraps an output with a batching policy.

func (*Impl) CloseAsync

func (m *Impl) CloseAsync()

CloseAsync shuts down the Batcher and stops processing messages.

func (*Impl) Connected

func (m *Impl) Connected() bool

Connected returns a boolean indicating whether this output is currently connected to its target.

func (*Impl) Consume

func (m *Impl) Consume(msgs <-chan message.Transaction) error

Consume assigns a messages channel for the output to read.

func (*Impl) WaitForClose

func (m *Impl) WaitForClose(timeout time.Duration) error

WaitForClose blocks until the Batcher output has closed down.