queue

README

queue

About

This package provides generic queues. It is published on https://github.com/vbsw/queue.

Copyright

Copyright 2021 Vitali Baumtrok (vbsw@mailbox.org).

queue is distributed under the Boost Software License, version 1.0. (See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)

queue is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Boost Software License for more details.

Example

Code:

package main

import (
	"fmt"
	"github.com/vbsw/queue"
)

func main() {
	simpleQueue := queue.New(2)
	simpleQueue.Put("hi")
	simpleQueue.Put(10)
	fmt.Println(simpleQueue.First(), simpleQueue.First(), simpleQueue.First())
}

Output:

$ hi 10 <nil>

References

• https://golang.org/doc/install
• https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Documentation

Overview

Package queue provides generic queues.

Index

• type Queue
  • func New(capacity int) Queue
  • func NewSynchronized(capacity int) Queue

Types

type Queue

type Queue interface {
	Put(interface{})
	PutAll(...interface{})
	First() interface{}
	All() []interface{}
	Size() int
}

Queue is a "First In, First Out" buffer.

func New

func New(capacity int) Queue

New returns a new queue. If capacity is negative, capacity is set to zero. If capacity is zero, queue is initialized with capacity of 8 at first write.

func NewSynchronized

func NewSynchronized(capacity int) Queue

NewSynchronized returns a new thread safe queue. If capacity is negative, capacity is set to zero. If capacity is zero, queue is initialized with capacity of 8 at first write.