queue

Documentation

Index

• type Queue
  • func New[T any]() *Queue[T]
  • func (q *Queue[T]) Cap() int
  • func (q *Queue[T]) Close()
  • func (q *Queue[T]) CloseRemaining() []T
  • func (q *Queue[T]) IsClosed() bool
  • func (q *Queue[T]) IsEmpty() bool
  • func (q *Queue[T]) Len() int
  • func (q *Queue[T]) Pop() (T, bool)
  • func (q *Queue[T]) Push(i T) bool
  • func (q *Queue[T]) Wait() (T, bool)

Types

type Queue

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

Queue thread-safe Queue using ring-buffer

func New

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

New creates an instance of Unbounded

func (*Queue[T]) Cap

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

Cap return the capacity (without allocations)

func (*Queue[T]) Close

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

Close the queue and discard all entries in the queue all goroutines in wait() will return

func (*Queue[T]) CloseRemaining

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

CloseRemaining will close the queue and return all entries in the queue. All goroutines in wait() will return.

func (*Queue[T]) IsClosed

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

IsClosed returns true if the queue has been closed The call cannot guarantee that the queue hasn't been closed while the function returns, so only "true" has a definite meaning.

func (*Queue[T]) IsEmpty

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

IsEmpty returns true when the queue is empty

func (*Queue[T]) Len

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

Len return the current length of the queue.

func (*Queue[T]) Pop

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

Pop removes the QueueItem from the front of the queue If false is returned, it either means 1) there were no items on the queue or 2) the queue is closed.

func (*Queue[T]) Push

func (q *Queue[T]) Push(i T) bool

Push adds an QueueItem to the back of the queue It can be safely called from multiple goroutines It will return false if the queue is closed. In that case the node is dropped.

func (*Queue[T]) Wait

func (q *Queue[T]) Wait() (T, bool)

Wait for an QueueItem to be added. If there is items on the queue the first will be returned immediately. Will return nil, false if the queue is closed. Otherwise, the return value of "remove" is returned.