Create an R6
wrapper object to manage the mirai
client.
Usage
crew_client(
name = NULL,
workers = 1L,
host = NULL,
port = NULL,
tls = crew::crew_tls(),
tls_enable = NULL,
tls_config = NULL,
seconds_interval = 0.5,
seconds_timeout = 5
)
Arguments
- name
Name of the client object. If
NULL
, a name is automatically generated.- workers
Integer, maximum number of parallel workers to run.
- host
IP address of the
mirai
client to send and receive tasks. IfNULL
, the host defaults to the local IP address.- port
TCP port to listen for the workers. If
NULL
, then an available ephemeral port is automatically chosen.- tls
A TLS configuration object from
crew_tls()
.- tls_enable
Deprecated on 2023-09-15 in version 0.4.1. Use argument
tls
instead.- tls_config
Deprecated on 2023-09-15 in version 0.4.1. Use argument
tls
instead.- seconds_interval
Number of seconds between polling intervals waiting for certain internal synchronous operations to complete, such as checking
mirai::status()
- seconds_timeout
Number of seconds until timing out while waiting for certain synchronous operations to complete, such as checking
mirai::status()
.
See also
Other client:
crew_class_client
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
client$summary()
client$terminate()
}