cancel

Documentation

Index

• func NewWrappedContext(left, right context.Context) context.Context
• type Context
  • func New(ctx context.Context) Context
• type WrappedContext
  • func (w *WrappedContext) Done() <-chan struct{}
  • func (w *WrappedContext) Err() error
  • func (w *WrappedContext) Reason(err error)

Functions

func NewWrappedContext

func NewWrappedContext(left, right context.Context) context.Context

NewWrappedContext returns a Context that will be cancelled when either of the passed contexts are cancelled

Types

type Context

type Context interface {
	context.Context
	Wrap(context.Context) context.Context
	Cancel()
}

func New

func New(ctx context.Context) Context

New creates a context that wraps the given context and returns an obj that can be cancelled. This allows an object which desires to cancel a long running operation to store a single cancel.Context in it's struct variables instead of having to store both the context.Context and context.CancelFunc.

type WrappedContext

type WrappedContext struct {
	context.Context
	// contains filtered or unexported fields
}

func (*WrappedContext) Done

func (w *WrappedContext) Done() <-chan struct{}

func (*WrappedContext) Err

func (w *WrappedContext) Err() error

func (*WrappedContext) Reason

func (w *WrappedContext) Reason(err error)