deprecate logging

Author: shikokuchuo

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: nanonext
 Type: Package
 Title: NNG (Nanomsg Next Gen) Lightweight Messaging Library
-Version: 0.3.0.9003
+Version: 0.3.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.

NEWS.md

@@ -1,4 +1,4 @@
-# nanonext 0.3.0.9003 (development)
+# nanonext 0.3.0.9004 (development)
 
 #### New Features
 
@@ -11,6 +11,7 @@
 * Unified `send()` and `recv()` functions, and their asynchronous counterparts `send_aio()` and `recv_aio()`, are now S3 generics and can be used across Sockets, Contexts and Streams.
 * Revised 'block' argument for `send()` and `recv()` now allows an integer value for setting a timeout.
 * `send_ctx()` and `recv_ctx()` are deprecated and will be removed in a future package version - the methods for `send()` and `recv()` should be used instead.
+* Logging is deprecated and is being phased out. Logging can still be set via 'NANONEXT_LOG' prior to package load but the ability to set via the `logging()` function has been removed. Logging will be removed entirely in a future package version.
 
 # nanonext 0.3.0
 

R/listdial.R

@@ -82,7 +82,7 @@ dial <- function(socket,
         logerror(res)
         return(invisible(res))
       }
-      if (logging()) loginfo(evt = "dial start", pkey = "sock", pval = attr(res, "socket"),
+      if (.logging.) loginfo(evt = "dial start", pkey = "sock", pval = attr(res, "socket"),
                              skey = "url", sval = url)
     } else {
       res <- .Call(rnng_dialer_create, .subset2(socket, "socket"), url)
@@ -109,7 +109,7 @@ dial <- function(socket,
         logerror(res)
         return(invisible(res))
       }
-      if (logging()) loginfo(evt = "dial start", pkey = "sock", pval = attr(res, "socket"),
+      if (.logging.) loginfo(evt = "dial start", pkey = "sock", pval = attr(res, "socket"),
                              skey = "url", sval = url)
     } else {
       res <- .Call(rnng_dialer_create, socket, url)
@@ -208,7 +208,7 @@ listen <- function(socket,
         logerror(res)
         return(invisible(res))
       }
-      if (logging()) loginfo(evt = "list start", pkey = "sock", pval = attr(res, "socket"),
+      if (.logging.) loginfo(evt = "list start", pkey = "sock", pval = attr(res, "socket"),
                              skey = "url", sval = url)
     } else {
       res <- .Call(rnng_listener_create, .subset2(socket, "socket"), url)
@@ -235,7 +235,7 @@ listen <- function(socket,
         logerror(res)
         return(invisible(res))
       }
-      if (logging()) loginfo(evt = "list start", pkey = "sock", pval = attr(res, "socket"),
+      if (.logging.) loginfo(evt = "list start", pkey = "sock", pval = attr(res, "socket"),
                              skey = "url", sval = url)
     } else {
       res <- .Call(rnng_listener_create, socket, url)

R/messenger.R

@@ -41,6 +41,7 @@ messenger <- function(dial = NULL, listen = NULL) {
     close(sock)
     invisible()
   })
+  cat("\014", file = stdout())
   intro <- unlist(strsplit("nanonext messenger", ""))
   for (i in seq_along(intro)) {
     cat("\r", `length<-`(intro, i), sep = " ", file = stdout())

R/methods.R

@@ -29,7 +29,7 @@ start.nanoListener <- function(x, ...) {
   xc <- .Call(rnng_listener_start, x)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "list start", pkey = "sock", pval = attr(x, "socket"),
             skey = "url", sval = attr(x, "url"))
   }
@@ -46,7 +46,7 @@ start.nanoDialer <- function(x, async = TRUE, ...) {
   xc <- .Call(rnng_dialer_start, x, async)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "dial start", pkey = "sock", pval = attr(x, "socket"),
             skey = "url", sval = attr(x, "url"))
   }
@@ -92,7 +92,7 @@ close.nanoSocket <- function(con, ...) {
   xc <- .Call(rnng_close, con)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "sock close", pkey = "id", pval = attr(con, "id"),
             skey = "protocol", sval = attr(con, "protocol"))
   }
@@ -121,7 +121,7 @@ close.nanoDialer <- function(con, ...) {
   xc <- .Call(rnng_dialer_close, con)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "dial close", pkey = "sock", pval = attr(con, "socket"),
             skey = "url", sval = attr(con, "url"))
   }
@@ -139,7 +139,7 @@ close.nanoListener <- function(con, ...) {
   xc <- .Call(rnng_listener_close, con)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "list close", pkey = "sock", pval = attr(con, "socket"),
             skey = "url", sval = attr(con, "url"))
   }
@@ -157,7 +157,7 @@ close.nanoStream <- function(con, ...) {
   pkey <- if (is.null(attr(con, "dialer"))) "list" else "dial"
   sval <- attr(con, "url")
   xc <- .Call(rnng_stream_close, con)
-  if (logging()) loginfo(evt = "stream close", pkey = pkey, pval = 1,
+  if (.logging.) loginfo(evt = "stream close", pkey = pkey, pval = 1,
                          skey = "url", sval = sval)
   invisible(xc)
 

R/nanonext-package.R

@@ -124,8 +124,11 @@
 NULL
 
 .onLoad <- function(libname, pkgname) {
-  logging <- logging()
-  logging <<- logging
+  .logging. <- switch(tolower(Sys.getenv("NANONEXT_LOG")),
+                              info = TRUE,
+                              FALSE)
+  .logging. <<- .logging.
   invisible()
 }
 
+.logging. <- FALSE

R/protocol.R

@@ -24,15 +24,13 @@
 #' @examples
 #' pub <- socket("pub", listen = "inproc://nanonext")
 #' sub <- socket("sub", dial = "inproc://nanonext")
-#' logging(level = "info")
 #'
 #' subscribe(sub, "examples")
 #' send(pub, c("examples", "this is an example"), mode = "raw")
 #' recv(sub, "character")
 #' send(pub, c("other", "this other topic will not be received"), mode = "raw")
 #' recv(sub, "character")
 #'
-#' logging(level = "error")
 #' close(pub)
 #' close(sub)
 #'
@@ -43,7 +41,7 @@ subscribe <- function(socket, topic = NULL) {
   xc <- .Call(rnng_socket_set_string, socket, "sub:subscribe" , topic)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "subscribe", pkey = "sock", pval = attr(socket, "id"),
             skey = "topic", sval = if (is.null(topic)) "ALL" else topic)
   }
@@ -78,7 +76,6 @@ subscribe <- function(socket, topic = NULL) {
 #' @examples
 #' pub <- socket("pub", listen = "inproc://nanonext")
 #' sub <- socket("sub", dial = "inproc://nanonext")
-#' logging(level = "info")
 #'
 #' subscribe(sub, NULL)
 #' send(pub, c("examples", "this is an example"), mode = "raw")
@@ -87,7 +84,6 @@ subscribe <- function(socket, topic = NULL) {
 #' send(pub, c("examples", "this example will not be received"), mode = "raw")
 #' recv(sub, "character")
 #'
-#' logging(level = "error")
 #' close(pub)
 #' close(sub)
 #'
@@ -98,7 +94,7 @@ unsubscribe <- function(socket, topic = NULL) {
   xc <- .Call(rnng_socket_set_string, socket, "sub:unsubscribe" , topic)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "unsubscribe", pkey = "sock", pval = attr(socket, "id"),
             skey = "topic", sval = if (is.null(topic)) "ALL" else topic)
   }
@@ -133,7 +129,6 @@ unsubscribe <- function(socket, topic = NULL) {
 #' @examples
 #' sur <- socket("surveyor", listen = "inproc://nanonext")
 #' res <- socket("respondent", dial = "inproc://nanonext")
-#' logging(level = "info")
 #'
 #' survey_time(sur, 1000)
 #' send(sur, "reply to this survey")
@@ -144,7 +139,6 @@ unsubscribe <- function(socket, topic = NULL) {
 #'
 #' call_aio(aio)$data
 #'
-#' logging(level = "error")
 #' close(sur)
 #' close(res)
 #'
@@ -155,7 +149,7 @@ survey_time <- function(socket, time) {
   xc <- .Call(rnng_socket_set_ms, socket, "surveyor:survey-time", time)
   if (xc) {
     logerror(xc)
-  } else if (logging()) {
+  } else if (.logging.) {
     loginfo(evt = "survey", pkey = "sock", pval = attr(socket, "id"),
             skey = "set time", sval = as.character(time))
   }

R/socket.R

@@ -69,7 +69,7 @@ socket <- function(protocol = c("pair", "bus", "push", "pull", "req", "rep",
     logerror(res)
     return(invisible(res))
   }
-  if (logging()) {
+  if (.logging.) {
     loginfo(evt = "sock open", pkey = "id", pval = attr(res, "id"),
             skey = "protocol", sval = attr(res, "protocol"))
   }

R/stream.R

@@ -45,7 +45,7 @@ stream <- function(dial = NULL, listen = NULL, textframes = FALSE) {
         logerror(res)
         return(invisible(res))
       }
-      if (logging()) {
+      if (.logging.) {
         loginfo(evt = "stream open", pkey = "list", pval = 1L,
                 skey = "url", sval = listen)
       }
@@ -58,7 +58,7 @@ stream <- function(dial = NULL, listen = NULL, textframes = FALSE) {
       logerror(res)
       return(invisible(res))
     }
-    if (logging()) {
+    if (.logging.) {
       loginfo(evt = "stream open", pkey = "dial", pval = 1L,
               skey = "url", sval = dial)
     }

R/utils.R

@@ -77,57 +77,25 @@ is_error_value <- function(x) inherits(x, "errorValue")
 
 #' Logging Level
 #'
-#' Set the logging level of nanonext.
+#' This function is deprecated.
 #'
-#' @param level specify a logging level
-#'     \itemize{
-#'     \item{'keep'} {which keeps the current logging level}
-#'     \item{'check'} {which checks the value of environment variable 'NANONEXT_LOG'}
-#'     \item{'error'} {which sends all NNG errors to stderr}
-#'     \item{'info'} {which in addition sends key informational events such as
-#'     socket open etc. to stdout}
-#'     }
+#' @param level specify a logging level. No longer used.
 #'
-#' @return Invisible NULL. A confirmation is printed to the console (stdout) if
-#'     the logging level has changed. If the function is called with no arguments,
-#'     the integer code of the logging level is returned instead.
+#' @return Invisible NULL. If the function is called with no arguments,
+#'     the logical code of the logging level is returned instead.
 #'
 #' @details The environment variable 'NANONEXT_LOG' is checked automatically on
-#'     package load and then cached for optimal performance. It is also checked
-#'     each time \code{logging(level = "check")} is called. If the variable is
-#'     set incorrectly, the default level of 'error' is used instead.
-#'
-#' @examples
-#' logging(level = "info")
-#' sock <- socket("respondent", dial = "inproc://nanolog")
-#' logging(level = "error")
-#' close(sock)
+#'     package load. If the variable is set incorrectly, the default level
+#'     of 'error' is used instead.
 #'
 #' @export
 #'
-logging <- function(level) {
-
-  cache <- switch(tolower(Sys.getenv("NANONEXT_LOG")),
-                  info = TRUE,
-                  FALSE)
-
-  logging <- function(level = c("keep", "check", "error", "info")) {
-
-    missing(level) && return(cache)
-    level <- match.arg(level)
-    original <- cache
-    cache <<- switch(level,
-                     check = switch(tolower(Sys.getenv("NANONEXT_LOG")),
-                                    info = TRUE,
-                                    FALSE),
-                     error = FALSE,
-                     info = TRUE,
-                     keep = original)
-    if (cache != original) cat(sprintf("%s [ %s ] %s: %s\n",
-                                       format.POSIXct(Sys.time()), "log level", "set to",
-                                       if (cache) "info" else "error"),  file = stdout())
+logging <- function(level = c("keep", "check", "error", "info")) {
 
-  }
+  missing(level) && return(.logging.)
+  cat("nanonext logging is deprecated and this function can no longer be used\n",
+      "logging level can still be set via the environment variable NANONEXT_LOG\n",
+      "prior to package load for the time being\n", file = stderr())
 
 }