Asynchronous version of retry(), for functions that return a
promise. It uses the same strategies and hooks, but
schedules the next attempt with later::later() instead of sleeping, so the
session is free between attempts.
Usage
async_retry(
f,
stop = stop_never(),
wait = wait_none(),
retry = retry_all(),
before_sleep = before_sleep_none(),
after_sleep = after_sleep_none(),
reraise = FALSE,
retry_error_callback = NULL
)Arguments
- f
The function to decorate. Usually supplied by
%@%rather than directly.- stop
A stop condition, e.g.
stop_after_attempt(). Defaults to never stopping.- wait
A wait strategy. Defaults to no waiting.
- retry
A retry condition. Defaults to retrying every error.
- before_sleep, after_sleep
Hooks run before and after each sleep, see
before_sleep_log()andafter_sleep_log().- reraise
If
TRUE, re-throw the last error whenstopfires instead of throwing afnware_retry_error.- retry_error_callback
Optional function called with the final state when
stopfires. Its return value is returned instead of throwing. The state is a list withattempt,wait,elapsed,errorandvalue.
Details
The decorated function returns a promise. It resolves with the first
acceptable result, and rejects with the last error, or a fnware_retry_error once
stop fires. The wrapped function may return a promise or a plain value, and
a rejection or a thrown error counts as a failure.
Use it as the outermost decorator. timeout() cannot bound a promise, so cap
each attempt with async_timeout(). The hooks and retry_error_callback run
in the event loop, so keep them quick. Needs the promises and later packages,
and an event loop for the promise to settle.
Examples
if (FALSE) { # \dontrun{
n <- 0
flaky <- function() {
n <<- n + 1
if (n < 3) stop("not yet")
n
}
f := async_retry(stop = stop_after_attempt(5), wait = wait_fixed(0.05)) %@%
flaky
promises::then(f(), function(value) cat("worked on attempt", value, "\n"))
# Shiny and plumber run the event loop for you. In a script, run it yourself.
while (!later::loop_empty()) later::run_now(0.1)
} # }
