Skip to contents

timeout() hands the work of enforcing a limit to a method. timeout_r(), which uses setTimeLimit(), is the built-in. To add another, for example one that runs the call in a separate process and kills it, make an S7 class that inherits from timeout_base and register a method for timeout_fn() with S7::method<-().

Usage

timeout_base()

timeout_fn(class, call, seconds, ...)

Arguments

class

A timeout method object. Methods are dispatched on this argument.

call

A function of no arguments that runs the decorated function.

seconds

Seconds left before the effective deadline.

...

Passed to methods.

Value

timeout_fn() returns the value of call().

Details

timeout_fn(class, call, seconds) gets call, a function of no arguments that runs the decorated function, and seconds, the time left before the effective deadline. It must return the value of call() unchanged, or signal a fnware_timeout_error when seconds run out. timeout() adds the function name and limit to the message, and signals a fnware_timeout_method_error if call() ran but the method returned something else or swallowed its error. Other errors should propagate.

A method that runs call() in another process cannot be checked for this, and timeout_remaining() does not see the parent's deadline there. Set the environment variable FNWARE_TIMEOUT_DEADLINE in the child to as.numeric(Sys.time()) + seconds to pass it on. The retry vignette shows a callr method that does. Packages that register methods need S7::methods_register() in .onLoad().

Examples

library(S7)

# Report the time allowed, then run the call without enforcing anything
timeout_log <- new_class("timeout_log", parent = timeout_base)

method(timeout_fn, timeout_log) <- function(class, call, seconds, ...) {
  message("allowing ", format(seconds), " seconds")
  call()
}

f := timeout(3, method = timeout_log()) %@% function() "ok"
f()
#> allowing 3 seconds
#> [1] "ok"