async capabilities for ncurl

Author: shikokuchuo

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: nanonext
 Type: Package
 Title: NNG (Nanomsg Next Gen) Lightweight Messaging Library
-Version: 0.3.0.9001
+Version: 0.3.0.9002
 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,9 +1,9 @@
-# nanonext 0.3.0.9001 (development)
+# nanonext 0.3.0.9002 (development)
 
 #### New Features
 
 * New `stream()` interface exposes low-level byte stream functionality in the NNG library, intended for communicating with non-NNG endpoints, including but not limited to websocket servers.
-* `ncurl()` adds explicit arguments supporting HTTP methods other than GET, including for setting the 'Authorization' header.
+* `ncurl()` adds an 'async' option to perform HTTP requests asynchronously, returning immediately with a 'recvAio'. Also adds explicit arguments for HTTP method, content type and authorization headers and request data.
 
 #### Updates
 

R/stream.R

@@ -75,6 +75,7 @@ stream <- function(dial = NULL, listen = NULL, textframes = FALSE) {
 #' nano cURL - a minimalist http(s) client.
 #'
 #' @param url the URL address.
+#' @param async [default FALSE] logical value whether to perform actions async.
 #' @param method (optional) the HTTP method.
 #' @param ctype (optional) the 'Content-type' header.
 #' @param auth (optional) the 'Authorization' header.
@@ -89,6 +90,8 @@ stream <- function(dial = NULL, listen = NULL, textframes = FALSE) {
 #'     as html, json, xml etc. if required.}
 #'     }
 #'
+#'     Or else, if \code{async = TRUE}, a 'recvAio' (object of class 'recvAio').
+#'
 #' @section Redirects:
 #'
 #'     In interactive sessions: will prompt upon receiving a redirect location
@@ -103,26 +106,74 @@ stream <- function(dial = NULL, listen = NULL, textframes = FALSE) {
 #'
 #' @examples
 #' ncurl("http://httpbin.org/get")
-#' ncurl("http://httpbin.org/put", "PUT", "text/plain", "Bearer APIKEY", "hello world")
-#' ncurl("http://httpbin.org/post", "POST", "application/json", data = '{"key": "value"}')
+#' ncurl("http://httpbin.org/put", ,"PUT", "text/plain", "Bearer APIKEY", "hello world")
+#' ncurl("http://httpbin.org/post", ,"POST", "application/json", ,'{"key": "value"}')
 #'
 #' @export
 #'
-ncurl <- function(url, method = NULL, ctype = NULL, auth = NULL, data = NULL) {
+ncurl <- function(url, async = FALSE, method = NULL, ctype = NULL, auth = NULL, data = NULL) {
 
   data <- if (!missing(data)) writeBin(object = data, con = raw())
-  res <- .Call(rnng_ncurl, url, method, ctype, auth, data)
-  missing(res) && return(invisible())
-  if (is.integer(res)) {
-    logerror(res)
-    return(invisible(res))
-  } else if (is.character(res)) {
-    continue <- if (interactive()) readline(sprintf("Follow redirect to <%s>? [Y/n] ", res)) else "n"
-    continue %in% c("n", "N", "no", "NO") && return(invisible(res))
-    return(ncurl(res))
-  }
-  data <- tryCatch(rawToChar(res), error = function(e) NULL)
-  list(raw = res, data = data)
 
+  if (missing(async) || !isTRUE(async)) {
+
+    res <- .Call(rnng_ncurl, url, method, ctype, auth, data)
+    missing(res) && return(invisible())
+    if (is.integer(res)) {
+      logerror(res)
+      return(invisible(res))
+    } else if (is.character(res)) {
+      continue <- if (interactive()) readline(sprintf("Follow redirect to <%s>? [Y/n] ", res)) else "n"
+      continue %in% c("n", "N", "no", "NO") && return(invisible(res))
+      return(ncurl(res))
+    }
+    data <- tryCatch(rawToChar(res), error = function(e) NULL)
+    list(raw = res, data = data)
+
+  } else {
+
+    aio <- .Call(rnng_ncurl_aio, url, method, ctype, auth, data)
+    is.integer(aio) && {
+      logerror(aio)
+      return(invisible(`class<-`(aio, "errorValue")))
+    }
+    env <- `class<-`(new.env(), "recvAio")
+    data <- raw <- NULL
+    unresolv <- TRUE
+    makeActiveBinding(sym = "raw", fun = function(x) {
+      if (unresolv) {
+        res <- .Call(rnng_aio_http, aio)
+        missing(res) && return(.Call(rnng_aio_unresolv))
+        is.integer(res) && {
+          data <<- raw <<- `class<-`(res, "errorValue")
+          unresolv <<- FALSE
+          logerror(res)
+          return(invisible(data))
+        }
+        raw <<- res
+        data <<- tryCatch(rawToChar(res), error = function(e) NULL)
+        unresolv <<- FALSE
+      }
+      raw
+    }, env = env)
+    makeActiveBinding(sym = "data", fun = function(x) {
+      if (unresolv) {
+        res <- .Call(rnng_aio_http, aio)
+        missing(res) && return(.Call(rnng_aio_unresolv))
+        is.integer(res) && {
+          data <<- raw <<- `class<-`(res, "errorValue")
+          unresolv <<- FALSE
+          logerror(res)
+          return(invisible(data))
+        }
+        raw <<- res
+        data <<- tryCatch(rawToChar(res), error = function(e) NULL)
+        unresolv <<- FALSE
+      }
+      data
+    }, env = env)
+    `[[<-`(`[[<-`(env, "keep.raw", TRUE), "aio", aio)
+
+  }
 }
 

README.Rmd

@@ -412,16 +412,16 @@ ncurl("http://httpbin.org/headers")
 
 ```
 
-For advanced use, supports additional HTTP methods such as POST or PUT.
+For advanced use, supports additional HTTP methods such as POST or PUT. In this respect, it may be used as a performant and lightweight method for making requests to REST APIs.
 
 ```{r ncurladv}
 
-res <- ncurl("http://httpbin.org/post", "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
-res$data
+res <- ncurl("http://httpbin.org/post", async = TRUE, "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+call_aio(res)$data
 
 ```
 
-In this respect, it may be used as a performant and lightweight method for making requests to REST APIs.
+There is also the option of performing requests asynchronously, in which case the function returns immediately with a 'recvAio'.
 
 [&laquo; Back to ToC](#table-of-contents)
 

README.md

@@ -370,7 +370,7 @@ aio
 #> < recvAio >
 #>  - $data for message data
 aio$data |> str()
-#>  num [1:100000000] -0.736 -1.684 0.223 0.326 1.103 ...
+#>  num [1:100000000] 1.079 0.855 -0.88 1.192 -0.777 ...
 ```
 
 As `call_aio()` is blocking and will wait for completion, an alternative
@@ -405,37 +405,37 @@ an environment variable `NANONEXT_LOG`.
 
 ``` r
 logging(level = "info")
-#> 2022-03-29 00:05:47 [ log level ] set to: info
+#> 2022-03-29 13:53:51 [ log level ] set to: info
 
 pub <- socket("pub", listen = "inproc://nanobroadcast")
-#> 2022-03-29 00:05:47 [ sock open ] id: 9 | protocol: pub
-#> 2022-03-29 00:05:47 [ list start ] sock: 9 | url: inproc://nanobroadcast
+#> 2022-03-29 13:53:51 [ sock open ] id: 9 | protocol: pub
+#> 2022-03-29 13:53:51 [ list start ] sock: 9 | url: inproc://nanobroadcast
 sub <- socket("sub", dial = "inproc://nanobroadcast")
-#> 2022-03-29 00:05:47 [ sock open ] id: 10 | protocol: sub
-#> 2022-03-29 00:05:47 [ dial start ] sock: 10 | url: inproc://nanobroadcast
+#> 2022-03-29 13:53:51 [ sock open ] id: 10 | protocol: sub
+#> 2022-03-29 13:53:51 [ dial start ] sock: 10 | url: inproc://nanobroadcast
 
 sub |> subscribe(topic = "examples")
-#> 2022-03-29 00:05:47 [ subscribe ] sock: 10 | topic: examples
+#> 2022-03-29 13:53:51 [ subscribe ] sock: 10 | 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-29 00:05:47 [ 8 ] Try again
+#> 2022-03-29 13:53:51 [ 8 ] Try again
 
 # specify NULL to subscribe to ALL topics
 sub |> subscribe(topic = NULL)
-#> 2022-03-29 00:05:47 [ subscribe ] sock: 10 | topic: ALL
+#> 2022-03-29 13:53:51 [ subscribe ] sock: 10 | 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-29 00:05:47 [ unsubscribe ] sock: 10 | topic: ALL
+#> 2022-03-29 13:53:51 [ unsubscribe ] sock: 10 | 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-29 00:05:47 [ 8 ] Try again
+#> 2022-03-29 13:53:51 [ 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)
@@ -444,7 +444,7 @@ sub |> recv(mode = "character", keep.raw = FALSE)
 
 # set logging level back to the default of errors only
 logging(level = "error")
-#> 2022-03-29 00:05:47 [ log level ] set to: error
+#> 2022-03-29 13:53:51 [ log level ] set to: error
 
 close(pub)
 close(sub)
@@ -495,7 +495,7 @@ aio2$data
 # after the survey expires, the second resolves into a timeout error
 Sys.sleep(0.5)
 aio2$data
-#> 2022-03-29 00:05:48 [ 5 ] Timed out
+#> 2022-03-29 13:53:52 [ 5 ] Timed out
 #> 'errorValue' int 5
 
 close(sur)
@@ -521,23 +521,25 @@ 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 32 33 66 34 63 2d 35 31 38 62 62 65 38 66 34 31 65 31 37 37 39
-#> [101] 63 34 32 34 61 35 61 62 33 22 0a 20 20 7d 0a 7d 0a
+#>  [76] 2d 36 32 34 33 30 31 36 30 2d 31 30 36 36 64 32 64 35 32 35 33 34 62 34 37
+#> [101] 36 35 37 65 32 34 30 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-62423f4c-518bbe8f41e1779c424a5ab3\"\n  }\n}\n"
+#> [1] "{\n  \"headers\": {\n    \"Host\": \"httpbin.org\", \n    \"X-Amzn-Trace-Id\": \"Root=1-62430160-1066d2d52534b47657e240b2\"\n  }\n}\n"
 ```
 
 For advanced use, supports additional HTTP methods such as POST or PUT.
+In this respect, it may be used as a performant and lightweight method
+for making requests to REST APIs.
 
 ``` r
-res <- ncurl("http://httpbin.org/post", "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
-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-62423f4c-4de27fd3765f72b51e01d918\"\n  }, \n  \"json\": {\n    \"key\": \"value\"\n  }, \n  \"origin\": \"78.145.225.121\", \n  \"url\": \"http://httpbin.org/post\"\n}\n"
+res <- ncurl("http://httpbin.org/post", async = TRUE, "POST", "application/json", "Bearer APIKEY", '{"key": "value"}')
+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-62430160-4b8917cd2b569d8c0294f5ca\"\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
-for making requests to REST APIs.
+There is also the option of performing requests asynchronously, in which
+case the function returns immediately with a ‘recvAio’.
 
 [« Back to ToC](#table-of-contents)