remove lock() and unlock()

Author: shikokuchuo

NAMESPACE

@@ -99,7 +99,6 @@ export(subscribe)
 export(survey_time)
 export(tls_config)
 export(transact)
-export(unlock)
 export(unresolved)
 export(unsubscribe)
 export(until)

NEWS.md

@@ -3,6 +3,7 @@
 #### Updates
 
 * `pipe_notify()` drops argument 'cv2' for signalling 2 condition variables on one pipe event. Use signal forwarders `%~>%` instead.
+* The abillity to `lock()` and `unlock()` sockets is removed.
 * Renders it safe to serialize 'nano' and 'aio' objects - they will be inactive when unserialized.
 * Unified Windows build system now compiles 'libmbedtls' and 'libnng' from source even on R <= 4.1 using Rtools40 or earlier.
 

R/nanonext-package.R

@@ -93,3 +93,13 @@
 #' @useDynLib nanonext, .registration = TRUE
 #'
 "_PACKAGE"
+
+
+#' Lock
+#'
+#' Stub function retained for compatibility purposes only.
+#'
+#' @keywords internal
+#' @export
+#'
+lock <- function() {} # may be removed after mirai > 2.1.0 is released

R/sync.R

@@ -213,51 +213,6 @@ cv_signal <- function(cv) invisible(.Call(rnng_cv_signal, cv))
 pipe_notify <- function(socket, cv, add = FALSE, remove = FALSE, flag = FALSE)
   invisible(.Call(rnng_pipe_notify, socket, cv, add, remove, flag))
 
-#' Lock / Unlock a Socket
-#'
-#' Prevents further pipe connections from being established at a Socket. If a
-#' socket is locked, new pipe connections are closed before they can be added to
-#' the socket.
-#'
-#' @param socket a Socket.
-#' @param cv (optional) a \sQuote{conditionVariable}. If supplied, the socket is
-#'   locked only whilst the condition variable is an odd value. This is designed
-#'   to allow an initial connection, as well as subsequent re-connections after
-#'   a connection has ended, if the conditon variable is also registered with
-#'   \code{\link{pipe_notify}} for both add and remove pipe events.
-#'
-#' @return Invisibly, zero on success (will otherwise error).
-#'
-#' @examples
-#' s <- socket("bus", listen = "inproc://nanolock")
-#' s1 <- socket("bus", dial = "inproc://nanolock")
-#' lock(s)
-#' s2 <- socket("bus", dial = "inproc://nanolock")
-#'
-#' send(s, "test")
-#' recv(s1)
-#' recv(s2)
-#'
-#' unlock(s)
-#' s3 <- socket("bus", dial = "inproc://nanolock")
-#' send(s, "test")
-#' recv(s1)
-#' recv(s3)
-#'
-#' close(s)
-#' close(s1)
-#' close(s2)
-#' close(s3)
-#'
-#' @export
-#'
-lock <- function(socket, cv = NULL) invisible(.Call(rnng_socket_lock, socket, cv))
-
-#' @rdname lock
-#' @export
-#'
-unlock <- function(socket) invisible(.Call(rnng_socket_unlock, socket))
-
 #' Signal Forwarder
 #'
 #' Forwards signals from one \sQuote{conditionVariable} to another.

man/lock.Rd

@@ -181,8 +181,6 @@ static const R_CallMethodDef callMethods[] = {
   {"rnng_set_promise_context", (DL_FUNC) &rnng_set_promise_context, 2},
   {"rnng_signal_thread_create", (DL_FUNC) &rnng_signal_thread_create, 2},
   {"rnng_sleep", (DL_FUNC) &rnng_sleep, 1},
-  {"rnng_socket_lock", (DL_FUNC) &rnng_socket_lock, 2},
-  {"rnng_socket_unlock", (DL_FUNC) &rnng_socket_unlock, 1},
   {"rnng_stats_get", (DL_FUNC) &rnng_stats_get, 2},
   {"rnng_status_code", (DL_FUNC) &rnng_status_code, 1},
   {"rnng_stream_close", (DL_FUNC) &rnng_stream_close, 1},

src/init.c

@@ -348,8 +348,6 @@ SEXP rnng_set_opt(SEXP, SEXP, SEXP);
 SEXP rnng_set_promise_context(SEXP, SEXP);
 SEXP rnng_signal_thread_create(SEXP, SEXP);
 SEXP rnng_sleep(SEXP);
-SEXP rnng_socket_lock(SEXP, SEXP);
-SEXP rnng_socket_unlock(SEXP);
 SEXP rnng_stats_get(SEXP, SEXP);
 SEXP rnng_status_code(SEXP);
 SEXP rnng_stream_close(SEXP);

src/nanonext.h

@@ -109,24 +109,6 @@ void pipe_cb_signal(nng_pipe p, nng_pipe_ev ev, void *arg) {
 
 }
 
-static void pipe_cb_dropcon(nng_pipe p, nng_pipe_ev ev, void *arg) {
-
-  if (arg != NULL) {
-    nano_cv *ncv = (nano_cv *) arg;
-    nng_mtx *mtx = ncv->mtx;
-    int cond;
-    nng_mtx_lock(mtx);
-    if ((cond = ncv->condition % 2))
-      ncv->condition--;
-    nng_mtx_unlock(mtx);
-    if (cond)
-      nng_pipe_close(p);
-  } else {
-    nng_pipe_close(p);
-  }
-
-}
-
 static void pipe_cb_monitor(nng_pipe p, nng_pipe_ev ev, void *arg) {
 
   nano_monitor *monitor = (nano_monitor *) arg;
@@ -564,44 +546,6 @@ SEXP rnng_pipe_notify(SEXP socket, SEXP cv, SEXP add, SEXP remove, SEXP flag) {
 
 }
 
-SEXP rnng_socket_lock(SEXP socket, SEXP cv) {
-
-  if (NANO_PTR_CHECK(socket, nano_SocketSymbol))
-    Rf_error("'socket' is not a valid Socket");
-  nng_socket *sock = (nng_socket *) NANO_PTR(socket);
-
-  int xc;
-  if (cv != R_NilValue) {
-    if (NANO_PTR_CHECK(cv, nano_CvSymbol))
-      Rf_error("'cv' is not a valid Condition Variable");
-    nano_cv *ncv = (nano_cv *) NANO_PTR(cv);
-    xc = nng_pipe_notify(*sock, NNG_PIPE_EV_ADD_PRE, pipe_cb_dropcon, ncv);
-  } else {
-    xc = nng_pipe_notify(*sock, NNG_PIPE_EV_ADD_PRE, pipe_cb_dropcon, NULL);
-  }
-
-  if (xc)
-    ERROR_OUT(xc);
-
-  return nano_success;
-
-}
-
-SEXP rnng_socket_unlock(SEXP socket) {
-
-  if (NANO_PTR_CHECK(socket, nano_SocketSymbol))
-    Rf_error("'socket' is not a valid Socket");
-
-  nng_socket *sock = (nng_socket *) NANO_PTR(socket);
-
-  const int xc = nng_pipe_notify(*sock, NNG_PIPE_EV_ADD_PRE, NULL, NULL);
-  if (xc)
-    ERROR_OUT(xc);
-
-  return nano_success;
-
-}
-
 // monitors --------------------------------------------------------------------
 
 SEXP rnng_monitor_create(SEXP socket, SEXP cv) {

src/sync.c

@@ -514,28 +514,6 @@ is_nano(s) && {
   test_type("integer", close(s))
 }
 
-test_class("nano", s <- socket("bus", listen = "inproc://nanolock"))
-test_class("nano", s1 <- socket("bus", dial = "inproc://nanolock"))
-test_zero(lock(s))
-test_class("nano", s2 <- socket("bus", dial = "inproc://nanolock"))
-test_class("sendAio", send_aio(s, "test"))
-test_notnull(recv(s1, block = 500))
-test_class("errorValue", recv(s2))
-test_zero(unlock(s))
-test_zero(pipe_notify(s, cv = cv, add = TRUE, remove = TRUE))
-test_zero(lock(s, cv = cv))
-test_class("nano", s3 <- socket("bus", dial = "inproc://nanolock"))
-test_zero(send(s, "test", block = 500))
-test_notnull(recv(s3, block = 500))
-test_error(unlock(cv), "valid Socket")
-test_error(lock(cv), "valid Socket")
-test_error(lock(s, cv = s), "valid Condition Variable")
-test_zero(pipe_notify(s, cv = NULL, add = TRUE, remove = TRUE))
-test_zero(close(s))
-test_zero(close(s1))
-test_zero(close(s2))
-test_zero(close(s3))
-
 test_equal(nanonext:::.DollarNames.ncurlAio(NULL, "sta"), "status")
 test_equal(nanonext:::.DollarNames.recvAio(NULL, "dat"), "data")
 test_equal(nanonext:::.DollarNames.sendAio(NULL, "r"), "result")