Registers a function to be called when the R garbage collector is (detected to be) running

Registers a function to be called when the R garbage collector is (detected to be) running.

# S3 method for default
onGarbageCollect(fcn, action=c("prepend", "append", "replace"), ...)

Arguments

fcn

A function to be called without argument.

action

A character string specifying how the hook function is added to list of hooks.

...

Not used.

Value

Returns (invisibly) the hooks successfully called.

Author

Henrik Bengtsson

Examples

if (FALSE) {
  onGarbageCollect(function(...) {
    message("The R garbage collector is running!")
  })
}