execqueue

Documentation

Overview

Package execqueue implements an ordered asynchronous queue for executing functions.

Index

• type ExecQueue
  • func (q *ExecQueue) Add(f func())
  • func (q *ExecQueue) RunSync(ctx context.Context, f func()) error
  • func (q *ExecQueue) Shutdown()
  • func (q *ExecQueue) Wait(ctx context.Context) error

Types

type ExecQueue

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

func (*ExecQueue) Add

func (q *ExecQueue) Add(f func())

func (*ExecQueue) RunSync

func (q *ExecQueue) RunSync(ctx context.Context, f func()) error

RunSync waits for the queue to be drained and then synchronously runs f. It returns an error if the queue is closed before f is run or ctx expires.

func (*ExecQueue) Shutdown

func (q *ExecQueue) Shutdown()

Shutdown asynchronously signals the queue to stop.

func (*ExecQueue) Wait

func (q *ExecQueue) Wait(ctx context.Context) error

Wait waits for the queue to be empty.