mpsc

Documentation

Overview

Package mpsc provides an efficient implementation of a multi-producer, single-consumer lock-free queue.

The Push function is safe to call from multiple goroutines. The Pop and Empty APIs must only be called from a single, consumer goroutine.

Index

• type Queue
  • func New[T any]() *Queue[T]
  • func (q *Queue[T]) Empty() bool
  • func (q *Queue[T]) Pop() T
  • func (q *Queue[T]) Push(x T)

Types

type Queue

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

func New

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

func (*Queue[T]) Empty

func (q *Queue[T]) Empty() bool

Empty returns true if the queue is empty

Empty must be called from a single, consumer goroutine

func (*Queue[T]) Pop

func (q *Queue[T]) Pop() T

Pop removes the item from the front of the queue or nil if the queue is empty

Pop must be called from a single, consumer goroutine

func (*Queue[T]) Push

func (q *Queue[T]) Push(x T)

Push adds x to the back of the queue.

Push can be safely called from multiple goroutines