lfg

README

Lock-free Generic Queue

This is a lock-free generic queue that can be enqueued and dequeued by multiple threads.

Documentation

Overview

Package lfg implements a lock-free, multiple-producer, multiple-consumer queue.

Index

• type Queue
  • func NewQueue[T any](size uint) *Queue[T]
  • func (b *Queue[T]) Dequeue() (T, bool)
  • func (b *Queue[T]) Enqueue(v T) bool

Types

type Queue

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

Queue[T any] is a lock-free, multiple-producer, multiple-consumer queue.

func NewQueue

func NewQueue[T any](size uint) *Queue[T]

NewQueue creates a new Queue[T any] with the given size. The size must be a power of two.

func (*Queue[T]) Dequeue

func (b *Queue[T]) Dequeue() (T, bool)

Dequeue removes an item from the queue. It returns false if the buffer is empty.

func (*Queue[T]) Enqueue

func (b *Queue[T]) Enqueue(v T) bool

Enqueue adds an item to the queue. It returns false if the buffer is full.