clean configure & document TLS build options

Author: shikokuchuo

R/stream.R

@@ -25,8 +25,10 @@
 #'     Specify only one of 'dial' or 'listen'. If both are specified, 'listen'
 #'     will be ignored.
 #'
-#'     TLS is automatically configured for dialing a secure websocket address
-#'     starting 'wss://' (where the NNG library has been built with TLS support).
+#' @section TLS Support:
+#'
+#'     Dialing a secure websocket address starting 'wss://' is supported if
+#'     \code{\link{nng_version}} shows 'TLS supported'.
 #'
 #' @examples
 #' # will succeed only if there is an open connection at the address:

R/utils.R

@@ -8,10 +8,21 @@
 #'
 #' @section TLS Support:
 #'
-#'     The environment variable 'NANONEXT_TLS' may be set, e.g. by
-#'     \code{Sys.setenv(NANONEXT_TLS=1)}, prior to package installation to enable
-#'     TLS where the system NNG library has been built with TLS support (using
-#'     Mbed TLS). Note: this is not applicable to Windows systems.
+#'     Where system installations of 'libnng' and 'libmbedtls' development
+#'     headers are detected in the same location, it is assumed that NNG was
+#'     built with TLS support (using Mbed TLS) and TLS is configured appropriately.
+#'
+#'     Otherwise, the environment variable `Sys.setenv(NANONEXT_TLS=1)` may be
+#'     set prior to installation if:
+#'
+#'     - your system installations of 'libnng' (built with TLS support) and
+#'     'libmbedtls' are in different locations; or
+#'
+#'     - you have a system installation of 'libmbedtls' but not 'libnng' and want
+#'     nanonext to download and build a more recent version of 'libnng' than
+#'     available in system repositories against this.
+#'
+#'     Note: this is not applicable to Windows systems.
 #'
 #' @examples
 #' nng_version()

README.Rmd

@@ -459,21 +459,23 @@ This is available in system package repositories as:
 -   `libnng-dev` (deb)
 -   `nng-devel` (rpm)
 -   `nng` (Homebrew on MacOS)
--   `nng` from vcpkg (see <https://vcpkg.io/>).
 
 A system installation of 'libnng' in the standard filesystem locations will be detected and used if possible.
 
-Otherwise, a release version of 'libnng' will be downloaded and built from source automatically during package installation (note: this requires 'cmake').
+Otherwise, a suitable recent version of 'libnng' will be downloaded and built from source automatically during package installation (note: this requires 'cmake').
 
 #### Windows
 
 Pre-built libraries (for i386 / x64 / x64-UCRT) are automatically 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 system installations of 'libnng' and 'libmbedtls' development headers are detected in the same location, it is assumed that NNG was built with TLS support (using Mbed TLS) and TLS support is configured appropriately.
 
-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.
+Otherwise, the environment variable `Sys.setenv(NANONEXT_TLS=1)` may be set prior to installation if:
+
+- your system installations of 'libnng' (built with TLS support) and 'libmbedtls' are in different locations; or
+- you have a system installation of 'libmbedtls' but not 'libnng' and want nanonext to download and build a more recent version of 'libnng' than available in system repositories against this.
 
 #### Certain ARM architectures
 

README.md

@@ -377,7 +377,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] 1.361 -0.547 1.283 -0.905 -1.785 ...
+#>  num [1:100000000] -0.479 -0.448 0.216 -0.424 0.037 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -512,11 +512,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 35 33 33 33 66 37 2d 31 38 35 39 61 30 31 35 30 30 39 61 38 36 63
-#> [101] 64 35 37 31 63 38 31 35 35 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 32 35 66 65 35 62 35 2d 34 38 38 66 62 31 34 63 32 36 36 37 66 39 65
+#> [101] 66 32 30 31 65 33 30 32 38 22 0a 20 20 7d 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-625333f7-1859a015009a86cd571c8155\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-625fe5b5-488fb14c2667f9ef201e3028\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
@@ -531,7 +531,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-625333f8-02809e8e020ccb400cecf3e9\"\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-625fe5b5-073a52686414e1556c6f9853\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"79.173.189.204\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
 ```
 
 In this respect, it may be used as a performant and lightweight method
@@ -581,13 +581,12 @@ This is available in system package repositories as:
 -   `libnng-dev` (deb)
 -   `nng-devel` (rpm)
 -   `nng` (Homebrew on MacOS)
--   `nng` from vcpkg (see <https://vcpkg.io/>).
 
 A system installation of ‘libnng’ in the standard filesystem locations
 will be detected and used if possible.
 
-Otherwise, a release version of ‘libnng’ will be downloaded and built
-from source automatically during package installation (note: this
+Otherwise, a suitable recent version of ‘libnng’ will be downloaded and
+built from source automatically during package installation (note: this
 requires ‘cmake’).
 
 #### Windows
@@ -597,16 +596,19 @@ 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 system installations of ‘libnng’ and ‘libmbedtls’ development headers
+are detected in the same location, it is assumed that NNG was built with
+TLS support (using Mbed TLS) and TLS support is configured
+appropriately.
 
-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.
+Otherwise, the environment variable `Sys.setenv(NANONEXT_TLS=1)` may be
+set prior to installation if:
+
+-   your system installations of ‘libnng’ (built with TLS support) and
+    ‘libmbedtls’ are in different locations; or
+-   you have a system installation of ‘libmbedtls’ but not ‘libnng’ and
+    want nanonext to download and build a more recent version of
+    ‘libnng’ than available in system repositories against this.
 
 #### Certain ARM architectures
 

configure

@@ -23,16 +23,6 @@ if [ "$INCLUDE_DIR" ] || [ "$LIB_DIR" ]; then
   PKG_CFLAGS="-I$INCLUDE_DIR $PKG_CFLAGS"
   PKG_LIBS="-L$LIB_DIR $PKG_LIBS"
 
-elif [ -d "$HOME/vcpkg/installed/x64-linux/include/nng" ]; then
-  echo "found libnng vcpkg installation..."
-  PKG_CFLAGS="-I$HOME/vcpkg/installed/x64-linux/include $PKG_CFLAGS"
-  PKG_LIBS="-L$HOME/vcpkg/installed/x64-linux/lib $PKG_LIBS"
-  if [ -d "$HOME/vcpkg/installed/x64-linux/include/mbedtls" ]; then
-    echo "found mbedtls vcpkg installation... using TLS support"
-    PKG_LIBS="$PKG_LIBS -lmbedtls -lmbedx509 -lmbedcrypto"
-  fi
-  SYS_LIB=1
-
 elif [ -d "/usr/local/include/nng" ]; then
   echo "found system libnng installation..."
   PKG_CFLAGS="-I/usr/local/include $PKG_CFLAGS"
@@ -110,11 +100,7 @@ if [ $? -ne 0 ]; then
     echo "Automatic download and/or build also failed. Try installing:"
     echo " * deb: libnng-dev (Debian, Ubuntu, etc.)"
     echo " * rpm: nng-devel (Fedora, CentOS etc.)"
-    echo " * arch: https://aur.archlinux.org/nng.git (Arch from AUR)"
     echo " * brew: nng (MacOS)"
-    echo "Alternatively:"
-    echo " * vcpkg: nng (Linux/MacOS, follow getting started instructions at"
-    echo "               https://vcpkg.io/ starting from your HOME directory)"
     echo "If 'libnng' is already installed but in a non-standard location, you"
     echo "may set INCLUDE_DIR and LIB_DIR manually via:"
     echo "R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'"
@@ -154,11 +140,7 @@ if [ $? -ne 0 ]; then
       echo "Automatic download and/or build also failed. Try installing:"
       echo " * deb: libnng-dev (Debian, Ubuntu, etc.)"
       echo " * rpm: nng-devel (Fedora, CentOS etc.)"
-      echo " * arch: https://aur.archlinux.org/nng.git (Arch from AUR)"
       echo " * brew: nng (MacOS)"
-      echo "Alternatively:"
-      echo " * vcpkg: nng (Linux/MacOS, follow getting started instructions at"
-      echo "               https://vcpkg.io/ starting from your HOME directory)"
       echo "If 'libnng' is already installed but in a non-standard location, you"
       echo "may set INCLUDE_DIR and LIB_DIR manually via:"
       echo "R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'"