task

Documentation

Overview

Package task implements async task handling.

Index

• func NewWithContext(ctx context.Context) context.Context
• func WithContext(ctx context.Context, m Manager) context.Context
• type Manager
  • func FromContext(ctx context.Context) Manager
  • func New() Manager
• type Task

Functions

func NewWithContext

func NewWithContext(ctx context.Context) context.Context

NewWithContext derives a Context that carries a new Manager

func WithContext

func WithContext(ctx context.Context, m Manager) context.Context

WithContext derives a Context that carries the given Manager from ctx.

Types

type Manager

type Manager interface {

	// Start begins running background tasks with the provided context.
	Start(context.Context)

	// Run enqueues the task to run in the background.
	Run(Task)

	// RunFinalizer enqueues the task to run in the background after Shutdown.
	RunFinalizer(Task)

	// Shutdown instructs all the tasks to shutdown and waits until they've done
	// so.
	Shutdown()

	// ShutdownWithTimeout instructs all the tasks to shutdown and waits up until the timeout for them to complete.
	ShutdownWithTimeout(time.Duration)
	// contains filtered or unexported methods
}

Manager implements a task manager.

func FromContext

func FromContext(ctx context.Context) Manager

FromContext returns the Manager ctx carries. It panics in case ctx carries no Manager.

func New

func New() Manager

New initializes and returns a Manager which runs its tasks on the chain of the given parent context.

type Task

type Task func(context.Context)

Task wraps the set of tasks.