The highest tagged major version is
Documentation
¶
Overview ¶
Package buffer links an input and an output together and buffers messages in between.
Index ¶
- Variables
- func Descriptions() string
- func SanitiseConfig(conf Config) (interface{}, error)
- type Config
- type Empty
- type OutputWrapper
- type Type
- func New(conf Config, log log.Modular, stats metrics.Type) (Type, error)
- func NewEmpty(config Config, log log.Modular, stats metrics.Type) (Type, error)
- func NewMemory(config Config, log log.Modular, stats metrics.Type) (Type, error)
- func NewMmapFile(config Config, log log.Modular, stats metrics.Type) (Type, error)
- func NewOutputWrapper(conf Config, buffer impl.Buffer, stats metrics.Type) Type
- type TypeSpec
Constants ¶
This section is empty.
Variables ¶
var Constructors = map[string]TypeSpec{}
Constructors is a map of all buffer types with their specs.
Functions ¶
func Descriptions ¶
func Descriptions() string
Descriptions returns a formatted string of collated descriptions of each type.
func SanitiseConfig ¶ added in v0.8.4
SanitiseConfig returns a sanitised version of the Config, meaning sections that aren't relevant to behaviour are removed.
Types ¶
type Config ¶
type Config struct {
Type string `json:"type" yaml:"type"`
Memory impl.MemoryConfig `json:"memory" yaml:"memory"`
Mmap impl.MmapBufferConfig `json:"mmap_file" yaml:"mmap_file"`
None struct{} `json:"none" yaml:"none"`
}
Config is the all encompassing configuration struct for all input types.
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
Empty is an empty buffer, simply forwards messages on directly.
func (*Empty) CloseAsync ¶
func (e *Empty) CloseAsync()
CloseAsync shuts down the StackBuffer output and stops processing messages.
func (*Empty) ErrorsChan ¶
ErrorsChan returns the errors channel.
func (*Empty) StartReceiving ¶
func (e *Empty) StartReceiving(msgs <-chan types.Transaction) error
StartReceiving assigns a messages channel for the output to read.
func (*Empty) TransactionChan ¶ added in v0.9.0
func (e *Empty) TransactionChan() <-chan types.Transaction
TransactionChan returns the channel used for consuming messages from this input.
type OutputWrapper ¶ added in v0.2.1
type OutputWrapper struct {
// contains filtered or unexported fields
}
OutputWrapper wraps a buffer with a Producer/Consumer interface.
func (*OutputWrapper) CloseAsync ¶ added in v0.2.1
func (m *OutputWrapper) CloseAsync()
CloseAsync shuts down the OutputWrapper and stops processing messages.
func (*OutputWrapper) ErrorsChan ¶ added in v0.2.1
func (m *OutputWrapper) ErrorsChan() <-chan []error
ErrorsChan returns the errors channel.
func (*OutputWrapper) StartReceiving ¶ added in v0.2.1
func (m *OutputWrapper) StartReceiving(msgs <-chan types.Transaction) error
StartReceiving assigns a messages channel for the output to read.
func (*OutputWrapper) TransactionChan ¶ added in v0.9.0
func (m *OutputWrapper) TransactionChan() <-chan types.Transaction
TransactionChan returns the channel used for consuming messages from this input.
func (*OutputWrapper) WaitForClose ¶ added in v0.2.1
func (m *OutputWrapper) WaitForClose(timeout time.Duration) error
WaitForClose blocks until the OutputWrapper output has closed down.
type Type ¶
type Type interface {
types.Producer
types.Consumer
types.Closable
// ErrorsChan returns the channel used for returning any accumulated errors.
// This needs reading in the same select block where messages are sent as
// the errors can occur at any time.
ErrorsChan() <-chan []error
}
Type is the standard interface of an agent type.
func NewMmapFile ¶
NewMmapFile creates a buffer held in memory and persisted to file through memory map.
Source Files
Directories