crew_class_launcher_cluster {crew.cluster} | R Documentation |
Abstract cluster launcher class
Description
R6
class to help develop specific cluster launcher plugins.
Details
Attribution
The template files at
https://github.com/mschubert/clustermq/tree/master/inst
informed the development of the crew
launcher plugins in
crew.cluster
, and we would like to thank
Michael Schubert for developing clustermq
and releasing it under
the permissive Apache License 2.0.
See the NOTICE
and README.md
files in the crew.cluster
source code for additional attribution.
Super class
crew::crew_class_launcher
-> crew_class_launcher_cluster
Active bindings
options_cluster
Methods
Public methods
Inherited methods
crew::crew_class_launcher$call()
crew::crew_class_launcher$crashes()
crew::crew_class_launcher$launch()
crew::crew_class_launcher$poll()
crew::crew_class_launcher$resolve()
crew::crew_class_launcher$scale()
crew::crew_class_launcher$set_name()
crew::crew_class_launcher$settings()
crew::crew_class_launcher$start()
crew::crew_class_launcher$terminate()
crew::crew_class_launcher$terminate_workers()
crew::crew_class_launcher$update()
Method new()
Abstract launcher constructor.
Usage
crew_class_launcher_cluster$new( name = NULL, workers = NULL, seconds_interval = NULL, seconds_timeout = NULL, seconds_launch = NULL, seconds_idle = NULL, seconds_wall = NULL, tasks_max = NULL, tasks_timers = NULL, reset_globals = NULL, reset_packages = NULL, reset_options = NULL, garbage_collection = NULL, tls = NULL, r_arguments = NULL, options_metrics = NULL, options_cluster = NULL )
Arguments
name
workers
seconds_interval
seconds_timeout
seconds_launch
seconds_idle
seconds_wall
tasks_max
tasks_timers
reset_globals
reset_packages
reset_options
garbage_collection
tls
r_arguments
options_metrics
options_cluster
Returns
An abstract launcher object.
Method validate()
Validate the launcher.
Usage
crew_class_launcher_cluster$validate()
Returns
NULL
(invisibly). Throws an error if a field is invalid.
Method launch_worker()
Launch a local process worker which will dial into a socket.
Usage
crew_class_launcher_cluster$launch_worker( call, name, launcher, worker, instance = NULL )
Arguments
call
Character string, a namespaced call to
crew::crew_worker()
which will run in the worker and accept tasks.name
Character string, an informative worker name.
launcher
Character string, name of the launcher.
worker
Character string, name of the worker instance.
instance
Deprecated in
crew.cluster
Details
The call
argument is R code that will run to
initiate the worker.
Returns
A handle object to allow the termination of the worker later on.
Method terminate_worker()
Terminate a local process worker.
Usage
crew_class_launcher_cluster$terminate_worker(handle)
Arguments
handle
A process handle object previously returned by
launch_worker()
.
Returns
NULL
(invisibly).
See Also
Other cluster:
crew_class_monitor_cluster
,
crew_launcher_cluster()
,
crew_monitor_cluster()
,
crew_options_cluster()