context

Documentation

Index

• func Cancel(ctx gocontext.Context)
• func CheckContext(ctx gocontext.Context) error
• func New(opts ...option) gocontext.Context
• func WithParent(parent gocontext.Context) option
• func WithTimeout(timeout time.Duration) option

Functions

func Cancel

func Cancel(ctx gocontext.Context)

Cancels the context if a CancelFunc is stored in the context.

func CheckContext

func CheckContext(ctx gocontext.Context) error

CheckContext checks if a go context is still active or done When it's done, returns a generic error

func myFunc(ctx context.Context) error {
  if err := common.CheckContext(ctx); err != nil {
  	 return err
  } else {
    doSomething()
  }
}

func New

func New(opts ...option) gocontext.Context

New creates a new golang context with the provided options. If a parent context is provided, creates a copy of the parent with further options. If a timeout option is provided, creates a context that cancels itself automatically after the timeout.

func WithParent

func WithParent(parent gocontext.Context) option

WithParent returns an option to create a new context based on an existing parent context.

func WithTimeout

func WithTimeout(timeout time.Duration) option

WithTimeout return an option to create a new context that cancels itself automatically after the timeout.