ringbuffer

Documentation

Overview

Package ringbuffer contains a ring buffer.

Index

• type RingBuffer
  • func New(size uint64) *RingBuffer
  • func (r *RingBuffer) Close()
  • func (r *RingBuffer) Pull() (interface{}, bool)
  • func (r *RingBuffer) Push(data interface{})
  • func (r *RingBuffer) Reset()

Types

type RingBuffer

type RingBuffer struct {
	// contains filtered or unexported fields
}

RingBuffer is a ring buffer.

func New

func New(size uint64) *RingBuffer

New allocates a RingBuffer.

func (*RingBuffer) Close

func (r *RingBuffer) Close()

Close makes Pull() return false.

func (*RingBuffer) Pull

func (r *RingBuffer) Pull() (interface{}, bool)

Pull pulls some data from the beginning of the buffer.

func (*RingBuffer) Push

func (r *RingBuffer) Push(data interface{})

Push pushes some data at the end of the buffer.

func (*RingBuffer) Reset

func (r *RingBuffer) Reset()

Reset restores Pull() after a Close().