Documentation
¶
Index ¶
- func New(batcher *policy.Batcher, child input.Streamed, log log.Modular) input.Streamed
- type Impl
- func (m *Impl) ConnectionStatus() component.ConnectionStatuses
- func (m *Impl) ConnectionTest(ctx context.Context) component.ConnectionTestResults
- func (m *Impl) TransactionChan() <-chan message.Transaction
- func (m *Impl) TriggerCloseNow()
- func (m *Impl) TriggerStartConsuming()
- func (m *Impl) TriggerStopConsuming()
- func (m *Impl) WaitForClose(ctx context.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Impl ¶
type Impl struct {
// contains filtered or unexported fields
}
Impl wraps an input with a batch policy.
func (*Impl) ConnectionStatus ¶ added in v4.31.0
func (m *Impl) ConnectionStatus() component.ConnectionStatuses
ConnectionStatus returns the current status of the given component connection. The result is a slice in order to accommodate higher order components that wrap several others.
func (*Impl) ConnectionTest ¶ added in v4.63.0
func (m *Impl) ConnectionTest(ctx context.Context) component.ConnectionTestResults
ConnectionTest attempts to establish whether the component is capable of creating a connection. This will potentially require and test network connectivity, but does not require the component to be initialized.
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) TriggerStartConsuming ¶ added in v4.63.0
func (m *Impl) TriggerStartConsuming()
TriggerStartConsuming kicks off the consumption of data.
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.
Source Files