autoStopCluster: Automatically Stop a Cluster when Garbage Collected

View source: R/autoStopCluster.R

autoStopClusterR Documentation

Automatically Stop a Cluster when Garbage Collected

Description

Registers a finalizer to a cluster such that the cluster will be stopped when garbage collected

Usage

autoStopCluster(cl, debug = FALSE)

Arguments

cl

A cluster object created by for instance makeClusterPSOCK() or parallel::makeCluster().

debug

If TRUE, then debug messages are produced when the cluster is garbage collected.

Value

The cluster object with attribute gcMe set.

See Also

The cluster is stopped using stopCluster(cl).

Examples

cl <- makeClusterPSOCK(2, dryrun = TRUE)
cl <- autoStopCluster(cl)
print(cl)
rm(list = "cl")
gc()

parallelly documentation built on July 21, 2022, 5:11 p.m.