Documentation
¶
Overview ¶
Package parallel contains implementations of various buffer types where the buffer can be consumed by any number of parallel consumer threads. Therefore, since it is possible for consumers to requeue a message if the propagation failed, it is possible for messages to be consumed out of sequence.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AckFunc ¶
AckFunc is a func returned when a message is read from a parallel buffer. The func should be called when the message is finished with, and a flag indicates whether the message was successfully propagated and can be removed from the buffer. Returns the current backlog of the buffer in bytes, or an error if the message was not successfully removed.
If an error is returned it is safe to call the function again. Otherwise, it is not.
It is safe to call this func even if the buffer has closed.
type Badger ¶
type Badger struct {
// contains filtered or unexported fields
}
Badger is a parallel buffer implementation that allows multiple parallel consumers to read and purge messages from a Badger embedded key/value store, where messages are persisted to disk.
func NewBadger ¶
func NewBadger(conf BadgerConfig) (*Badger, error)
NewBadger creates a Badger based parallel buffer.
func (*Badger) Close ¶
func (b *Badger) Close()
Close closes the Buffer so that blocked readers or writers become unblocked.
func (*Badger) CloseOnceEmpty ¶
func (b *Badger) CloseOnceEmpty()
CloseOnceEmpty closes the Buffer once the buffer has been emptied, this is a way for a writer to signal to a reader that it is finished writing messages, and therefore the reader can close once it is caught up. This call blocks until the close is completed.
func (*Badger) NextMessage ¶
NextMessage reads the next oldest message, the message is preserved until the returned AckFunc is called.
type BadgerConfig ¶
type BadgerConfig struct {
Directory string `json:"directory" yaml:"directory"`
SyncWrites bool `json:"sync_writes" yaml:"sync_writes"`
GCIntervalMS int `json:"gc_interval_ms" yaml:"gc_interval_ms"`
}
BadgerConfig contains configuration fields for a badger based buffer.
func NewBadgerConfig ¶
func NewBadgerConfig() BadgerConfig
NewBadgerConfig creates a BadgerConfig with default values.
type Memory ¶
type Memory struct {
// contains filtered or unexported fields
}
Memory is a parallel buffer implementation that allows multiple parallel consumers to read and purge messages from the buffer asynchronously.
func (*Memory) Close ¶
func (m *Memory) Close()
Close closes the Buffer so that blocked readers or writers become unblocked.
func (*Memory) CloseOnceEmpty ¶
func (m *Memory) CloseOnceEmpty()
CloseOnceEmpty closes the Buffer once the buffer has been emptied, this is a way for a writer to signal to a reader that it is finished writing messages, and therefore the reader can close once it is caught up. This call blocks until the close is completed.
func (*Memory) NextMessage ¶
NextMessage reads the next oldest message, the message is preserved until the returned AckFunc is called.
Source Files