syncqueue

package

v0.76.0 Latest Latest Go to latest Published: Oct 13, 2026 License: MIT Imports: 3 Imported by: 0

Details

Package syncqueue provides queues for concurrent use.

This section is empty.

View Source

var ErrEmpty = errors.New("empty queue")

This section is empty.

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

SyncQueue represents an unlimited FIFO queue which can be used to synchronize goroutines.

func New[T any]() *SyncQueue[T]

New returns a new SyncQueue.

func (q *SyncQueue[T]) Get(ctx context.Context) (T, error)

Get returns an item from the queue or waits until an item is available. The operation will be aborted when the provided context is canceled.

If there are multiple goroutines waiting it is undefined which one retrieves a new item.

func (q *SyncQueue[T]) GetNoWait() (T, error)

GetNoWait returns the item from the top of the queue or an error when the queue is empty.

func (q *SyncQueue[T]) IsEmpty() bool

IsEmpty reports whether the queue is empty.

func (q *SyncQueue[T]) Put(v T)

Put adds an item in the queue.

func (q *SyncQueue[T]) Size() int

Size returns the number of items in the queue.