queue

README

A priority queue written in Go that signals using channels

Installation

go get -v -u github.com/caffix/queue@master

Licensing

This program is free software: you can redistribute it and/or modify it under the terms of the Apache license.

Documentation

Index

• type Queue
  • func NewQueue() Queue
• type QueuePriority

Types

type Queue

type Queue interface {
	// Append adds the data to the Queue at priority level PriorityNormal.
	Append(data interface{})

	// AppendPriority adds the data to the Queue with respect to priority.
	AppendPriority(data interface{}, priority QueuePriority)

	// Signal returns the Queue signal channel.
	Signal() <-chan struct{}

	// Next returns the data at the front of the Queue.
	Next() (interface{}, bool)

	// Process will execute the callback parameter for each element on the Queue.
	Process(callback func(interface{}))

	// Empty returns true if the Queue is empty.
	Empty() bool

	// Len returns the current length of the Queue.
	Len() int
}

Queue implements a FIFO data structure that can support a few priorities.

func NewQueue

func NewQueue() Queue

NewQueue returns an initialized Queue.

type QueuePriority

type QueuePriority int

const (
	PriorityLow      QueuePriority = 0
	PriorityNormal   QueuePriority = 1
	PriorityHigh     QueuePriority = 2
	PriorityCritical QueuePriority = 3
)

The priority levels for the priority Queue.