cancel

Documentation

Index

• func NewWithTimeout(ctx context.Context, d time.Duration, f TimeoutedFunc) error
• func Wait(ctx context.Context, ch chan error) error
• type TimeoutedFunc
• type WaitFunc
  • func New(ctx context.Context, d time.Duration) (context.Context, chan error, context.CancelFunc, WaitFunc)

Functions

func NewWithTimeout

func NewWithTimeout(ctx context.Context, d time.Duration, f TimeoutedFunc) error

NewWithTimeout creates a new context with a timeout and runs the given function with the context. It returns an error if the function returns an error or if the context times out.

func Wait

func Wait(ctx context.Context, ch chan error) error

Wait waits for the context to be done.

Types

type TimeoutedFunc

type TimeoutedFunc func(ctx context.Context) error

TimeoutedFunc is a function that takes a context and returns an error. It is used to run a function with a timeout.

type WaitFunc

type WaitFunc func() error

WaitFunc is a function that waits for the context to be done. It is used to wait for the context to be done before returning.

func New

func New(ctx context.Context, d time.Duration) (context.Context, chan error, context.CancelFunc, WaitFunc)

New creates a new context with a timeout and returns a channel to send the result and a function to cancel the context. It also returns a function that waits for the context to be done before returning.