nanonext 0.7.0 documentation updates

Author: shikokuchuo

DESCRIPTION

@@ -9,7 +9,7 @@ Description: R binding for NNG (Nanomsg Next Gen), a successor to ZeroMQ. NNG is
     utilising 'Aio' objects which automatically resolve upon completion of
     asynchronous operations.
 Authors@R: 
-    c(person(given = "Charlie", 
+    c(person(given = "Charlie",
              family = "Gao",
              role = c("aut", "cre"),
              email = "[email protected]",

NEWS.md

@@ -1,4 +1,6 @@
-# nanonext 0.6.0.9700 (development)
+# nanonext 0.6.0.9700 (0.7.0 release candidate)
+
+*nanonext 0.7 has focused on optimising the API after completing feature additions and performance enhancements; the API is again expected to remain stable after these changes*
 
 #### New Features
 
@@ -22,6 +24,7 @@
 
 *Other changes:*
 
+* Integer send/recv (and setopt) arguments implemented in 0.5.3 are now documented and considered part of the API. This is a performance feature that skips matching the character argument value.
 * Fixes bug introduced in 0.6.0 where Aios returning 'errorValues' are not cached with the class, returning only integer values when accessed subsequently.
 * Fixes potential crash when `base64dec()` encounters invalid input data. Error messages have been revised to be more accurate.
 * Fixes the `$` method for 'recvAio' objects for when the object has been stopped using `stop_aio()`.
@@ -33,6 +36,8 @@
 
 # nanonext 0.6.0
 
+*The nanonext 0.6 series incorporates significant advances in performance and stability over previous releases*
+
 #### New Features
 
 * Implements `base64enc()` and `base64dec()` base64 encoding and decoding using the 'Mbed TLS' library.
@@ -116,6 +121,8 @@
 
 # nanonext 0.5.0
 
+*nanonext is now considered substantially feature-complete and API-stable*
+
 #### New Features
 
 * `$context()` method added for creating new contexts from nano Objects using supported protocols (i.e. req, rep, sub, surveyor, respondent) - this replaces the `context()` function for nano Objects.

R/context.R

@@ -80,12 +80,16 @@ close.nanoContext <- function(con, ...) invisible(.Call(rnng_ctx_close, con))
 #'     as a raw vector. Use 'serial' for sending and receiving within R to ensure
 #'     perfect reproducibility. Use 'raw' for sending vectors of any type (will be
 #'     converted to a raw byte vector for sending) - essential when interfacing
-#'     with external applications.
+#'     with external applications. Alternatively, for performance, specify an
+#'     integer position in the vector of choices i.e. 1L for 'serial' or 2L for
+#'     'raw'.
 #' @param recv_mode [default 'serial'] mode of vector to be received - one of
 #'     'serial', 'character', 'complex', 'double', 'integer', 'logical',
-#'     'numeric', or 'raw'. The default 'serial' means a serialised R object, for
-#'     the other modes, the raw vector received will be converted into the
-#'     respective mode.
+#'     'numeric', or 'raw'. The default 'serial' means a serialised R object,
+#'     for the other modes, the raw vector received will be converted into the
+#'     respective mode. Alternatively, for performance, specify an integer
+#'     position in the vector of choices e.g. 1L for 'serial', 2L for 'character'
+#'     etc.
 #' @param timeout [default NULL] integer value in milliseconds or NULL, which
 #'     applies a socket-specific default, usually the same as no timeout. Note
 #'     that this applies to receiving the request. The total elapsed time would
@@ -183,7 +187,7 @@ reply <- function(context,
 #' # works if req and rep are running in parallel in different processes
 #' reply(ctxp, execute = function(x) x + 1, timeout = 10)
 #' aio <- request(ctxq, data = 2022, timeout = 10)
-#' call_aio(aio)
+#' call_aio(aio)$data
 #'
 #' close(req)
 #' close(rep)

R/opts.R

@@ -22,7 +22,9 @@
 #'
 #' @param object a Socket, Context, Stream, Listener or Dialer.
 #' @param type [default 'bool'] type of option - either 'bool', 'int', 'ms'
-#'     (duration), 'size', 'string' or 'uint64'.
+#'     (duration), 'size', 'string' or 'uint64'. Alternatively, for performance,
+#'     specify an integer position in the vector of choices e.g. 1L for 'bool',
+#'     2L for 'int' etc.
 #' @param opt name of option, e.g. 'reconnect-time-min', as a character string.
 #'     See \link{opts}.
 #' @param value value of option.

R/sendrecv.R

@@ -27,7 +27,8 @@
 #'     For Streams, 'raw' is the only option and this argument is ignored. Use
 #'     'serial' for perfect reproducibility within R, although 'raw' must be used
 #'     when interfacing with external applications that do not understand R
-#'     serialisation.
+#'     serialisation. Alternatively, for performance, specify an integer position
+#'     in the vector of choices i.e. 1L for 'serial' or 2L for 'raw'.
 #' @param block [default NULL] which applies the connection default (see section
 #'     'Blocking' below). Specify logical TRUE to block until successful or FALSE
 #'     to return immediately even if unsuccessful (e.g. if no connection is
@@ -85,6 +86,8 @@ send <- function(con, data, mode = c("serial", "raw"), block = NULL)
 #'     The default 'serial' means a serialised R object, for the other modes,
 #'     the raw vector received will be converted into the respective mode.
 #'     For Streams, 'serial' is not an option and the default is 'character'.
+#'     Alternatively, for performance, specify an integer position in the vector
+#'     of choices e.g. 1L for 'serial', 2L for 'character' etc.
 #' @param keep.raw [default FALSE] logical flag whether to keep and return the
 #'     received raw vector along with the converted data. Supplying a non-logical
 #'     value will error.