buffer

README

go-buffer

Documentation

Index

• Variables
• type Buffer
  • func New(size uint, flusher func([]interface{}), opts ...Option) (*Buffer, error)
  • func (buffer *Buffer) Close() error
  • func (buffer *Buffer) Flush() error
  • func (buffer *Buffer) Push(item interface{}) error
• type Option
  • func WithAutoFlush(interval time.Duration) Option
  • func WithCloseTimeout(timeout time.Duration) Option
  • func WithFlushTimeout(timeout time.Duration) Option
  • func WithPushTimeout(timeout time.Duration) Option
• type Options

Variables

var (
	ErrFull             = errors.New("buffer is full")
	ErrOperationTimeout = errors.New("operation timed-out")
)

Types

type Buffer

type Buffer struct {
	io.Closer
	// contains filtered or unexported fields
}

Buffer represents a data buffer that is asynchronously flushed, either manually or automatically.

func New

func New(size uint, flusher func([]interface{}), opts ...Option) (*Buffer, error)

New creates a new buffer instance

func (*Buffer) Close

func (buffer *Buffer) Close() error

Close flushes the buffer and prevents it from being further used.

func (*Buffer) Flush

func (buffer *Buffer) Flush() error

Flush outputs the buffer to a permanent destination. It might return an error if the buffer is already being flushed.

func (*Buffer) Push

func (buffer *Buffer) Push(item interface{}) error

Push appends an item to the end of the Buffer. It might return an error if the buffer is full.

type Option

type Option func(*Options)

func WithAutoFlush

func WithAutoFlush(interval time.Duration) Option

func WithCloseTimeout

func WithCloseTimeout(timeout time.Duration) Option

func WithFlushTimeout

func WithFlushTimeout(timeout time.Duration) Option

func WithPushTimeout

func WithPushTimeout(timeout time.Duration) Option

type Options

type Options struct {
	AutoFlush         bool
	AutoFlushInterval time.Duration
	PushTimeout       time.Duration
	FlushTimeout      time.Duration
	CloseTimeout      time.Duration
}