ring

Documentation

Overview

Package ring provides a simple ring buffer for storing local data

Index

• type Buffer
  • func New(i int) *Buffer
  • func (b *Buffer) Get(n int) []*Entry
  • func (b *Buffer) Put(v interface{})
  • func (b *Buffer) Since(t time.Time) []*Entry
  • func (b *Buffer) Size() int
  • func (b *Buffer) Stream() (<-chan *Entry, chan bool)
• type Entry
• type Stream

Types

type Buffer

type Buffer struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Buffer is ring buffer

func New

func New(i int) *Buffer

New returns a new buffer of the given size

func (*Buffer) Get

func (b *Buffer) Get(n int) []*Entry

Get returns the last n entries

func (*Buffer) Put

func (b *Buffer) Put(v interface{})

Put adds a new value to ring buffer

func (*Buffer) Since

func (b *Buffer) Since(t time.Time) []*Entry

Return the entries since a specific time

func (*Buffer) Size

func (b *Buffer) Size() int

Size returns the size of the ring buffer

func (*Buffer) Stream

func (b *Buffer) Stream() (<-chan *Entry, chan bool)

Stream logs from the buffer Close the channel when you want to stop

type Entry

type Entry struct {
	Value     interface{}
	Timestamp time.Time
}

Entry is ring buffer data entry

type Stream

type Stream struct {
	// Id of the stream
	Id string
	// Buffered entries
	Entries chan *Entry
	// Stop channel
	Stop chan bool
}

Stream is used to stream the buffer