launch_local: Launch Daemon
In mirai: Minimalist Async Evaluation Framework for R

launch_local

R Documentation

Launch Daemon

Description

launch_local spawns a new background Rscript process calling daemon() with the specified arguments.

launch_remote returns the shell command for deploying daemons as a character vector. If a configuration generated by remote_config() or ssh_config() is supplied then this is used to launch the daemon on the remote machine.

Usage

launch_local(n = 1L, ..., tls = NULL, .compute = "default")

launch_remote(
  n = 1L,
  remote = remote_config(),
  ...,
  tls = NULL,
  .compute = "default"
)

Arguments

`n`	integer number of daemons. or for `launch_remote` only, a 'miraiCluster' or 'miraiNode'.
`...`	(optional) arguments passed through to `daemon()`. These include `autoexit`, `cleanup`, `output`, `maxtasks`, `idletime` and `walltime`. Only supply to override arguments originally provided to `daemons()`, otherwise those will be used instead.
`tls`	[default NULL] required for secure TLS connections over 'tls+tcp://'. Zero-configuration TLS certificates generated by `daemons()` are automatically passed to the daemon, without requiring to be specified here. Otherwise, supply either the character path to a file containing X.509 certificate(s) in PEM format, comprising the certificate authority certificate chain, or a length 2 character vector comprising [i] the certificate authority certificate chain and [ii] the empty string `""`.
`.compute`	[default 'default'] character value for the compute profile to use (each compute profile has its own independent set of daemons).
`remote`	required only for launching remote daemons, a configuration generated by `remote_config()` or `ssh_config()`. An empty `remote_config()` does not effect any daemon launches but returns the shell commands for deploying manually on remote machines.

Details

These functions may be used to re-launch daemons that have exited after reaching time or task limits.

Daemons must already be set for launchers to work.

The generated command contains the argument rs specifying the length 7 L'Ecuyer-CMRG random seed supplied to the daemon. The values will be different each time the function is called.

Value

For launch_local: Integer number of daemons launched.

For launch_remote: A character vector of daemon launch commands, classed as 'miraiLaunchCmd'. The printed output may be copy / pasted directly to the remote machine.

Examples


daemons(url = host_url(), dispatcher = FALSE)
status()
launch_local(1L, cleanup = FALSE)
launch_remote(1L, cleanup = FALSE)
Sys.sleep(1)
status()
daemons(0)

daemons(url = host_url(tls = TRUE))
status()
launch_local(2L, output = TRUE)
Sys.sleep(1)
status()
daemons(0)

mirai documentation built on April 4, 2025, 12:27 a.m.