rivercommon

Documentation

Index

• Constants
• Variables
• type ContextKeyClient

Constants

const (
	// AllQueuesString is a special string that can be used to indicate all
	// queues in some operations, particularly pause and resume.
	AllQueuesString    = "*"
	MaxAttemptsDefault = 25
	PriorityDefault    = 1
	QueueDefault       = "default"
)

These constants are made available in rivercommon so that they're accessible by internal packages, but the top-level river package re-exports them, and all user code must use that set instead.

Variables

var ErrShutdown = errors.New("shutdown initiated")

ErrShutdown is a special error injected by the client into its fetch and work CancelCauseFuncs when it's stopping. It may be used by components for such cases like avoiding logging an error during a normal shutdown procedure. This is internal for the time being, but we could also consider exposing it.

Types

type ContextKeyClient

type ContextKeyClient struct{}