Automatically detect libmbedtls

Author: shikokuchuo

NEWS.md

@@ -18,6 +18,7 @@
 * Common format for NNG errors and informational events now starts with a timestamp for easier logging.
 * Allows setting the environment variable 'NANONEXT_ARM' prior to package installation
   + Fixes installation issues on certain ARM architectures
+* Package installation using a system 'libnng' now automatically detects 'libmbedtls', removing the need to manually set 'NANONEXT_TLS' in this case.
 * More streamlined NNG build process eliminating unused options.
 * Removes experimental `nng_timer()` utility as a non-essential function.
 * Deprecated functions 'send_vec' and 'recv_vec' removed.

R/aio.R

@@ -123,7 +123,7 @@ stop_aio <- function(aio) {
 #'
 unresolved <- function(aio) {
 
-  {inherits(aio, "unresolvedExpr") && inherits(.subset2(aio, "data"), "unresolvedValue") ||
+  {inherits(aio, "unresolvedExpr") && inherits(.subset2(aio, "data"), "unresolvedExpr") ||
       inherits(aio, "unresolvedValue") ||
       inherits(aio, "recvAio") && inherits(.subset2(aio, "data"), "unresolvedValue") ||
       inherits(aio, "sendAio") && inherits(.subset2(aio, "result"), "unresolvedValue")} &&

R/pipe.R

@@ -0,0 +1,97 @@
+# nanonext - Deferred Evaluation Pipe ------------------------------------------
+
+#' Deferred Evaluation Pipe
+#'
+#' Pipe a possibly unresolved value forward into a function.
+#'
+#' @param x a value that is possibly an 'unresolvedValue'.
+#' @param f a function that accepts 'x' as its first argument.
+#'
+#' @return The evaluated result, or if x is an 'unresolvedValue', an
+#'     'unresolvedExpr'.
+#'
+#' @details An 'unresolvedExpr' encapsulates the eventual evaluation result.
+#'     Query its \code{$data} element for resolution. Once resolved, the object
+#'     changes into a 'resolvedExpr' and the evaluated result will be available
+#'     at \code{$data}.
+#'
+#'     Supports stringing together a series of piped expressions (as per
+#'     the below example).
+#'
+#'     \code{\link{unresolved}} may be used on an 'unresolvedExpr' or its
+#'     \code{$data} element to test for resolution.
+#'
+#'     This function is marked [experimental], which means it is currently
+#'     under development. Please note that the final implementation is likely to
+#'     differ from the current version.
+#'
+#' @section Usage:
+#'
+#'     Usage is similar to R's native \code{|>} pipe.
+#'
+#'     \code{x \%>>\% f} is equivalent to \code{f(x)}
+#'
+#'     \code{x \%>>\% f()} is equivalent to \code{f(x)}
+#'
+#'     \code{x \%>>\% f(y)} is equivalent to \code{f(x, y)}
+#'
+#'     Please note that other usage is not supported and it is not a drop-in
+#'     replacement for magrittr's \code{\%>\%} pipe.
+#'
+#' @examples
+#' if (interactive()) {
+#' # Only run examples in interactive R sessions
+#'
+#' s1 <- socket("pair", listen = "inproc://nanonext")
+#' s2 <- socket("pair", dial = "inproc://nanonext")
+#'
+#' msg <- recv_aio(s2)
+#' b <- msg$data %>>% c(2, 3) %>>% as.character()
+#' b
+#' res <- send_aio(s1, 1)
+#' b$data
+#'
+#' close(s1)
+#' close(s2)
+#' }
+#'
+#' @export
+#'
+`%>>%` <- function(x, f) {
+  if (unresolved(x)) {
+    mc <- match.call()
+    data <- NULL
+    env <- `class<-`(new.env(), c("unresolvedExpr"))
+    makeActiveBinding(sym = "data", fun = function(x) {
+      if (is.null(data)) data <- eval(mc, envir = parent.frame(), enclos = baseenv())
+      if (!inherits(data, "unresolvedExpr")) `class<-`(env, "resolvedExpr")
+      data
+    }, env = env)
+    env
+  } else {
+    x <- substitute(x)
+    y <- substitute(f)
+    if (is.symbol(y)) {
+      eval(as.call(c(y, x)), envir = parent.frame(2L), enclos = baseenv())
+    } else {
+      f <- y[[1L]]
+      y[[1L]] <- NULL
+      eval(as.call(c(f, x, y)), envir = parent.frame(2L), enclos = baseenv())
+    }
+  }
+}
+
+#' @export
+#'
+print.unresolvedExpr <- function(x, ...) {
+  cat("< unresolvedExpr >\n - $data to query resolution\n", file = stdout())
+  invisible(x)
+}
+
+#' @export
+#'
+print.resolvedExpr <- function(x, ...) {
+  cat("< resolvedExpr: $data >\n", file = stdout())
+  invisible(x)
+}
+

R/utils.R

@@ -217,95 +217,3 @@ ncurl <- function(http, ...) {
 
 }
 
-#' Deferred Evaluation Pipe
-#'
-#' Pipe a possibly unresolved value forward into a function.
-#'
-#' @param x a value that is possibly an 'unresolvedValue'.
-#' @param f a function that accepts 'x' as its first argument.
-#'
-#' @return The evaluated result, or if x is an 'unresolvedValue', an
-#'     'unresolvedExpr'.
-#'
-#' @details An 'unresolvedExpr' encapsulates the eventual evaluation result.
-#'     Query its \code{$data} element for resolution. Once resolved, the object
-#'     will change to a 'resolvedExpr' and the evaluated result will be accessible
-#'     at \code{$data}.
-#'
-#'     Supports stringing together a series of piped expressions (as per
-#'     the below example).
-#'
-#'     \code{\link{unresolved}} may be used on an 'unresolvedExpr' or its
-#'     \code{$data} element to test for resolution.
-#'
-#'     This function is marked [experimental], which means it is currently
-#'     under development. Please note that the final implementation is likely to
-#'     differ from the current version.
-#'
-#' @section Usage:
-#'
-#'     \code{x \%>>\% f} is equivalent to \code{f(x)}
-#'
-#'     \code{x \%>>\% f()} is equivalent to \code{f(x)}
-#'
-#'     \code{x \%>>\% f(y)} is equivalent to \code{f(x, y)}
-#'
-#' @examples
-#' if (interactive()) {
-#' # Only run examples in interactive R sessions
-#'
-#' s1 <- socket("pair", listen = "inproc://nanonext")
-#' s2 <- socket("pair", dial = "inproc://nanonext")
-#'
-#' msg <- recv_aio(s2)
-#' b <- msg$data %>>% c(2, 3) %>>% as.character()
-#' b
-#' res <- send_aio(s1, 1)
-#' b$data
-#'
-#' close(s1)
-#' close(s2)
-#' }
-#'
-#' @export
-#'
-`%>>%` <- function(x, f) {
-  if (unresolved(x)) {
-    mc <- match.call()
-    data <- NULL
-    env <- `class<-`(new.env(), c("unresolvedExpr", "unresolvedValue"))
-    makeActiveBinding(sym = "data", fun = function(x) {
-      if (is.null(data)) data <- eval(mc, envir = parent.frame(), enclos = baseenv())
-      if (!inherits(data, "unresolvedExpr")) `class<-`(env, "resolvedExpr")
-      data
-    }, env = env)
-    env
-  } else {
-    x <- substitute(x)
-    y <- substitute(f)
-    if (is.symbol(y)) {
-      eval(as.call(c(y, x)), envir = parent.frame(2L), enclos = baseenv())
-    } else {
-      f <- y[[1L]]
-      y[[1L]] <- NULL
-      eval(as.call(c(f, x, y)), envir = parent.frame(2L), enclos = baseenv())
-    }
-  }
-}
-
-#' @export
-#'
-print.unresolvedExpr <- function(x, ...) {
-  cat("< unresolvedExpr >\n - $data to query resolution\n", file = stdout())
-  invisible(x)
-}
-
-#' @export
-#'
-print.resolvedExpr <- function(x, ...) {
-  cat("< resolvedExpr >\n - $data for evaluated expression\n", file = stdout())
-  invisible(x)
-}
-
-
-

README.Rmd

@@ -261,9 +261,9 @@ close(s2)
 
 Simply pipe the value forward into a function or series of functions and it either evaluates or returns an 'unresolvedExpr'.
 
-The result may be queried at `$data`, which will return another 'unresolvedExpr' recursively (by design) whilst unresolved. However when the original value resolves, the 'unresolvedExpr' will resolve into a 'resolvedExpr' and the evaluated expression may then be accessed at \code{$data}. 
+The result may be queried at `$data`, which will return another 'unresolvedExpr' whilst unresolved. However when the original value resolves, the 'unresolvedExpr' will simultaneously resolve into a 'resolvedExpr', for which the evaluated result will be available at `$data`. 
 
-It is possible to use `unresolved()` around a 'unresolvedExpr' or its `$data` field to test for resolution, as in the example below.
+It is possible to use `unresolved()` around a 'unresolvedExpr' or its `$data` element to test for resolution, as in the example below.
 
 The pipe operator semantics are similar to R's base pipe `|>`:
 
@@ -480,7 +480,9 @@ Pre-built libraries (for i386 / x64 / x64-UCRT) are automatically downloaded dur
 
 #### TLS Support
 
-If your system installation of NNG was built with TLS support (using Mbed TLS), please set the environment variable `Sys.setenv(NANONEXT_TLS=1)` before attempting to install the package. This will ensure the correct linker flags are set for a successful install.
+If a system installation of 'libnng' and 'libmbedtls' development headers are both detected in the same location, it is assumed that NNG was built with TLS support (using Mbed TLS) and the appropriate options are set to ensure a successful install.
+
+If your system installation of NNG was built with TLS support (using Mbed TLS) but detection of 'libmbedtls' failed (possibly as it was installed in another location), you may also set the environment variable `Sys.setenv(NANONEXT_TLS=1)` before installing the package to ensure that the appropriate options are set.
 
 #### Certain ARM architectures
 

README.md

@@ -330,12 +330,13 @@ Simply pipe the value forward into a function or series of functions and
 it either evaluates or returns an ‘unresolvedExpr’.
 
 The result may be queried at `$data`, which will return another
-‘unresolvedExpr’ recursively (by design) whilst unresolved. However when
-the original value resolves, the ‘unresolvedExpr’ will resolve into a
-‘resolvedExpr’ and the evaluated expression may then be accessed at .
+‘unresolvedExpr’ whilst unresolved. However when the original value
+resolves, the ‘unresolvedExpr’ will simultaneously resolve into a
+‘resolvedExpr’, for which the evaluated result will be available at
+`$data`.
 
 It is possible to use `unresolved()` around a ‘unresolvedExpr’ or its
-`$data` field to test for resolution, as in the example below.
+`$data` element to test for resolution, as in the example below.
 
 The pipe operator semantics are similar to R’s base pipe `|>`:
 
@@ -361,8 +362,7 @@ s <- send_aio(s1, 1)
 unresolved(res)
 #> [1] FALSE
 res
-#> < resolvedExpr >
-#>  - $data for evaluated expression
+#> < resolvedExpr: $data >
 res$data
 #> [1] "1" "2" "3"
 
@@ -421,7 +421,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] -0.149 1.493 -1.299 1.694 1.856 ...
+#>  num [1:100000000] -0.82 0.147 1.761 0.425 0.182 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -456,37 +456,37 @@ an environment variable `NANONEXT_LOG`.
 
 ``` r
 logging(level = "info")
-#> 2022-03-07 00:33:28 [ log level ] set to: info
+#> 2022-03-07 22:11:21 [ log level ] set to: info
 
 pub <- socket("pub", listen = "inproc://nanobroadcast")
-#> 2022-03-07 00:33:28 [ sock open ] id: 11 | protocol: pub
-#> 2022-03-07 00:33:28 [ list start ] sock: 11 | url: inproc://nanobroadcast
+#> 2022-03-07 22:11:21 [ sock open ] id: 11 | protocol: pub
+#> 2022-03-07 22:11:21 [ list start ] sock: 11 | url: inproc://nanobroadcast
 sub <- socket("sub", dial = "inproc://nanobroadcast")
-#> 2022-03-07 00:33:28 [ sock open ] id: 12 | protocol: sub
-#> 2022-03-07 00:33:28 [ dial start ] sock: 12 | url: inproc://nanobroadcast
+#> 2022-03-07 22:11:21 [ sock open ] id: 12 | protocol: sub
+#> 2022-03-07 22:11:21 [ dial start ] sock: 12 | url: inproc://nanobroadcast
 
 sub |> subscribe(topic = "examples")
-#> 2022-03-07 00:33:28 [ subscribe ] sock: 12 | topic: examples
+#> 2022-03-07 22:11:21 [ subscribe ] sock: 12 | topic: examples
 pub |> send(c("examples", "this is an example"), mode = "raw", echo = FALSE)
 sub |> recv(mode = "character", keep.raw = FALSE)
 #> [1] "examples"           "this is an example"
 
 pub |> send(c("other", "this other topic will not be received"), mode = "raw", echo = FALSE)
 sub |> recv(mode = "character", keep.raw = FALSE)
-#> 2022-03-07 00:33:28 [ 8 ] Try again
+#> 2022-03-07 22:11:21 [ 8 ] Try again
 
 # specify NULL to subscribe to ALL topics
 sub |> subscribe(topic = NULL)
-#> 2022-03-07 00:33:28 [ subscribe ] sock: 12 | topic: ALL
+#> 2022-03-07 22:11:21 [ subscribe ] sock: 12 | topic: ALL
 pub |> send(c("newTopic", "this is a new topic"), mode = "raw", echo = FALSE)
 sub |> recv("character", keep.raw = FALSE)
 #> [1] "newTopic"            "this is a new topic"
 
 sub |> unsubscribe(topic = NULL)
-#> 2022-03-07 00:33:28 [ unsubscribe ] sock: 12 | topic: ALL
+#> 2022-03-07 22:11:21 [ unsubscribe ] sock: 12 | topic: ALL
 pub |> send(c("newTopic", "this topic will now not be received"), mode = "raw", echo = FALSE)
 sub |> recv("character", keep.raw = FALSE)
-#> 2022-03-07 00:33:28 [ 8 ] Try again
+#> 2022-03-07 22:11:21 [ 8 ] Try again
 
 # however the topics explicitly subscribed to are still received
 pub |> send(c("examples", "this example will still be received"), mode = "raw", echo = FALSE)
@@ -495,7 +495,7 @@ sub |> recv(mode = "character", keep.raw = FALSE)
 
 # set logging level back to the default of errors only
 logging(level = "error")
-#> 2022-03-07 00:33:28 [ log level ] set to: error
+#> 2022-03-07 22:11:21 [ log level ] set to: error
 
 close(pub)
 close(sub)
@@ -546,7 +546,7 @@ aio2$data
 # after the survey expires, the second resolves into a timeout error
 Sys.sleep(0.5)
 aio2$data
-#> 2022-03-07 00:33:29 [ 5 ] Timed out
+#> 2022-03-07 22:11:22 [ 5 ] Timed out
 #> 'errorValue' int 5
 
 close(sur)
@@ -572,11 +572,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 32 35 35 32 64 39 2d 33 65 32 38 34 66 63 30 36 37 62 65 37 32 65
-#> [101] 63 33 66 61 61 34 65 30 34 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 32 32 36 38 33 30 61 2d 33 61 62 32 30 31 39 64 35 34 64 33 66 63 66
+#> [101] 30 32 37 30 39 66 62 62 32 22 0a 20 20 7d 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-622552d9-3e284fc067be72ec3faa4e04\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-6226830a-3ab2019d54d3fcf02709fbb2\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
@@ -611,11 +611,16 @@ downloaded during the package installation process.
 
 #### TLS Support
 
+If a system installation of ‘libnng’ and ‘libmbedtls’ development
+headers are both detected in the same location, it is assumed that NNG
+was built with TLS support (using Mbed TLS) and the appropriate options
+are set to ensure a successful install.
+
 If your system installation of NNG was built with TLS support (using
-Mbed TLS), please set the environment variable
-`Sys.setenv(NANONEXT_TLS=1)` before attempting to install the package.
-This will ensure the correct linker flags are set for a successful
-install.
+Mbed TLS) but detection of ‘libmbedtls’ failed (possibly as it was
+installed in another location), you may also set the environment
+variable `Sys.setenv(NANONEXT_TLS=1)` before installing the package to
+ensure that the appropriate options are set.
 
 #### Certain ARM architectures