queue

Documentation

Index

• type Queue
  • func New[T any]() *Queue[T]
  • func (q *Queue[T]) Get() T
  • func (q *Queue[T]) GetWithContext(ctx context.Context) (T, error)
  • func (q *Queue[T]) Len() int
  • func (q *Queue[T]) Put(t T)

Types

type Queue

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

Queue is a thread-safe queue.

func New

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

New creates a new queue.

func (*Queue[T]) Get

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

Get removes and returns an element from the queue. If the queue is empty, then Get will block until an element is available.

func (*Queue[T]) GetWithContext

func (q *Queue[T]) GetWithContext(ctx context.Context) (T, error)

GetWithContext removes and returns an element from the queue. If the queue is empty, then Get will block until an element is available or the context is canceled. This routine is relatively expensive---don't use it for a high throughput queue. Instead, you should probably just use a channel.

func (*Queue[T]) Len

func (q *Queue[T]) Len() int

Len returns the number of elements in the queue.

func (*Queue[T]) Put

func (q *Queue[T]) Put(t T)

Put adds an element to the queue.