ctxutil

Documentation

Overview

Package ctxutil provides context helpers.

Index

• func SigTerm(parent context.Context) (context.Context, context.CancelFunc)
• func Sleep(ctx context.Context, d time.Duration)
• func SleepWithJitter(ctx context.Context, d time.Duration, attempts int64)
• func WithDelay(done <-chan struct{}, delay time.Duration) (context.Context, context.CancelFunc)

Functions

func SigTerm

func SigTerm(parent context.Context) (context.Context, context.CancelFunc)

SigTerm returns a copy of the parent context that is marked done (its Done channel is closed) when termination signal arrives, when the returned stop function is called, or when the parent context's Done channel is closed, whichever happens first.

func Sleep

func Sleep(ctx context.Context, d time.Duration)

Sleep pauses the current goroutine until d has passed or ctx is canceled.

func SleepWithJitter

func SleepWithJitter(ctx context.Context, d time.Duration, attempts int64)

SleepWithJitter pauses the current goroutine until d + jitter has passed or ctx is canceled.

func WithDelay

func WithDelay(done <-chan struct{}, delay time.Duration) (context.Context, context.CancelFunc)

WithDelay returns a context that is canceled after a given amount of time after done channel is closed.