nextstream: Next >> Developer Interface

In mirai: Minimalist Async Evaluation Framework for R

Next >> Developer Interface

Description

nextstream retrieves the currently stored L'Ecuyer-CMRG RNG stream for the specified compute profile and advances it to the next stream.

nextget retrieves the specified item from the specified compute profile.

nextcode translates integer exit codes returned by daemon().

Usage

nextstream(.compute = "default")

nextget(x, .compute = "default")

nextcode(xc)

Arguments

.compute	[default 'default'] character value for the compute profile to use (each compute profile has its own independent set of daemons).
x	character value of item to retrieve. One of "n" (number of dispatcher daemons), "pid" (dispatcher process ID), "urls" (URLs dispatcher is listening at) or "tls" (the stored client TLS configuration for use by daemons).
xc	integer return value of daemon().

Details

These functions are exported for use by packages extending mirai with alternative launchers of daemon() processes.

For nextstream: This function should be called for its return value when required. The function also has the side effect of automatically advancing the stream stored within the compute profile. This ensures that the next recursive stream is returned when the function is called again.

Value

For nextstream: a length 7 integer vector, as given by .Random.seed when the L'Ecuyer-CMRG RNG is in use (may be passed directly to the rs argument of daemon()), or else NULL if a stream has not yet been created.

For nextget: the requested item, or else NULL if not present.

For nextcode: character string.

Examples

daemons(1L)
nextstream()
nextstream()

nextget("pid")
nextget("urls")

daemons(0)

nextcode(0L)
nextcode(1L)

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