Adds synchronisation primitives to package description

Author: shikokuchuo

DESCRIPTION

@@ -7,7 +7,9 @@ Description: R binding for NNG (Nanomsg Next Gen), a successor to ZeroMQ. NNG is
     implementing a cross-platform standard for messaging and communications.
     Serves as a concurrency framework for building distributed applications,
     utilising 'aio' objects which resolve automatically upon completion of
-    asynchronous operations.
+    asynchronous operations. Provides synchronisation primitives which allow R
+    to wait upon socket events or message receives being signalled by other
+    underlying threads.
 Authors@R: 
     c(person(given = "Charlie",
              family = "Gao",

R/nanonext-package.R

@@ -23,7 +23,9 @@
 #'     cross-platform standard for messaging and communications. Serves as a
 #'     concurrency framework for building distributed applications, utilising
 #'     'aio' objects which resolve automatically upon completion of asynchronous
-#'     operations.
+#'     operations. Provides synchronisation primitives which allow R to wait
+#'     upon socket events or message receives being signalled by other
+#'     underlying threads.
 #'
 #' @section Usage notes:
 #'

README.Rmd

@@ -22,7 +22,7 @@ knitr::opts_chunk$set(
 [![codecov](https://codecov.io/gh/shikokuchuo/nanonext/branch/main/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/nanonext)
 <!-- badges: end -->
 
-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. Serves as a concurrency framework for building distributed applications, utilising 'aio' objects which resolve automatically upon completion of asynchronous operations.
+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. Serves as a concurrency framework for building distributed applications, utilising 'aio' objects which resolve automatically upon completion of asynchronous operations. Provides synchronisation primitives which allow R to wait upon socket events or message receives being signalled by other underlying threads.
 
 Designed for performance and reliability, the NNG library is written in C and {nanonext} is a lightweight zero-dependency wrapper. Provides the interface for code and processes to communicate with each other - receive data generated in Python, perform analysis in R, and send results to a C++ program – all on the same computer or on networks spanning the globe.
 

README.md

@@ -18,7 +18,9 @@ socket library providing high-performance scalability protocols,
 implementing a cross-platform standard for messaging and communications.
 Serves as a concurrency framework for building distributed applications,
 utilising ‘aio’ objects which resolve automatically upon completion of
-asynchronous operations.
+asynchronous operations. Provides synchronisation primitives which allow
+R to wait upon socket events or message receives being signalled by
+other underlying threads.
 
 Designed for performance and reliability, the NNG library is written in
 C and {nanonext} is a lightweight zero-dependency wrapper. Provides the
@@ -367,7 +369,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] -1.959 0.507 0.83 -0.458 0.844 ...
+#>  num [1:100000000] -0.9135 -0.0486 -2.2213 -0.247 0.6944 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -651,11 +653,11 @@ ncurl("https://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 34 31 64 34 64 36 63 2d 34 65 62 61 38 36 65 66 37 62 34 35 64 37 65
-#> [101] 36 36 30 30 65 33 62 31 30 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 34 31 64 39 34 35 37 2d 36 63 64 61 33 38 30 34 30 62 35 37 65 66 62
+#> [101] 62 35 39 31 37 38 65 39 30 22 0a 20 20 7d 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-641d4d6c-4eba86ef7b45d7e6600e3b10\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-641d9457-6cda38040b57efbb59178e90\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
@@ -676,13 +678,13 @@ res
 
 call_aio(res)$headers
 #> $Date
-#> [1] "Fri, 24 Mar 2023 07:12:44 GMT"
+#> [1] "Fri, 24 Mar 2023 12:15:20 GMT"
 #> 
 #> $Server
 #> [1] "gunicorn/19.9.0"
 
 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-641d4d6c-4ff4b2e17fd2884123ae75b1\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"131.111.5.14\", \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-641d9458-5f205e8b7bfe624f5f89a231\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"131.111.5.14\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
 ```
 
 In this respect, it may be used as a performant and lightweight method
@@ -708,7 +710,7 @@ transact(sess)
 #> 
 #> $headers
 #> $headers$date
-#> [1] "Fri, 24 Mar 2023 07:12:45 GMT"
+#> [1] "Fri, 24 Mar 2023 12:15:20 GMT"
 #> 
 #> 
 #> $raw
@@ -719,14 +721,14 @@ transact(sess)
 #> [101] 69 6f 6e 2f 6a 73 6f 6e 22 2c 20 0a 20 20 20 20 22 48 6f 73 74 22 3a 20 22
 #> [126] 68 74 74 70 62 69 6e 2e 6f 72 67 22 2c 20 0a 20 20 20 20 22 58 2d 41 6d 7a
 #> [151] 6e 2d 54 72 61 63 65 2d 49 64 22 3a 20 22 52 6f 6f 74 3d 31 2d 36 34 31 64
-#> [176] 34 64 36 64 2d 37 33 32 39 61 30 35 61 36 65 34 35 38 31 33 37 36 35 36 36
-#> [201] 37 38 37 34 22 0a 20 20 7d 2c 20 0a 20 20 22 6f 72 69 67 69 6e 22 3a 20 22
-#> [226] 31 38 35 2e 32 32 35 2e 34 35 2e 34 39 22 2c 20 0a 20 20 22 75 72 6c 22 3a
-#> [251] 20 22 68 74 74 70 73 3a 2f 2f 68 74 74 70 62 69 6e 2e 6f 72 67 2f 67 65 74
-#> [276] 22 0a 7d 0a
+#> [176] 39 34 35 38 2d 37 63 35 38 34 30 31 34 37 63 33 38 30 64 61 63 36 30 32 34
+#> [201] 36 39 62 63 22 0a 20 20 7d 2c 20 0a 20 20 22 6f 72 69 67 69 6e 22 3a 20 22
+#> [226] 37 39 2e 31 37 33 2e 31 32 39 2e 32 22 2c 20 0a 20 20 22 75 72 6c 22 3a 20
+#> [251] 22 68 74 74 70 73 3a 2f 2f 68 74 74 70 62 69 6e 2e 6f 72 67 2f 67 65 74 22
+#> [276] 0a 7d 0a
 #> 
 #> $data
-#> [1] "{\n  \"args\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-641d4d6d-7329a05a6e45813765667874\"\n  }, \n  \"origin\": \"131.111.5.14\", \n  \"url\": \"https://httpbin.org/get\"\n}\n"
+#> [1] "{\n  \"args\": {}, \n  \"headers\": {\n    \"Authorization\": \"Bearer APIKEY\", \n    \"Content-Type\": \"application/json\", \n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-641d9458-7c5840147c380dac602469bc\"\n  }, \n  \"origin\": \"131.111.5.14\", \n  \"url\": \"https://httpbin.org/get\"\n}\n"
 ```
 
 [« Back to ToC](#table-of-contents)