complete C level refactor

Author: shikokuchuo

NEWS.md

@@ -8,7 +8,7 @@
 
 #### Updates
 
-* Behavioural change: messages have been upgraded to warnings across the package to allow for enhanced reporting of the originating call e.g. via `warnings()`. Note that warnings are only printed when execution returns to the top level, e.g. at the end of a function or loop. If timely printing to stderr is required e.g. for logging, that should be written into your error handler within the function/loop etc.
+* Behavioural change: messages have been upgraded to warnings across the package to allow for enhanced reporting of the originating call e.g. via `warnings()` and flexibility in handling by setting the value of 'warn' using `options()`. `options(warn = 1)` is set upon package load for immediate printing of warnings (and reverted upon unload).
 * 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.

R/messenger.R

@@ -19,8 +19,9 @@
 #'
 #'     \code{:q} is the command to quit.
 #'
-#'     NOTE: This is an experimental feature that is currently undergoing
-#'     testing.
+#'     NOTE: This is a proof of concept meant for use within friendly internal
+#'     networks. Currently no measures are taken to verify the identity of
+#'     endpoints, hence should not be used to transmit sensitive information.
 #'
 #' @export
 #'

R/nano.R

@@ -61,7 +61,7 @@ nano <- function(protocol = c("pair", "bus", "push", "pull", "req", "rep",
 
   nano <- `class<-`(new.env(hash = FALSE), "nanoObject")
   socket <- socket(protocol)
-  makeActiveBinding("socket", function(x) socket, nano)
+  makeActiveBinding(sym = "socket", fun = function(x) socket, env = nano)
 
   if (!missing(dial)) {
     dial(nano, url = dial, autostart = autostart)

R/nanonext-package.R

@@ -128,7 +128,16 @@ NULL
                               info = TRUE,
                               FALSE)
   .logging. <<- .logging.
+  .warn. <- getOption("warn")
+  .warn. <<- .warn.
+  options(warn = 1L)
   invisible()
 }
 
+.onUnload <- function(libpath) {
+  options(warn = .warn.)
+  invisible()
+}
+
+.warn. <- NULL
 .logging. <- FALSE

R/utils.R

@@ -24,12 +24,25 @@ nng_version <- function() .Call(rnng_version)
 #'
 #' Translate integer exit code to human readable form. All package functions
 #'     return an integer exit code on error rather than the expected return
-#'     value.
+#'     value. These are classed 'errorValue' and may be checked by the function
+#'     \code{\link{is_error_value}}.
 #'
 #' @param xc integer exit code to translate.
 #'
 #' @return A character vector.
 #'
+#' @section Warnings:
+#'
+#'     A warning is generated every time an 'errorValue' is returned. The package
+#'     changes the behaviour of warnings by setting \code{options(warn = 1)}
+#'     upon package load. This prints the warning to the console as soon as it
+#'     occurs, rather than the default of waiting for the top–level function to
+#'     return.
+#'
+#'     See \code{\link{warning}} or the entry for 'warn' in \code{\link{options}}
+#'     for further details. The original option value for 'warn' is reverted upon
+#'     package unload.
+#'
 #' @examples
 #' nng_error(1L)
 #'
@@ -60,14 +73,26 @@ is_nul_byte <- function(x) identical(x, as.raw(0L))
 
 #' Is Error Value
 #'
-#' Is the object an error value generated by NNG. All receive functions class
-#'     integer error codes as 'errorValue' to be easily distinguishable from
-#'     integer message values.
+#' Is the object an error value generated by NNG. All returned integer error
+#'     codes are classed as 'errorValue' to be distinguishable from integer
+#'     message values.
 #'
 #' @param x an object.
 #'
 #' @return Logical value TRUE if 'x' is of class 'errorValue', FALSE otherwise.
 #'
+#' @section Warnings:
+#'
+#'     A warning is generated every time an 'errorValue' is returned. The package
+#'     changes the behaviour of warnings by setting \code{options(warn = 1)}
+#'     upon package load. This prints the warning to the console as soon as it
+#'     occurs, rather than the default of waiting for the top–level function to
+#'     return.
+#'
+#'     See \code{\link{warning}} or the entry for 'warn' in \code{\link{options}}
+#'     for further details. The original option value for 'warn' is reverted upon
+#'     package unload.
+#'
 #' @examples
 #' is_error_value(1L)
 #'

README.md

@@ -370,7 +370,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] -0.526 1.488 1.712 0.296 -0.703 ...
+#>  num [1:100000000] -0.257 -0.142 -0.473 0.718 -1.426 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -505,11 +505,11 @@ ncurl("http://httpbin.org/headers")
 #>   [1] 7b 0a 20 20 22 68 65 61 64 65 72 73 22 3a 20 7b 0a 20 20 20 20 22 48 6f 73
 #>  [26] 74 22 3a 20 22 68 74 74 70 62 69 6e 2e 6f 72 67 22 2c 20 0a 20 20 20 20 22
 #>  [51] 58 2d 41 6d 7a 6e 2d 54 72 61 63 65 2d 49 64 22 3a 20 22 52 6f 6f 74 3d 31
-#>  [76] 2d 36 32 34 64 36 33 32 33 2d 35 65 30 62 33 30 34 66 37 38 65 39 35 38 35
-#> [101] 34 36 33 37 63 62 31 66 30 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 32 34 65 30 30 36 64 2d 37 38 30 37 36 62 37 63 31 35 65 64 66 37 65
+#> [101] 37 31 64 36 62 32 34 63 35 22 0a 20 20 7d 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-624d6323-5e0b304f78e95854637cb1f0\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-624e006d-78076b7c15edf7e71d6b24c5\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
@@ -524,7 +524,7 @@ res
 #>  - $raw for raw message
 
 call_aio(res)$data
-#> [1] "{\n  \"args\": {}, \n  \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Length\": \"16\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-624d6323-7d89bacc230330e3541fdb6a\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"79.173.189.204\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
+#> [1] "{\n  \"args\": {}, \n  \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Length\": \"16\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-624e006d-06173bcd5b43d5622303afe5\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"78.145.225.121\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
 ```
 
 In this respect, it may be used as a performant and lightweight method