ctxutil

Documentation

Overview

Package ctxutil provides context helpers.

Index

• func DurationWithJitter(cap time.Duration, attempt int64) time.Duration
• 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 DurationWithJitter

func DurationWithJitter(cap time.Duration, attempt int64) time.Duration

DurationWithJitter returns an exponential backoff duration based on attempt with random "full jitter". https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/

The maximum sleep is the cap. The minimum sleep is at least 3 milliseconds. Provided cap must be larger than minimum sleep, and attempt number must be a positive number.

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.