waitctx

Documentation

Index

• Variables
• func Background() context.Context
• func FromContext(ctx context.Context) context.Context
• func RecoverTimeout()
• type PermissiveContext
• type RestrictiveContext
• type WaitContextInterface

Variables

var (
	Restrictive = restrictive{}
	Permissive  = permissive{}

	AddOne          = Restrictive.AddOne
	Done            = Restrictive.Done
	Wait            = Restrictive.Wait
	WaitWithTimeout = Restrictive.WaitWWithTimeout
	Go              = Restrictive.Go
)

Functions

func Background

func Background() context.Context

func FromContext

func FromContext(ctx context.Context) context.Context

func RecoverTimeout

func RecoverTimeout()

Types

type PermissiveContext

type PermissiveContext = context.Context

type RestrictiveContext

type RestrictiveContext = context.Context

type WaitContextInterface

type WaitContextInterface interface {
	AddOne(ctx context.Context)
	Done(ctx context.Context)
	Wait(ctx context.Context, notifyAfter ...time.Duration)

	// Go runs the given function in a background goroutine, and adds it to the
	// WaitContext. Shorthand for the following pattern:
	//  waitctx.AddOne(ctx)
	//  go func() {
	//    defer waitctx.Done(ctx)
	//    // do stuff
	//  }()
	Go(ctx context.Context, fn func())
}