Update R interface for newly-added functions

Author: shikokuchuo

NAMESPACE

@@ -53,22 +53,22 @@ S3method(unsubscribe,nanoSocket)
 export(.mirai_scm)
 export(call_aio)
 export(context)
+export(device)
 export(dial)
 export(is_aio)
 export(is_error_value)
 export(is_nano)
 export(is_nul_byte)
 export(listen)
+export(mclock)
 export(messenger)
+export(msleep)
 export(nano)
 export(nano_init)
 export(ncurl)
-export(nng_clock)
-export(nng_device)
 export(nng_error)
-export(nng_random)
-export(nng_sleep)
 export(nng_version)
+export(random)
 export(recv)
 export(recv_aio)
 export(reply)

NEWS.md

@@ -2,9 +2,9 @@
 
 #### New Features
 
-* Adds `nng_clock()`, `nng_sleep()` and `nng_random()` utilities exposing the library functions for timing and cryptographic RNG respectively.
-* `socket()` gains the ability to open 'raw' mode sockets. Please note: this is not for general use - do not set this argument unless you have a specific need, such as for use with `nng_device()` (refer to NNG documentation).
-* Implements `nng_device()` which creates a socket forwarder or proxy. Warning: use this in a separate process as this function blocks with no ability to interrupt.
+* Adds `mclock()`, `msleep()` and `random()` utilities exposing the library functions for timing and cryptographic RNG respectively.
+* `socket()` gains the ability to open 'raw' mode sockets. Please note: this is not for general use - do not set this argument unless you have a specific need, such as for use with `device()` (refer to NNG documentation).
+* Implements `device()` which creates a socket forwarder or proxy. Warning: use this in a separate process as this function blocks with no ability to interrupt.
 
 # nanonext 0.5.1
 

R/socket.R

@@ -36,7 +36,7 @@
 #'     it is not generally possible to change these once started.
 #' @param raw [default FALSE] whether to open raw mode sockets. Note: not for
 #'     general use - do not enable unless you have a specific need, such as for
-#'     use with \code{\link{nng_device}} (refer to NNG documentation).
+#'     use with \code{\link{device}} (refer to NNG documentation).
 #'
 #' @return A Socket (object of class 'nanoSocket' and 'nano').
 #'

R/utils.R

@@ -93,7 +93,7 @@ nng_version <- function() .Call(rnng_version)
 #'
 nng_error <- function(xc) .Call(rnng_strerror, xc)
 
-#' NNG Clock Utility
+#' 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
@@ -107,17 +107,17 @@ nng_error <- function(xc) .Call(rnng_strerror, xc)
 #' @return A double.
 #'
 #' @examples
-#' time <- nng_clock(); nng_sleep(100); nng_clock() - time
+#' time <- mclock(); msleep(100); mclock() - time
 #'
 #' @export
 #'
-nng_clock <- function() {
+mclock <- function() {
 
   .Call(rnng_clock)
 
 }
 
-#' NNG Sleep Utility
+#' Sleep Utility
 #'
 #' Sleep function. May block for longer than requested, with the actual wait
 #'     time determined by the capabilities of the underlying system.
@@ -127,11 +127,11 @@ nng_clock <- function() {
 #' @return Invisible NULL.
 #'
 #' @examples
-#' time <- nng_clock(); nng_sleep(100); nng_clock() - time
+#' time <- mclock(); msleep(100); mclock() - time
 #'
 #' @export
 #'
-nng_sleep <- function(msec) {
+msleep <- function(msec) {
 
   invisible(.Call(rnng_sleep, msec))
 
@@ -148,25 +148,26 @@ nng_sleep <- function(msec) {
 #' @return A (positive) double.
 #'
 #' @examples
-#' nng_random()
+#' random()
 #'
 #' @export
 #'
-nng_random <- function() {
+random <- function() {
 
   .Call(rnng_random)
 
 }
 
-#' Create NNG Device
+#' Create Device
 #'
 #' Creates a device which is a socket forwarder or proxy. Provides for improved
 #'     horizontal scalability, reliability, and isolation.
 #'
 #' @param s1 a raw mode Socket.
 #' @param s2 a raw mode Socket.
 #'
-#' @return This function does not return.
+#' @return Invisibly, an integer exit code. If the device was successfully
+#'     created, this function does not return.
 #'
 #' @details Only raw mode sockets may be used with this function. Sockets s1 and
 #'     s2 must be compatible with each other, i.e. be opposite halves of a two
@@ -180,7 +181,7 @@ nng_random <- function() {
 #'
 #' @export
 #'
-nng_device <- function(s1, s2) {
+device <- function(s1, s2) {
 
   invisible(.Call(rnng_device, s1, s2))
 

man/nng_device.Rd renamed to man/device.Rd

@@ -624,8 +624,7 @@ SEXP rnng_device(SEXP s1, SEXP s2) {
                       *(nng_socket *) R_ExternalPtrAddr(s2));
   if (xc)
     return mk_error(xc);
-
-  return Rf_ScalarInteger(0);
+  return Rf_ScalarInteger(xc);
 
 }