mpsc

package

v1.10.1 Latest Latest Go to latest Published: Jan 29, 2024 License: MIT Imports: 2 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 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.

This section is empty.

This section is empty.

This section is empty.

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

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

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

Empty returns true if the queue is empty

Empty must be called from a single, consumer goroutine

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 (q *Queue[T]) Push(x T)

Push adds x to the back of the queue.

Push can be safely called from multiple goroutines