crew_class_launcher: Launcher abstract class
In wlandau/crew: A Distributed Worker Launcher Framework
crew_class_launcher R Documentation
Launcher abstract class
Description
R6 abstract class to build other subclasses
which launch and manage workers.
Active bindings
nameSee crew_launcher().
workersSee crew_launcher().
seconds_intervalSee crew_launcher().
seconds_timeoutSee crew_launcher().
seconds_launchSee crew_launcher().
seconds_idleSee crew_launcher().
seconds_wallSee crew_launcher().
tasks_maxSee crew_launcher().
tasks_timersSee crew_launcher().
reset_globalsSee crew_launcher().
reset_packagesSee crew_launcher().
reset_optionsSee crew_launcher().
garbage_collectionSee crew_launcher().
tlsSee crew_launcher().
processesSee crew_launcher().
asynchronously.
r_argumentsSee crew_launcher().
options_metricsSee crew_launcher().
urlWebsocket URL for worker connections.
profilemirai compute profile of the launcher.
instancesData frame of worker instance information.
idInteger worker ID from the last call to settings().
asyncA crew_async() object to run low-level launcher tasks
asynchronously.
throttleA crew_throttle() object to throttle scaling.
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Method new()
Launcher constructor.
Usage
crew_class_launcher$new(
name = NULL,
workers = NULL,
seconds_interval = NULL,
seconds_timeout = NULL,
seconds_launch = NULL,
seconds_idle = NULL,
seconds_wall = NULL,
seconds_exit = NULL,
tasks_max = NULL,
tasks_timers = NULL,
reset_globals = NULL,
reset_packages = NULL,
reset_options = NULL,
garbage_collection = NULL,
crashes_error = NULL,
launch_max = NULL,
tls = NULL,
processes = NULL,
r_arguments = NULL,
options_metrics = NULL
)
Arguments
nameSee crew_launcher().
workersSee crew_launcher().
seconds_intervalSee crew_launcher().
seconds_timeoutSee crew_launcher().
seconds_launchSee crew_launcher().
seconds_idleSee crew_launcher().
seconds_wallSee crew_launcher().
seconds_exitSee crew_launcher().
tasks_maxSee crew_launcher().
tasks_timersSee crew_launcher().
reset_globalsSee crew_launcher().
reset_packagesSee crew_launcher().
reset_optionsSee crew_launcher().
garbage_collectionSee crew_launcher().
crashes_errorSee crew_launcher().
launch_maxDeprecated.
tlsSee crew_launcher().
processesSee crew_launcher().
r_argumentsSee crew_launcher().
options_metricsSee crew_launcher().
Returns
An R6 object with the launcher.
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
launcher <- crew_launcher_local()
launcher$start(url = client$url, profile = client$profile)
launcher$launch()
task <- mirai::mirai("result", .compute = client$profile)
mirai::call_mirai_(task)
task$data
client$terminate()
}
Method validate()
Validate the launcher.
Usage
crew_class_launcher$validate()
Returns
NULL (invisibly).
Method poll()
Poll the throttle.
Usage
crew_class_launcher$poll()
Returns
TRUE to run whatever work comes next, FALSE to skip
until the appropriate time.
Method settings()
List of arguments for mirai::daemon().
Usage
crew_class_launcher$settings()
Returns
List of arguments for mirai::daemon().
Method call()
Create a call to crew_worker() to
help create custom launchers.
Usage
crew_class_launcher$call(
worker,
socket = NULL,
launcher = NULL,
instance = NULL
)
Arguments
workerCharacter string, name of the worker.
socketDeprecated on 2025-01-28 (crew version 1.0.0).
launcherDeprecated on 2025-01-28 (crew version 1.0.0).
instanceDeprecated on 2025-01-28 (crew version 1.0.0).
Returns
Character string with a call to crew_worker().
Examples
launcher <- crew_launcher_local()
launcher$start(url = "tcp://127.0.0.1:57000", profile = "profile")
launcher$call(worker = "worker_name")
launcher$terminate()
Method start()
Start the launcher.
Usage
crew_class_launcher$start(url = NULL, profile = NULL, sockets = NULL)
Arguments
urlCharacter string, websocket URL for worker connections.
profileCharacter string, mirai compute profile.
socketsDeprecated on 2025-01-28 (crew version 1.0.0).
Returns
NULL (invisibly).
Method terminate()
Terminate the whole launcher, including all workers.
Usage
crew_class_launcher$terminate()
Returns
NULL (invisibly).
Method resolve()
Resolve asynchronous worker submissions.
Usage
crew_class_launcher$resolve()
Returns
NULL (invisibly). Throw an error if there were any
asynchronous worker submission errors.'
Method update()
Update worker metadata, resolve asynchronous
worker submissions, and terminate lost workers.
Usage
crew_class_launcher$update(status)
Arguments
statusA mirai status list.
Returns
NULL (invisibly).
Method launch()
Launch a worker.
Usage
crew_class_launcher$launch()
Returns
Handle of the launched worker.
Method scale()
Auto-scale workers out to meet the demand of tasks.
Usage
crew_class_launcher$scale(status, throttle = NULL)
Arguments
statusA mirai status list with worker and task information.
throttleDeprecated, only used in the controller
as of 2025-01-16 (crew version 0.10.2.9003).
Returns
Invisibly returns TRUE if there was any relevant
auto-scaling activity (new worker launches or worker
connection/disconnection events) (FALSE otherwise).
Method launch_worker()
Abstract worker launch method.
Usage
crew_class_launcher$launch_worker(call, name, launcher, worker)
Arguments
callCharacter of length 1 with a namespaced call to
crew_worker() which will run in the worker and accept tasks.
nameCharacter of length 1 with an informative worker name.
launcherCharacter of length 1, name of the launcher.
workerPositive integer of length 1, index of the worker.
This worker index remains the same even when the current instance
of the worker exits and a new instance launches.
It is always between 1 and the maximum number of concurrent workers.
Details
Launcher plugins will overwrite this method.
Returns
A handle to mock the worker launch.
Method terminate_worker()
Abstract worker termination method.
Usage
crew_class_launcher$terminate_worker(handle)
Arguments
handleA handle object previously
returned by launch_worker() which allows the termination
of the worker.
Details
Launcher plugins will overwrite this method.
Returns
A handle to mock worker termination.
Method terminate_workers()
Terminate all workers.
Usage
crew_class_launcher$terminate_workers()
Returns
NULL (invisibly).
Method crashes()
Deprecated on 2025-01-28 (crew version 1.0.0).
Usage
crew_class_launcher$crashes(index = NULL)
Arguments
indexUnused argument.
Returns
The integer 1, for compatibility.
Method set_name()
Deprecated on 2025-01-28 (crew version 1.0.0).
Usage
crew_class_launcher$set_name(name)
Arguments
nameName to set for the launcher.
Returns
NULL (invisibly).
See Also
Other launcher:
crew_launcher()
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
launcher <- crew_launcher_local()
launcher$start(url = client$url, profile = client$profile)
launcher$launch()
task <- mirai::mirai("result", .compute = client$profile)
mirai::call_mirai_(task)
task$data
client$terminate()
}
## ------------------------------------------------
## Method `crew_class_launcher$new`
## ------------------------------------------------
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
launcher <- crew_launcher_local()
launcher$start(url = client$url, profile = client$profile)
launcher$launch()
task <- mirai::mirai("result", .compute = client$profile)
mirai::call_mirai_(task)
task$data
client$terminate()
}
## ------------------------------------------------
## Method `crew_class_launcher$call`
## ------------------------------------------------
launcher <- crew_launcher_local()
launcher$start(url = "tcp://127.0.0.1:57000", profile = "profile")
launcher$call(worker = "worker_name")
launcher$terminate()
wlandau/crew documentation built on Feb. 8, 2025, 10:12 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| crew_class_launcher | R Documentation |
Launcher abstract class
Description
R6 abstract class to build other subclasses
which launch and manage workers.
Active bindings
nameSee
crew_launcher().workersSee
crew_launcher().seconds_intervalSee
crew_launcher().seconds_timeoutSee
crew_launcher().seconds_launchSee
crew_launcher().seconds_idleSee
crew_launcher().seconds_wallSee
crew_launcher().tasks_maxSee
crew_launcher().tasks_timersSee
crew_launcher().reset_globalsSee
crew_launcher().reset_packagesSee
crew_launcher().reset_optionsSee
crew_launcher().garbage_collectionSee
crew_launcher().tlsSee
crew_launcher().processesSee
crew_launcher(). asynchronously.r_argumentsSee
crew_launcher().options_metricsSee
crew_launcher().urlWebsocket URL for worker connections.
profilemiraicompute profile of the launcher.instancesData frame of worker instance information.
idInteger worker ID from the last call to
settings().asyncA
crew_async()object to run low-level launcher tasks asynchronously.throttleA
crew_throttle()object to throttle scaling.
Methods
Public methods
Method new()
Launcher constructor.
Usage
crew_class_launcher$new( name = NULL, workers = NULL, seconds_interval = NULL, seconds_timeout = NULL, seconds_launch = NULL, seconds_idle = NULL, seconds_wall = NULL, seconds_exit = NULL, tasks_max = NULL, tasks_timers = NULL, reset_globals = NULL, reset_packages = NULL, reset_options = NULL, garbage_collection = NULL, crashes_error = NULL, launch_max = NULL, tls = NULL, processes = NULL, r_arguments = NULL, options_metrics = NULL )
Arguments
nameSee
crew_launcher().workersSee
crew_launcher().seconds_intervalSee
crew_launcher().seconds_timeoutSee
crew_launcher().seconds_launchSee
crew_launcher().seconds_idleSee
crew_launcher().seconds_wallSee
crew_launcher().seconds_exitSee
crew_launcher().tasks_maxSee
crew_launcher().tasks_timersSee
crew_launcher().reset_globalsSee
crew_launcher().reset_packagesSee
crew_launcher().reset_optionsSee
crew_launcher().garbage_collectionSee
crew_launcher().crashes_errorSee
crew_launcher().launch_maxDeprecated.
tlsSee
crew_launcher().processesSee
crew_launcher().r_argumentsSee
crew_launcher().options_metricsSee
crew_launcher().
Returns
An R6 object with the launcher.
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
launcher <- crew_launcher_local()
launcher$start(url = client$url, profile = client$profile)
launcher$launch()
task <- mirai::mirai("result", .compute = client$profile)
mirai::call_mirai_(task)
task$data
client$terminate()
}
Method validate()
Validate the launcher.
Usage
crew_class_launcher$validate()
Returns
NULL (invisibly).
Method poll()
Poll the throttle.
Usage
crew_class_launcher$poll()
Returns
TRUE to run whatever work comes next, FALSE to skip
until the appropriate time.
Method settings()
List of arguments for mirai::daemon().
Usage
crew_class_launcher$settings()
Returns
List of arguments for mirai::daemon().
Method call()
Create a call to crew_worker() to
help create custom launchers.
Usage
crew_class_launcher$call( worker, socket = NULL, launcher = NULL, instance = NULL )
Arguments
workerCharacter string, name of the worker.
socketDeprecated on 2025-01-28 (
crewversion 1.0.0).launcherDeprecated on 2025-01-28 (
crewversion 1.0.0).instanceDeprecated on 2025-01-28 (
crewversion 1.0.0).
Returns
Character string with a call to crew_worker().
Examples
launcher <- crew_launcher_local() launcher$start(url = "tcp://127.0.0.1:57000", profile = "profile") launcher$call(worker = "worker_name") launcher$terminate()
Method start()
Start the launcher.
Usage
crew_class_launcher$start(url = NULL, profile = NULL, sockets = NULL)
Arguments
urlCharacter string, websocket URL for worker connections.
profileCharacter string,
miraicompute profile.socketsDeprecated on 2025-01-28 (
crewversion 1.0.0).
Returns
NULL (invisibly).
Method terminate()
Terminate the whole launcher, including all workers.
Usage
crew_class_launcher$terminate()
Returns
NULL (invisibly).
Method resolve()
Resolve asynchronous worker submissions.
Usage
crew_class_launcher$resolve()
Returns
NULL (invisibly). Throw an error if there were any
asynchronous worker submission errors.'
Method update()
Update worker metadata, resolve asynchronous worker submissions, and terminate lost workers.
Usage
crew_class_launcher$update(status)
Arguments
statusA
miraistatus list.
Returns
NULL (invisibly).
Method launch()
Launch a worker.
Usage
crew_class_launcher$launch()
Returns
Handle of the launched worker.
Method scale()
Auto-scale workers out to meet the demand of tasks.
Usage
crew_class_launcher$scale(status, throttle = NULL)
Arguments
statusA
miraistatus list with worker and task information.throttleDeprecated, only used in the controller as of 2025-01-16 (
crewversion 0.10.2.9003).
Returns
Invisibly returns TRUE if there was any relevant
auto-scaling activity (new worker launches or worker
connection/disconnection events) (FALSE otherwise).
Method launch_worker()
Abstract worker launch method.
Usage
crew_class_launcher$launch_worker(call, name, launcher, worker)
Arguments
callCharacter of length 1 with a namespaced call to
crew_worker()which will run in the worker and accept tasks.nameCharacter of length 1 with an informative worker name.
launcherCharacter of length 1, name of the launcher.
workerPositive integer of length 1, index of the worker. This worker index remains the same even when the current instance of the worker exits and a new instance launches. It is always between 1 and the maximum number of concurrent workers.
Details
Launcher plugins will overwrite this method.
Returns
A handle to mock the worker launch.
Method terminate_worker()
Abstract worker termination method.
Usage
crew_class_launcher$terminate_worker(handle)
Arguments
handleA handle object previously returned by
launch_worker()which allows the termination of the worker.
Details
Launcher plugins will overwrite this method.
Returns
A handle to mock worker termination.
Method terminate_workers()
Terminate all workers.
Usage
crew_class_launcher$terminate_workers()
Returns
NULL (invisibly).
Method crashes()
Deprecated on 2025-01-28 (crew version 1.0.0).
Usage
crew_class_launcher$crashes(index = NULL)
Arguments
indexUnused argument.
Returns
The integer 1, for compatibility.
Method set_name()
Deprecated on 2025-01-28 (crew version 1.0.0).
Usage
crew_class_launcher$set_name(name)
Arguments
nameName to set for the launcher.
Returns
NULL (invisibly).
See Also
Other launcher:
crew_launcher()
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
launcher <- crew_launcher_local()
launcher$start(url = client$url, profile = client$profile)
launcher$launch()
task <- mirai::mirai("result", .compute = client$profile)
mirai::call_mirai_(task)
task$data
client$terminate()
}
## ------------------------------------------------
## Method `crew_class_launcher$new`
## ------------------------------------------------
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
launcher <- crew_launcher_local()
launcher$start(url = client$url, profile = client$profile)
launcher$launch()
task <- mirai::mirai("result", .compute = client$profile)
mirai::call_mirai_(task)
task$data
client$terminate()
}
## ------------------------------------------------
## Method `crew_class_launcher$call`
## ------------------------------------------------
launcher <- crew_launcher_local()
launcher$start(url = "tcp://127.0.0.1:57000", profile = "profile")
launcher$call(worker = "worker_name")
launcher$terminate()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.