CRAN release 0.7.1

Author: shikokuchuo

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: nanonext
 Type: Package
 Title: NNG (Nanomsg Next Gen) Lightweight Messaging Library
-Version: 0.7.0.9000
+Version: 0.7.1
 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.
@@ -25,4 +25,4 @@ SystemRequirements: 'libnng' >= 1.6.0 and 'libmbedtls' >= 2, or 'cmake' to
     compile NNG and/or Mbed TLS included in package sources
 Depends: 
     R (>= 2.5)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.2

NEWS.md

@@ -1,20 +1,18 @@
-# nanonext 0.7.0.9000 (development)
+# nanonext 0.7.1
 
 #### New Features
 
-* Implements `getopt()`, which is the counterpart to `setopt()` for retrieving options set on objects.
-* The `setopt()` interface is simplified, with the type now inferred from the value supplied.
+* Implements `getopt()`, the counterpart to `setopt()` for retrieving the value of options on objects.
 
 #### Updates
 
-* `ncurl()` changes to return redirect addresses as the response header 'Location'. This is so any additional information provided can now be available at `$data`.
+* The `setopt()` interface is simplified, with the type now inferred from the value supplied.
+* `ncurl()` now returns redirect addresses as the response header 'Location'. This is so that HTTP data can also be returned at `$data` where this is provided.
 * Eliminates CRAN 'additional issue' (clang/gcc-UBSAN).
 * Internal performance optimisations.
 
 # nanonext 0.7.0
 
-*nanonext 0.7 implements API optimisations after recent enhancements; the API is again intended to remain stable after these changes*
-
 #### New Features
 
 * `status_code()` utility returns a translation of HTTP response status codes.
@@ -37,7 +35,7 @@
 
 *Other changes:*
 
-* Integer `send()`/`recv()` arguments for 'mode' and `setopt()` arguments for 'type' 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.
+* Integer `send()`/`recv()` arguments for 'mode' 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()`.
@@ -49,8 +47,6 @@
 
 # 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.
@@ -134,8 +130,6 @@
 
 # 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/aio.R

@@ -129,7 +129,7 @@ recv_aio <- function(con,
 #' Retrieve the value of an asynchronous Aio operation, waiting for the
 #'     operation to complete if still in progress.
 #'
-#' @param aio An Aio (object of class 'sendAio' or 'recvAio').
+#' @param aio an Aio (object of class 'sendAio' or 'recvAio').
 #'
 #' @return The passed object (invisibly).
 #'
@@ -188,7 +188,7 @@ call_aio <- function(aio) invisible(.Call(rnng_aio_call, aio))
 #'
 #' Stop an asynchronous Aio operation.
 #'
-#' @param aio An Aio (object of class 'sendAio' or 'recvAio').
+#' @inheritParams call_aio
 #'
 #' @return Invisible NULL.
 #'
@@ -209,13 +209,14 @@ stop_aio <- function(aio) invisible(.Call(rnng_aio_stop, aio))
 #' Query whether an Aio or Aio value remains unresolved. Unlike
 #'     \code{\link{call_aio}}, this function does not wait for completion.
 #'
-#' @param aio An Aio (object of class 'sendAio' or 'recvAio'), or Aio value
+#' @param aio an Aio (object of class 'sendAio' or 'recvAio'), or Aio value
 #'     stored in \code{$result}, \code{$raw} or \code{$data} as the case may be.
 #'
-#' @return Logical TRUE or FALSE.
+#' @return Logical TRUE if 'aio' is an unresolved Aio or Aio value, or FALSE
+#'     otherwise.
 #'
-#' @details Returns TRUE for unresolved Aios or Aio values, FALSE otherwise.
-#'     Suitable for use in control flow statements such as \code{while} or \code{if}.
+#' @details Suitable for use in control flow statements such as \code{while} or
+#'     \code{if}.
 #'
 #'     Note: querying resolution may cause a previously unresolved Aio to resolve.
 #'

R/opts.R

@@ -23,7 +23,9 @@
 #' @param object a Socket, Context, Stream, Listener or Dialer.
 #' @param opt name of option, e.g. 'reconnect-time-min', as a character string.
 #'     See \link{opts}.
-#' @param value value of option.
+#' @param value value of option. Supply character type for 'string' options,
+#'     integer or double for 'int', 'duration', 'size' and 'uint64', and logical
+#'     for 'bool'.
 #'
 #' @return Invisibly, an integer exit code (zero on success).
 #'
@@ -68,7 +70,7 @@ setopt <- function(object, opt, value)
 #' @inheritParams setopt
 #'
 #' @return The value of the option (logical for type 'bool', integer for 'int',
-#'     'ms' and 'size', character for 'string' and double for 'uint64').
+#'     'duration' and 'size', character for 'string' and double for 'uint64').
 #'
 #' @details To get options for a Listener or Dialer attached to a Socket or nano
 #'     object, pass in the objects directly via for example \code{$listener[[1]]}

R/utils.R

@@ -50,8 +50,8 @@ nng_error <- function(xc) .Call(rnng_strerror, xc)
 #' Clock Utility
 #'
 #' Provides the number of elapsed milliseconds since an arbitrary reference time
-#'     in the past. The reference time will be the same for a given program, but
-#'     may differ between programs.
+#'     in the past. The reference time will be the same for a given session, but
+#'     may differ between sessions.
 #'
 #' @details A convenience function for building concurrent applications. The
 #'     resolution of the clock depends on the underlying system timing facilities