limitring

Documentation

Index

• Constants
• Variables
• type Ring
  • func New(n uint64) *Ring
  • func (r *Ring) Pop() (data unsafe.Pointer, ok bool)
  • func (r *Ring) Push(data unsafe.Pointer) error

Constants

const (
	MinCap = 1 << 7
	MaxCap = 1 << 20
)

Variables

var ErrCollision = errors.New("ring buffer collision, retry later")

var ErrOverflow = errors.New("ring buffer overflow, retry later after Pop")

Types

type Ring

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

Ring is optimal for many writers (go-routines B-n) and a single reader (go-routine A). It is not thread safe for multiple readers.

func New

func New(n uint64) *Ring

New creates a new diode (ring buffer). The Ring diode is optimized for many writers (on go-routines B-n) and a single reader (on go-routine A).

ring size = 2 ^ x.

func (*Ring) Pop

func (r *Ring) Pop() (data unsafe.Pointer, ok bool)

Pop will attempt to read from the next slot of the ring buffer. If there is no data available, it will return (nil, false).

func (*Ring) Push

func (r *Ring) Push(data unsafe.Pointer) error

Push pushes the data in the next slot of the ring buffer. If Ring is almost full or there is a collision, return error.