await.CallrFuture: Awaits the result of a callr future

Description Usage Arguments Details Value

Description

Awaits the result of a callr future

Usage

1
2
3
4
5
## S3 method for class 'CallrFuture'
await(future,
  timeout = getOption("future.wait.timeout", 30 * 24 * 60 * 60),
  delta = getOption("future.wait.interval", 1),
  alpha = getOption("future.wait.alpha", 1.01), ...)

Arguments

future

The future.

timeout

Total time (in seconds) waiting before generating an error.

delta

The number of seconds to wait between each poll.

alpha

A factor to scale up the waiting time in each iteration such that the waiting time in the k:th iteration is alpha ^ k * delta.

...

Not used.

Details

Note that await() should only be called once, because after being called the actual asynchronous future may be removed and will no longer available in subsequent calls. If called again, an error may be thrown.

Value

The FutureResult of the evaluated expression. If an error occurs, an informative Exception is thrown.


future.callr documentation built on Sept. 28, 2019, 9:03 a.m.