adds nextcode()

NAMESPACE

@@ -43,6 +43,7 @@ export(local_url)
 export(make_cluster)
 export(mirai)
 export(mirai_map)
+export(nextcode)
 export(nextget)
 export(nextstream)
 export(register_cluster)

NEWS.md

@@ -2,7 +2,8 @@
 
 #### Updates
 
-* `daemon()` now returns an integer exit value to indicate the reason for termination.
+* `daemon()` now returns an integer exit code to indicate the reason for termination.
+* Adds `nextcode()` to provide a human-readable translation of the exit codes returned by `daemon()`.
 
 # mirai 2.0.0
 

R/next.R

@@ -74,6 +74,34 @@ nextstream <- function(.compute = "default") next_stream(..[[.compute]])
 #'
 nextget <- function(x, .compute = "default") ..[[.compute]][[x]]
 
+#' Next >> Developer Interface
+#'
+#' \code{nextcode} translates integer exit codes returned by
+#' \code{\link{daemon}}.
+#'
+#' @param xc integer value.
+#'
+#' @return For \code{nextcode}: character string.
+#' 
+#' @examples
+#' nextcode(0L)
+#' nextcode(1L)
+#'
+#' @keywords internal
+#' @rdname nextstream
+#' @export
+#'
+nextcode <- function(xc) {
+  str <- switch(xc + 1L,
+    "0 | Daemon connection terminated",
+    "1 | Daemon idletime limit reached",
+    "2 | Daemon walltime limit reached",
+    "3 | Daemon task limit reached"
+  )
+  is.null(str) && return("")
+  str
+} 
+
 # internals --------------------------------------------------------------------
 
 next_stream <- function(envir) {