ring

package

v1.0.2 Latest Latest Go to latest Published: Nov 30, 2023 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause, + 2 more Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package ring provides a concurrent-safe circular queue, supports multiple read/write.

This section is empty.

View Source

var (
	// ErrQueueFull happens when the queue is full.
	ErrQueueFull = errors.New("queue is full")
)

This section is empty.

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

Ring a concurrent-safe circular queue, based on the idea of Disruptor(simplified). https://lmax-exchange.github.io/disruptor/disruptor.html

func New[T any](capacity uint32) *Ring[T]

New creates a circular queue.

func (r *Ring[T]) Cap() uint32

Cap retrieves the number of elements the circular queue can hold.

func (r *Ring[T]) Get() (T, uint32)

Get gets an element from the circular queue, return element value and the remaining number of elements.

func (r *Ring[T]) Gets(val *[]T) (uint32, uint32)

Gets acquires elements from the circular queue and appends then into v, return the number of elements acquired and remained.

func (r *Ring[T]) IsEmpty() bool

IsEmpty checks whether the queue is empty.

func (r *Ring[T]) IsFull() bool

IsFull checks whether the queue is full.

func (r *Ring[T]) Put(val T) error

Put puts element into the circular queue. Directly return if the queue is full.

func (r *Ring[T]) Size() uint32

Size retrieves the number of elements in the circular queue.

func (r *Ring[T]) String() string

String prints the structure of Ring.