cancellablecontext

Documentation

Overview

Package cancellablecontext is a wrapper around context.WithCancel that exposes context.CancelFunc as a receiver.

This is just a convenience package that makes passing a cancellable context to child services easier, as with this you only have to pass a CancellableContext to a child, rather than both a context.Context and a context.CancelFunc.

Index

• type API
  • func New(parentCtx context.Context) *API
  • func (c *API) Cancel()

Types

type API

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

API is a context that can broadcast cancellation.

func New

func New(parentCtx context.Context) *API

New returns a reference to a new CancellableContext.

func (*API) Cancel

func (c *API) Cancel()

Cancel calls the context.CancelFunc, initializing a cancellation of all listeners.