A tiny util library for programs that require a little patience ⏰
Useful for simple cases where a predictable bool check should be ran
in a set interval and continue when it is satisfied.
import (
wait "github.com/asaf-shitrit/go-wait"
)
checkFunc := func() (bool, error) {
// any bool based logic that changes over a
// given period of time
}
ctx := context.Background() // or pass any ctx you would like
if err := wait.Until(ctx, checkFunc); err != nil {
// handle logical/timeout err
}
// logic that should happen after check is satisfiedimport (
wait "github.com/asaf-shitrit/go-wait"
)
checkFunc := func() (bool, error) {
// any bool based logic that changes over a
// given period of time
}
options := &wait.UntilOptions{
Timeout: time.Minute
Interval: time.Second
}
ctx := context.Background() // or pass any ctx you would like
if err := wait.Until(ctx, checkFunc, options); err != nil {
// handle logical/timeout err
}
// logic that should happen after check is satisfiedReally useful in cases that low CPU overhead a constraint and the check intervals should be backed off after each run.
It was inspired by Go's own http.Server Shutdown implementation ❤️
import (
wait "github.com/asaf-shitrit/go-wait"
)
checkFunc := func() (bool, error) {
// any bool based logic that changes over a
// given period of time
}
ctx := context.Background() // or pass any ctx you would like
if err := wait.Backoff(ctx, checkFunc); err != nil {
// handle logical/timeout err
}
// logic that should happen after check is satisfiedimport (
wait "github.com/asaf-shitrit/go-wait"
)
checkFunc := func() (bool, error) {
// any bool based logic that changes over a
// given period of time
}
options := &wait.BackoffOptions{
BaselineDuration: time.Millisecond,
Limit: 500 * time.Millisecond,
Multiplier: 2,
}
ctx := context.Background() // or pass any ctx you would like
if err := wait.Backoff(ctx, checkFunc, options); err != nil {
// handle logical/timeout err
}
// logic that should happen after check is satisfiedIt is aligned with Golang concept of context so explicit cancels & timeout will work out of the box.
Allows you to set an amount of jitter percentage that will apply for the calculation of each interval.