R6
class for mirai
clients.
Details
See crew_client()
.
See also
Other client:
crew_client()
Active bindings
name
See
crew_client()
.workers
See
crew_client()
.host
See
crew_client()
.port
See
crew_client()
.tls
See
crew_client()
.seconds_interval
See
crew_client()
.seconds_timeout
See
crew_client()
.relay
Relay object for event-driven programming on a downstream condition variable.
started
Whether the client is started.
dispatcher
Process ID of the
mirai
dispatcher
Methods
Method new()
mirai
client constructor.
Usage
crew_class_client$new(
name = NULL,
workers = NULL,
host = NULL,
port = NULL,
tls = NULL,
seconds_interval = NULL,
seconds_timeout = NULL,
relay = NULL
)
Arguments
name
Argument passed from
crew_client()
.workers
Argument passed from
crew_client()
.host
Argument passed from
crew_client()
.port
Argument passed from
crew_client()
.tls
Argument passed from
crew_client()
.seconds_interval
Argument passed from
crew_client()
.seconds_timeout
Argument passed from
crew_client()
.relay
Argument passed from
crew_client()
.
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
client$log()
client$terminate()
}
Method start()
Start listening for workers on the available sockets.
Method summary()
Show an informative worker log.
Returns
A tibble
with information on the workers, or NULL
if the client is not started. The tibble
has 1 row
per worker and the following columns:
worker
: integer index of the worker.online
:TRUE
if the worker is online and connected to the websocket URL,FALSE
otherwise.instances
: integer, number of instances ofmirai
daemons (crew
workers) that have connected to the websocket URL during the life cycle of the listener.assigned
: number of tasks assigned to the current websocket URL.complete
: number of tasks completed at the current websocket URL.socket
: websocket URL.crew
changes the token at the end of the URL path periodically as a safeguard while managing workers.
Examples
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
client$log()
client$terminate()
}
## ------------------------------------------------
## Method `crew_class_client$new`
## ------------------------------------------------
if (identical(Sys.getenv("CREW_EXAMPLES"), "true")) {
client <- crew_client()
client$start()
client$log()
client$terminate()
}