batch

Documentation

Overview

Package batch contains internal utilities for interacting with message batches.

Package batch contains internal utilities for interacting with message batches.

Index

• func CollapsedCount(p *message.Part) int
• func CtxCollapsedCount(ctx context.Context) int
• func CtxWithCollapsedCount(ctx context.Context, count int) context.Context
• func MessageCollapsedCount(m message.Batch) int
• func WithCollapsedCount(p *message.Part, count int) *message.Part
• type AckFunc
• type CombinedAcker
  • func NewCombinedAcker(aFn AckFunc) *CombinedAcker
  • func (c *CombinedAcker) Derive() AckFunc
• type Error
  • func NewError(msg message.Batch, err error) *Error
  • func (e *Error) Error() string
  • func (e *Error) Failed(i int, err error) *Error
  • func (e *Error) IndexedErrors() int
  • func (e *Error) Unwrap() error
  • func (e *Error) WalkParts(fn func(int, *message.Part, error) bool)
• type WalkableError

Functions

func CollapsedCount

func CollapsedCount(p *message.Part) int

CollapsedCount attempts to extract the actual number of messages that were collapsed into the resulting message part. This value could be greater than 1 when users configure processors that archive batched message parts.

func CtxCollapsedCount

func CtxCollapsedCount(ctx context.Context) int

CtxCollapsedCount attempts to extract the actual number of messages that were collapsed into the resulting message part. This value could be greater than 1 when users configure processors that archive batched message parts.

func CtxWithCollapsedCount

func CtxWithCollapsedCount(ctx context.Context, count int) context.Context

CtxWithCollapsedCount returns a message part with a context indicating that this message is the result of collapsing a number of messages. This allows downstream components to know how many total messages were combined.

func MessageCollapsedCount

func MessageCollapsedCount(m message.Batch) int

MessageCollapsedCount attempts to extract the actual number of messages that were combined into the resulting batched message parts. This value could differ from message.Len() when users configure processors that archive batched message parts.

func WithCollapsedCount

func WithCollapsedCount(p *message.Part, count int) *message.Part

WithCollapsedCount returns a message part with a context indicating that this message is the result of collapsing a number of messages. This allows downstream components to know how many total messages were combined.

Types

type AckFunc

type AckFunc func(context.Context, error) error

AckFunc is a common function signature for acknowledging receipt of messages.

type CombinedAcker

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

CombinedAcker creates a single ack func closure that aggregates one or more derived closures such that only once each derived closure is called the singular ack func will trigger. If at least one derived closure receives an error the singular ack func will send the first non-nil error received.

func NewCombinedAcker

func NewCombinedAcker(aFn AckFunc) *CombinedAcker

NewCombinedAcker creates an aggregated that derives one or more ack funcs that, once all of which have been called, the provided root ack func is called.

func (*CombinedAcker) Derive

func (c *CombinedAcker) Derive() AckFunc

Derive creates a new ack func that must be called before the origin ack func will be called. It is invalid to derive an ack func after any other previously derived funcs have been called.

type Error

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

Error is an error type that also allows storing granular errors for each message of a batch.

func NewError

func NewError(msg message.Batch, err error) *Error

NewError creates a new batch-wide error, where it's possible to add granular errors for individual messages of the batch.

func (*Error) Error

func (e *Error) Error() string

Error implements the common error interface.

func (*Error) Failed

func (e *Error) Failed(i int, err error) *Error

Failed stores an error state for a particular message of a batch. Returns a pointer to the underlying error, allowing with method to be chained.

If Failed is not called then all messages are assumed to have failed. If it is called at least once then all message indexes that aren't explicitly failed are assumed to have been processed successfully.

func (*Error) IndexedErrors

func (e *Error) IndexedErrors() int

IndexedErrors returns the number of indexed errors that have been registered for the batch.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns the underlying common error.

func (*Error) WalkParts

func (e *Error) WalkParts(fn func(int, *message.Part, error) bool)

WalkParts applies a closure to each message that was part of the request that caused this error. The closure is provided the message part index, a pointer to the part, and its individual error, which may be nil if the message itself was processed successfully. The closure returns a bool which indicates whether the iteration should be continued.

type WalkableError

type WalkableError interface {
	WalkParts(fn func(int, *message.Part, error) bool)
	IndexedErrors() int
	error
}

WalkableError is an interface implemented by batch errors that allows you to walk the messages of the batch and dig into the individual errors.