queue

package

v0.0.0-...-b0bff92 Latest Latest Go to latest Published: Dec 7, 2021 License: AGPL-3.0 Imports: 4 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

Repository

github.com/DavinZhang/juju

Documentation ¶

Index ¶

Constants
Variables
func IsCanceled(err error) bool
func IsDeadlineExceeded(err error) bool
type OpQueue
- func NewOpQueue(clock clock.Clock) *OpQueue
type Operation

Constants ¶

View Source

const (
	// EnqueueTimeout is the timeout for enqueueing an operation. If an
	// operation can't be processed in the time, a ErrDeadlineExceeded is
	// returned.
	EnqueueTimeout time.Duration = time.Second * 3

	// EnqueueBatchSize dictates how many operations can be processed at any
	// one time.
	EnqueueBatchSize = 64
)

Variables ¶

View Source

var (
	// ErrDeadlineExceeded is a sentinel error for all exceeded deadlines for
	// operations.
	ErrDeadlineExceeded = deadlineExceededErr("enqueueing deadline exceeded")

	// ErrCanceled is a sentinel error for when the operation has been stopped.
	ErrCanceled = canceledErr("enqueueing canceled")
)

Functions ¶

func IsCanceled ¶

func IsCanceled(err error) bool

IsCanceled checks to see if the underlying error is a canceled error.

func IsDeadlineExceeded ¶

func IsDeadlineExceeded(err error) bool

IsDeadlineExceeded checks to see if the underlying error is a deadline exceeded error.

Types ¶

type OpQueue ¶

type OpQueue struct {
	// contains filtered or unexported fields
}

OpQueue holds the operations in a blocking queue. The purpose of this queue is to allow the backing off of operations at the source of enqueueing, and not at the consuming of the queue.

func (*OpQueue) Enqueue ¶

func (q *OpQueue) Enqueue(op Operation)

Enqueue will add an operation to the queue. As this is a blocking queue, any additional enqueue operations will block and wait for subsequent operations to be completed. The design of this is to ensure that people calling this will have to correctly handle backing off from enqueueing.

func (*OpQueue) Kill ¶

func (q *OpQueue) Kill(reason error)

Kill puts the tomb in a dying state for the given reason, closes the Dying channel, and sets Alive to false.

func (*OpQueue) Queue ¶

func (q *OpQueue) Queue() <-chan []Operation

Queue returns the queue of operations. Removing an item from the channel will unblock to allow another to take it's place.

func (*OpQueue) Wait ¶

func (q *OpQueue) Wait() error

Wait blocks until all goroutines have finished running, and then returns the reason for their death.

type Operation ¶

type Operation struct {
	Command []byte
	Done    func(error)
	Stop    func() <-chan struct{}
}

Operation holds the operations that a queue can hold.

Source Files ¶

View all Source files

opqueue.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL