Export stopAllServers and update docs

rstudio · Dec 18, 2017 · 01c966e · 01c966e
1 parent 2894f2a
commit 01c966e
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 18 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -12,6 +12,7 @@ export(service)
 export(startDaemonizedServer)
 export(startPipeServer)
 export(startServer)
+export(stopAllServers)
 export(stopDaemonizedServer)
 export(stopServer)
 exportClasses(WebSocket)

diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -17,21 +17,30 @@ makePipeServer <- function(name, mask, onHeaders, onBodyData, onRequest, onWSOpe
     .Call('_httpuv_makePipeServer', PACKAGE = 'httpuv', name, mask, onHeaders, onBodyData, onRequest, onWSOpen, onWSMessage, onWSClose)
 }
 
-#' Stop a running server
+#' Stop a server
 #' 
 #' Given a handle that was returned from a previous invocation of 
-#' \code{\link{startServer}}, closes all open connections for that server and 
-#' unbinds the port. \strong{Be careful not to call \code{stopServer} more than 
-#' once on a handle, as this will cause the R process to crash!}
+#' \code{\link{startServer}} or \code{\link{startPipeServer}}, this closes all
+#' open connections for that server and  unbinds the port.
 #' 
 #' @param handle A handle that was previously returned from
-#'   \code{\link{startServer}}.
-#'   
+#'   \code{\link{startServer}} or \code{\link{startPipeServer}}.
+#'
+#' @seealso \code{\link{stopAllServers}} to stop all servers.
+#'
 #' @export
 stopServer <- function(handle) {
     invisible(.Call('_httpuv_stopServer', PACKAGE = 'httpuv', handle))
 }
 
+#' Stop all applications
+#'
+#' This will stop all applications which were created by
+#' \code{\link{startServer}} or \code{\link{startPipeServer}}.
+#'
+#' @seealso \code{\link{stopServer}} to stop a specific server.
+#'
+#' @export
 stopAllServers <- function() {
     invisible(.Call('_httpuv_stopAllServers', PACKAGE = 'httpuv'))
 }

diff --git a/man/stopAllServers.Rd b/man/stopAllServers.Rd
diff --git a/man/stopDaemonizedServer.Rd b/man/stopDaemonizedServer.Rd
diff --git a/man/stopServer.Rd b/man/stopServer.Rd
diff --git a/src/httpuv.cpp b/src/httpuv.cpp
@@ -287,16 +287,17 @@ void stopServer(uv_stream_t* pServer) {
   );
 }
 
-//' Stop a running server
+//' Stop a server
 //' 
 //' Given a handle that was returned from a previous invocation of 
-//' \code{\link{startServer}}, closes all open connections for that server and 
-//' unbinds the port. \strong{Be careful not to call \code{stopServer} more than 
-//' once on a handle, as this will cause the R process to crash!}
+//' \code{\link{startServer}} or \code{\link{startPipeServer}}, this closes all
+//' open connections for that server and  unbinds the port.
 //' 
 //' @param handle A handle that was previously returned from
-//'   \code{\link{startServer}}.
-//'   
+//'   \code{\link{startServer}} or \code{\link{startPipeServer}}.
+//'
+//' @seealso \code{\link{stopAllServers}} to stop all servers.
+//'
 //' @export
 // [[Rcpp::export]]
 void stopServer(std::string handle) {
@@ -305,6 +306,14 @@ void stopServer(std::string handle) {
   stopServer(pServer);
 }
 
+//' Stop all applications
+//'
+//' This will stop all applications which were created by
+//' \code{\link{startServer}} or \code{\link{startPipeServer}}.
+//'
+//' @seealso \code{\link{stopServer}} to stop a specific server.
+//'
+//' @export
 // [[Rcpp::export]]
 void stopAllServers() {
   ASSERT_MAIN_THREAD()