ringbuffer

Documentation

Index

• Variables
• type RingBuffer
  • func New[T any](size uint32) (*RingBuffer[T], error)
  • func (rb *RingBuffer[T]) Close()
  • func (rb *RingBuffer[T]) Read() (T, error)
  • func (rb *RingBuffer[T]) Write(value T) error
• type Slot

Variables

var (
	ErrQueueFull   = errors.New("queue is full")
	ErrInvalidSize = errors.New("size must be power of two")
)

Types

type RingBuffer

type RingBuffer[T any] struct {
	// contains filtered or unexported fields
}

RingBuffer represents the MPMC ring buffer

func New

func New[T any](size uint32) (*RingBuffer[T], error)

New creates a new MPMC ring buffer

func (*RingBuffer[T]) Close

func (rb *RingBuffer[T]) Close()

Close closes the ring buffer

func (*RingBuffer[T]) Read

func (rb *RingBuffer[T]) Read() (T, error)

Read reads data from the ring buffer by a consumer

func (*RingBuffer[T]) Write

func (rb *RingBuffer[T]) Write(value T) error

Write writes data into the ring buffer by a producer

type Slot

type Slot[T any] struct {
	// contains filtered or unexported fields
}

Slot represents a single slot in the ring buffer