batcher

Documentation

Index

• func New(batcher *policy.Batcher, child input.Streamed, log log.Modular, ...) input.Streamed
• type Impl
  • func (m *Impl) Connected() bool
  • func (m *Impl) TransactionChan() <-chan message.Transaction
  • func (m *Impl) TriggerCloseNow()
  • func (m *Impl) TriggerStopConsuming()
  • func (m *Impl) WaitForClose(ctx context.Context) error

Functions

func New

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

New creates a new Batcher around an input.

Types

type Impl

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

Impl wraps an input with a batch policy.

func (*Impl) Connected

func (m *Impl) Connected() bool

Connected returns true if the underlying input is connected.

func (*Impl) TransactionChan

func (m *Impl) TransactionChan() <-chan message.Transaction

TransactionChan returns the channel used for consuming messages from this buffer.

func (*Impl) TriggerCloseNow

func (m *Impl) TriggerCloseNow()

TriggerCloseNow triggers the shut down of this component but should not block the calling goroutine.

func (*Impl) TriggerStopConsuming

func (m *Impl) TriggerStopConsuming()

TriggerStopConsuming instructs the input to start shutting down resources once all pending messages are delivered and acknowledged. This call does not block.

func (*Impl) WaitForClose

func (m *Impl) WaitForClose(ctx context.Context) error

WaitForClose is a blocking call to wait until the component has finished shutting down and cleaning up resources.