unresolved() rather than is_resolved()

Author: shikokuchuo

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: nanonext
 Type: Package
 Title: NNG (Nanomsg Next Gen) Lightweight Messaging Library
-Version: 0.2.0.9003
+Version: 0.2.0.9004
 Description: R binding for NNG (Nanomsg Next Gen), a successor to ZeroMQ. NNG is 
     a socket library providing high-performance scalability protocols,
     implementing a cross-platform standard for messaging and communications.

NAMESPACE

@@ -27,7 +27,6 @@ export(call_aio)
 export(context)
 export(dial)
 export(is_nul_byte)
-export(is_resolved)
 export(listen)
 export(logging)
 export(nano)
@@ -47,6 +46,7 @@ export(socket)
 export(stop_aio)
 export(subscribe)
 export(survey_time)
+export(unresolved)
 export(unsubscribe)
 importFrom(stats,start)
 importFrom(utils,.DollarNames)

NEWS.md

@@ -1,9 +1,9 @@
-# nanonext 0.2.0.9003 (development)
+# nanonext 0.2.0.9004 (development)
 
 #### New Features
 
 * Aio fields `$result` for a 'sendAio', `$raw` and `$data` for a 'recvAio' may be queried directly, returning their values or else an NA 'unresolved value' if the Aio operation is yet to complete.
-* `is_resolved()` added as an auxiliary function to query whether an Aio has resolved in a non-blocking fashion.
+* `unresolved()` added as an auxiliary function to query whether an Aio is still unresolved in a non-blocking fashion.
 * `is_nul_byte()` added as a helper function for request/reply setups.
 * `survey_time()` added as a convenience function for surveyor/respondent patterns.
 * `logging()` function to specify a global package logging level - currently supports 'error' and 'info'.

R/aio.R

@@ -29,8 +29,8 @@
 #' @section Non-blocking:
 #'
 #'     To query the value of an Aio without potentially waiting for the Aio
-#'     operation to complete, call the values directly at \code{$result} for a 'sendAio', and
-#'     \code{$raw} or \code{$data} for a 'recvAio'.
+#'     operation to complete, access the values directly at \code{$result} for a
+#'     'sendAio', and \code{$raw} or \code{$data} for a 'recvAio'.
 #'
 #'     If the Aio operation is yet to complete, the result will be an
 #'     'unresolved value', which is a logical NA. Once complete, the resolved
@@ -131,45 +131,44 @@ stop_aio <- function(aio) {
 
 }
 
-#' Is Resolved (Asynchronous AIO Operation)
+#' Query if an Aio is Unresolved
 #'
-#' Query whether an Aio or Aio value has resolved. This function is non-blocking
+#' Query whether an Aio or Aio value is unresolved. This function is non-blocking
 #'     unlike \code{\link{call_aio}} which waits for completion.
 #'
 #' @param aio An Aio (object of class 'sendAio' or 'recvAio'), or Aio value
 #'     stored in \code{$result}, \code{$raw} or \code{$data} as the case may be.
 #'
 #' @return Logical TRUE or FALSE.
 #'
-#' @details Returns FALSE only for unresolved nanonext Aios or Aio values; returns
-#'     TRUE in all other cases and for all other objects.
+#' @details Returns TRUE for unresolved nanonext Aios or Aio values; returns
+#'     FALSE in all other cases and for all other objects.
 #'
 #'     Note: querying resolution may cause a previously unresolved Aio to resolve.
 #'
 #' @examples
 #' s1 <- socket("pair", listen = "inproc://nanonext")
 #' aio <- send_aio(s1, "test", timeout = 100)
-#' is_resolved(aio)
 #'
-#' s2 <- socket("pair", dial = "inproc://nanonext")
-#' is_resolved(aio)
+#' while (unresolved(aio)) {
+#'   print(unresolved(aio))
+#'   s2 <- socket("pair", dial = "inproc://nanonext")
+#'   Sys.sleep(0.01)
+#' }
+#'
+#' unresolved(aio)
 #'
 #' close(s1)
 #' close(s2)
 #'
 #' @export
 #'
-is_resolved <- function(aio) {
+unresolved <- function(aio) {
 
-  if (inherits(aio, "recvAio")) {
-    !inherits(.subset2(aio, "data"), "unresolvedValue")
-  } else if (inherits(aio, "sendAio")) {
-    !inherits(.subset2(aio, "result"), "unresolvedValue")
-  } else if (inherits(aio, "unresolvedValue")) {
-    FALSE
-  } else {
-    TRUE
-  }
+  {inherits(aio, "unresolvedValue") ||
+      inherits(aio, "recvAio") && inherits(.subset2(aio, "data"), "unresolvedValue") ||
+      inherits(aio, "sendAio") && inherits(.subset2(aio, "result"), "unresolvedValue")} &&
+    return(TRUE)
 
 }
 

R/listdial.R

@@ -83,7 +83,7 @@ dial <- function(socket,
       }
       if (logging()) {
         cat(format.POSIXct(Sys.time()), "[ dial start ] sock:",
-            attr(res, "socket"), "| url:", url, "\n")
+            attr(res, "socket"), "| url:", url, "\n", file = stdout())
       }
     } else {
       res <- .Call(rnng_dialer_create, .subset2(socket, "socket"), url)
@@ -112,7 +112,7 @@ dial <- function(socket,
       }
       if (logging()) {
         cat(format.POSIXct(Sys.time()), "[ dial start ] sock:",
-            attr(res, "socket"), "| url:", url, "\n")
+            attr(res, "socket"), "| url:", url, "\n", file = stdout())
       }
     } else {
       res <- .Call(rnng_dialer_create, socket, url)
@@ -212,7 +212,7 @@ listen <- function(socket,
       }
       if (logging()) {
         cat(format.POSIXct(Sys.time()), "[ list start ] sock:",
-            attr(res, "socket"), "| url:", url, "\n")
+            attr(res, "socket"), "| url:", url, "\n", file = stdout())
       }
     } else {
       res <- .Call(rnng_listener_create, .subset2(socket, "socket"), url)
@@ -241,7 +241,7 @@ listen <- function(socket,
       }
       if (logging()) {
         cat(format.POSIXct(Sys.time()), "[ list start ] sock:",
-            attr(res, "socket"), "| url:", url, "\n")
+            attr(res, "socket"), "| url:", url, "\n", file = stdout())
       }
     } else {
       res <- .Call(rnng_listener_create, socket, url)

R/methods.R

@@ -31,7 +31,7 @@ start.nanoListener <- function(x, ...) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ list start ] sock:",
-        attr(x, "socket"), "| url:", attr(x, "url"), "\n")
+        attr(x, "socket"), "| url:", attr(x, "url"), "\n", file = stdout())
   }
   invisible(xc)
 
@@ -48,7 +48,7 @@ start.nanoDialer <- function(x, async = TRUE, ...) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ dial start ] sock:",
-        attr(x, "socket"), "| url:", attr(x, "url"), "\n")
+        attr(x, "socket"), "| url:", attr(x, "url"), "\n", file = stdout())
   }
   invisible(xc)
 
@@ -94,7 +94,7 @@ close.nanoSocket <- function(con, ...) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ sock close ] id:",
-        attr(con, "id"), "| protocol:", attr(con, "protocol"), "\n")
+        attr(con, "id"), "| protocol:", attr(con, "protocol"), "\n", file = stdout())
   }
   invisible(xc)
 
@@ -111,7 +111,7 @@ close.nanoContext <- function(con, ...) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ ctxt close ] id:",
-        attr(con, "id"), "| sock:", attr(con, "socket"), "\n")
+        attr(con, "id"), "| sock:", attr(con, "socket"), "\n", file = stdout())
   }
   invisible(xc)
 
@@ -128,7 +128,7 @@ close.nanoDialer <- function(con, ...) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ dial start ] sock:",
-        attr(con, "socket"), "| url:", attr(con, "url"), "\n")
+        attr(con, "socket"), "| url:", attr(con, "url"), "\n", file = stdout())
   }
 
   invisible(xc)
@@ -146,7 +146,7 @@ close.nanoListener <- function(con, ...) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ list close ] sock:",
-        attr(con, "socket"), "| url:", attr(con, "url"), "\n")
+        attr(con, "socket"), "| url:", attr(con, "url"), "\n", file = stdout())
   }
 
   invisible(xc)

R/nano.R

@@ -148,11 +148,13 @@ print.nanoObject <- function(x, ...) {
 
   cat("< nano object >\n - socket id:", attr(.subset2(x, "socket"), "id"),
       "\n - state:", attr(.subset2(x, "socket"), "state"),
-      "\n - protocol:", attr(.subset2(x, "socket"), "protocol"), "\n")
+      "\n - protocol:", attr(.subset2(x, "socket"), "protocol"), "\n", file = stdout())
       if (!is.null(.subset2(x, "listener")))
-        cat(" - listener:", unlist(lapply(.subset2(x, "listener"), attr, "url")), sep = "\n    ")
+        cat(" - listener:", unlist(lapply(.subset2(x, "listener"), attr, "url")),
+            sep = "\n    ", file = stdout())
       if (!is.null(.subset2(x, "dialer")))
-        cat(" - dialer:", unlist(lapply(.subset2(x, "dialer"), attr, "url")), sep = "\n    ")
+        cat(" - dialer:", unlist(lapply(.subset2(x, "dialer"), attr, "url")),
+            sep = "\n    ", file = stdout())
   invisible(x)
 
 }
@@ -163,11 +165,13 @@ print.nanoSocket <- function(x, ...) {
 
   cat("< nanoSocket >\n - id:", attr(x, "id"),
       "\n - state:", attr(x, "state"),
-      "\n - protocol:", attr(x, "protocol"), "\n")
+      "\n - protocol:", attr(x, "protocol"), "\n", file = stdout())
   if (!is.null(attr(x, "listener")))
-    cat(" - listener:", unlist(lapply(attr(x, "listener"), attr, "url")), sep = "\n    ")
+    cat(" - listener:", unlist(lapply(attr(x, "listener"), attr, "url")),
+        sep = "\n    ", file = stdout())
   if (!is.null(attr(x, "dialer")))
-    cat(" - dialer:", unlist(lapply(attr(x, "dialer"), attr, "url")), sep = "\n    ")
+    cat(" - dialer:", unlist(lapply(attr(x, "dialer"), attr, "url")),
+        sep = "\n    ", file = stdout())
   invisible(x)
 
 }
@@ -179,7 +183,7 @@ print.nanoContext <- function(x, ...) {
   cat("< nanoContext >\n - id:", attr(x, "id"),
       "\n - socket:", attr(x, "socket"),
       "\n - state:", attr(x, "state"),
-      "\n - protocol:", attr(x, "protocol"), "\n")
+      "\n - protocol:", attr(x, "protocol"), "\n", file = stdout())
   invisible(x)
 
 }
@@ -191,7 +195,7 @@ print.nanoDialer <- function(x, ...) {
   cat("< nanoDialer >\n - id:", attr(x, "id"),
       "\n - socket:", attr(x, "socket"),
       "\n - state:", attr(x, "state"),
-      "\n - url:", attr(x, "url"), "\n")
+      "\n - url:", attr(x, "url"), "\n", file = stdout())
   invisible(x)
 
 }
@@ -203,7 +207,7 @@ print.nanoListener <- function(x, ...) {
   cat("< nanoListener >\n - id:", attr(x, "id"),
       "\n - socket:", attr(x, "socket"),
       "\n - state:", attr(x, "state"),
-      "\n - url:", attr(x, "url"), "\n")
+      "\n - url:", attr(x, "url"), "\n", file = stdout())
   invisible(x)
 
 }
@@ -212,7 +216,7 @@ print.nanoListener <- function(x, ...) {
 #'
 print.recvAio <- function(x, ...) {
 
-  cat("< recvAio >\n - $raw for raw message\n - $data for message data\n")
+  cat("< recvAio >\n - $raw for raw message\n - $data for message data\n", file = stdout())
   invisible(x)
 
 }
@@ -221,7 +225,7 @@ print.recvAio <- function(x, ...) {
 #'
 print.sendAio <- function(x, ...) {
 
-  cat("< sendAio >\n - $result for send result\n")
+  cat("< sendAio >\n - $result for send result\n", file = stdout())
   invisible(x)
 
 }
@@ -262,7 +266,7 @@ print.sendAio <- function(x, ...) {
 #'
 print.unresolvedValue <- function(x, ...) {
 
-  cat("< unresolved value >\n")
+  cat("< unresolved value >\n", file = stdout())
   invisible(x)
 
 }

R/socket.R

@@ -68,7 +68,7 @@ socket <- function(protocol = c("pair", "bus", "push", "pull", "req", "rep",
     message(Sys.time(), " [ ", res, " ] ", nng_error(res))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ sock open ] id:",
-        attr(res, "id"), "| protocol:", attr(res, "protocol"), "\n")
+        attr(res, "id"), "| protocol:", attr(res, "protocol"), "\n", file = stdout())
   }
   if (!missing(dial)) {
     dial(res, url = dial, autostart = autostart)
@@ -123,7 +123,7 @@ subscribe <- function(socket, topic = NULL) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ subscribe ] sock:", attr(socket, "id"),
-        "| topic:", if (is.null(topic)) "ALL" else topic, "\n")
+        "| topic:", if (is.null(topic)) "ALL" else topic, "\n", file = stdout())
   }
   invisible(xc)
 
@@ -176,7 +176,7 @@ unsubscribe <- function(socket, topic = NULL) {
     message(Sys.time(), " [ ", xc, " ] ", nng_error(xc))
   } else if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ unsubscribe ] sock:", attr(socket, "id"),
-        "| topic:", if (is.null(topic)) "ALL" else topic, "\n")
+        "| topic:", if (is.null(topic)) "ALL" else topic, "\n", file = stdout())
   }
   invisible(xc)
 
@@ -232,7 +232,7 @@ survey_time <- function(socket, time) {
   res <- setopt(socket, type = "ms", opt = "surveyor:survey-time", value = time)
   if (logging()) {
     cat(format.POSIXct(Sys.time()), "[ survey ] sock:", attr(socket, "id"),
-        "| set time:", time, "\n")
+        "| set time:", time, "\n", file = stdout())
   }
 
 }

R/utils.R

@@ -109,7 +109,8 @@ logging <- function(level) {
     cache <<- switch(level,
                      error = 0L,
                      info = 1L)
-    cat(format.POSIXct(Sys.time()), "[ logging level ] set to:", level, "\n")
+    cat(format.POSIXct(Sys.time()), "[ log level ] set to:", level,
+        "\n", file = stdout())
 
   }