autoStopCluster: Automatically Stop a Cluster when Garbage Collected

In parallelly: Enhancing the 'parallel' Package

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.

Details

The cluster is stopped using stopCluster(cl). An alternative to explicitly call this function on an existing cluster object, is to create the cluster object using makeClusterPSOCK() with argument autoStop = TRUE.

Value

The cluster object with attribute gcMe set.

Examples

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

parallelly documentation built on May 31, 2023, 5:46 p.m.