Backup. Test later.

Author: snoweye

NAMESPACE

@@ -13,6 +13,9 @@ export(kill_cs)
 export(kill_rr)
 export(machine)
 export(plink)
+export(rpc)
+export(rpc_kill)
+export(rpc_ps)
 export(rpcopt_get)
 export(rpcopt_set)
 export(run_args)

R/rpc.r

@@ -32,6 +32,7 @@
 #'          \code{\link{srpc}()},
 #'          \code{\link{ssh}()}, and \code{\link{plink}()}.
 #'
+#' @export
 rpc <- function(machine, cmd = "whoami", intern = .pbd_env$RPC.CT$intern,
   wait = .pbd_env$RPC.CT$wait)
 {

R/rpc_cs_example.r

@@ -47,25 +47,26 @@
 #' @examples
 #' \dontrun{
 #' library(pbdRPC, quietly = TRUE)
-#' rpcopt_set(user = "snoweye", hostname = "192.168.56.101")
+#' # rpcopt_set(user = "snoweye", hostname = "192.168.56.101")
+#' m <- machine(user = "snoweye", hostname = "192.168.56.101")
 #'
-#' check_cs()    # pid 2857 (may differ)
-#' kill_cs()     # all pbdCS pids are killed
-#' check_cs()    # make sure no pbdCS R cluster is running
+#' check_cs(m)    # pid 2857 (may differ)
+#' kill_cs(m)     # all pbdCS pids are killed
+#' check_cs(m)    # make sure no pbdCS R cluster is running
 #'
 #' ### use "; " to bypass multiple commands
 #' preload <- "source ~/work-my/00_set_devel_R; "
 #'
 #' ### start a new pbdCS R cluster
-#' start_cs(preload = preload)
-#' check_cs()
-#' kill_cs()
+#' start_cs(m, preload = preload)
+#' check_cs(m)
+#' kill_cs(m)
 #'
 #' ### Example: for module load on supercomputers
 #' preload <- "module load r; "    # e.g. via module load r
-#' start_cs(preload = preload)
-#' check_cs()
-#' kill_cs()
+#' start_cs(m, preload = preload)
+#' check_cs(m)
+#' kill_cs(m)
 #' }
 #'
 #' 

R/rpc_pid.r

@@ -0,0 +1,51 @@
+#' Search or Kill pid of Remote Procedure Call
+#'
+#' Search or kill possible pid's that running remote procedure calls
+#' in background.
+#'
+#' @param pid
+#' a vector containing proccess id's in interger.
+#'
+#' @details
+#' \code{rpc_ps()} prints possible pid's that running remote procedure
+#' calls in background via one of
+#' \code{ssh}, \code{plink}, \code{plink.exe}, or \code{cmd.exe}.
+#'
+#' \code{rpc_kill()} kill pid's.
+#'
+#' @return
+#' List or kill all possible pid's.
+#'
+#' @rdname rpc_pid
+#' @name rpc_pid
+NULL
+
+
+#' @rdname rpc_pid
+#' @export
+rpc_ps <- function()
+{
+  if (.Platform$OS.type == "windows")
+  {
+    pid <- system('Tasklist /FI "IMAGENAME eq plink.exe"', intern = TRUE)
+    cat(pid, sep = "\n")
+    pid <- system('Tasklist /FI "IMAGENAME eq cmd.exe"', intern = TRUE)
+    cat(pid, sep = "\n")
+  }
+  else
+  {
+    pid <- system("/bin/ps uxww", intern = TRUE)
+    pid <- grep("(ssh|plink) ", pid, value = TRUE)
+    cat(pid, sep = "\n")
+  }
+
+  return(invisible())
+}
+
+
+#' @rdname rpc_pid
+#' @export
+rpc_kill <- function(pid)
+{
+  tools::pskill(pid)
+}

R/rpc_rr_example.r

@@ -46,25 +46,26 @@
 #' @examples
 #' \dontrun{
 #' library(pbdRPC, quietly = TRUE)
-#' rpcopt_set(user = "snoweye", hostname = "192.168.56.101")
+#' # rpcopt_set(user = "snoweye", hostname = "192.168.56.101")
+#' m <- machine(user = "snoweye", hostname = "192.168.56.101")
 #'
-#' check_rr()    # pid 2857 (may differ)
-#' kill_rr()     # all remoter pids are killed
-#' check_rr()    # make sure no remoter servers are running
+#' check_rr(m)    # pid 2857 (may differ)
+#' kill_rr(m)     # all remoter pids are killed
+#' check_rr(m)    # make sure no remoter servers are running
 #'
 #' ### use "; " to bypass multiple commands
 #' preload <- "source ~/work-my/00_set_devel_R; "
 #'
 #' ### start a new remoter server
-#' start_rr(preload = preload)
-#' check_rr()
-#' kill_rr()
+#' start_rr(m, preload = preload)
+#' check_rr(m)
+#' kill_rr(m)
 #'
 #' ### Example: for module load on supercomputers
 #' preload <- "module load r; "    # e.g. via module load r
-#' start_rr(preload = preload)
-#' check_rr()
-#' kill_rr()
+#' start_rr(m, preload = preload)
+#' check_rr(m)
+#' kill_rr(m)
 #' }
 #'
 #' 

R/srpc.r

@@ -51,15 +51,15 @@
 #' rpcopt_set(user = "snoweye", hostname = "192.168.56.101")
 #'
 #' ### see start_rr(), check_rr(), and kill_rr() for more examples.
-#' rpc()
-#' rpc("ls")
-#' rpc("ls ~/work-my")
-#' rpc("cat ~/work-my/00_set_devel_R")
+#' srpc()
+#' srpc("ls")
+#' srpc("ls ~/work-my")
+#' srpc("cat ~/work-my/00_set_devel_R")
 #'
 #' ### see ssh(), plink(), and run_args() for lower level examples.
 #'
 #' ### Local port forwarding
-#' rpc(args = "-N -T -L 55555:localhost:55555")
+#' srpc(args = "-N -T -L 55555:localhost:55555")
 #' start_rr()
 #'
 #' library(remoter)

R/ssh_plink.r

@@ -153,6 +153,12 @@ run_args <- function(exec = "ssh", args = "",
         cat(cmd, file = cmd.fn, sep = "\n")
 
       ret <- shell.exec(cmd.fn)
+
+      pid <- system('Tasklist /FI "IMAGENAME eq plink.exe"', intern = TRUE)
+      cat(pid, sep = "\n")
+      pid <- system('Tasklist /FI "IMAGENAME eq cmd.exe"', intern = TRUE)
+      cat(pid, sep = "\n")
+
       return(invisible(ret))
     }
     else

inst/doc/pbdRPC-guide.Rnw

@@ -90,6 +90,7 @@ Silver Spring, MD, USA \\
 
 \input{./pbdRPC-include/02-introduction}
 \input{./pbdRPC-include/03-login_information}
+\input{./pbdRPC-include/08-machine_information}
 \input{./pbdRPC-include/04-application_rr}
 \input{./pbdRPC-include/05-application_cs}
 \input{./pbdRPC-include/06-port_forwarding}

inst/doc/pbdRPC-guide.pdf

@@ -90,6 +90,7 @@ Silver Spring, MD, USA \\
 
 \input{./pbdRPC-include/02-introduction}
 \input{./pbdRPC-include/03-login_information}
+\input{./pbdRPC-include/08-machine_information}
 \input{./pbdRPC-include/04-application_rr}
 \input{./pbdRPC-include/05-application_cs}
 \input{./pbdRPC-include/06-port_forwarding}

man/rpc_cs_example.Rd

@@ -102,7 +102,7 @@
 For Windows system, one may use \code{plink.exe} instead of \code{ssh}
 from a terminal \code{cmd.exe}. See Section~\ref{sec:basic_plink} for details.
 
-Within \proglang{R}, the next example will have the
+Within \proglang{R}, the example below will have the
 same results as the above shell command.
 \begin{Code}[title=Basic \code{srpc()} in \pkg{pbdRPC} and \proglang{R}]
 > library(pbdRPC, quietly = TRUE)
@@ -122,7 +122,7 @@
 detects the system first, then calls the corresponding function.
 Currently, no external \code{plink.exe} or \code{plink} is implemented
 even though it is possible.
-The details of \code{ssh()} and \code{plink()} are given in next.
+The details of \code{ssh()} and \code{plink()} are given in examples below.
 
 
 \subsection[Basic \code{ssh()}]{Basic \code{ssh()}}
@@ -141,7 +141,7 @@
 Note that multiple commands can be automatically given at once
 as shell commands under an shell prompt, such as ``\code{;}'', ``\code{\&\&}'',
 ``\code{>}'', ``\code{<}'', ``\code{|}'' or ``\code{\&}'' etc.
-For example, the next will tell current id, date/time, and files.
+For example, the code below will tell current id, date/time, and files.
 \begin{Command}[title=Multiple commands to \code{ssh} in shell]
 $ ssh snoweye@192.168.56.101 'whoami;date;ls -a'
 \end{Command}
@@ -158,7 +158,8 @@
 \label{sec:basic_plink}
 \addcontentsline{toc}{subsection}{\thesubsection. Basic \code{plink.exe}\  and \code{plink()}}
 
-In Windows system and inside the \code{cmd.exe}, one may similarly use next
+In Windows system and inside the \code{cmd.exe}, one may similarly use
+the code below
 \begin{Command}[title=Basic \code{plink.exe} in \code{cmd.exe}]
 C:\> plink.exe snoweye@192.168.56.101 'whoami'
 \end{Command}
@@ -177,7 +178,7 @@
 command \code{whoami} because the password input is not allowed inside
 \code{RGui}.
 When the authentication file (\code{id_rsa.ppk}) is available,
-one may want to disable the opening \code{cmd.exe} as in next.
+one may want to disable the opening \code{cmd.exe} below.
 \begin{Code}[title=Advance \code{plink()} in \pkg{pbdRPC} and \proglang{R}]
 > .pbd_env$RPC.CT$use.shell.exec <- FALSE
 > ret <- plink("snoweye@192.168.56.101 'whoami'")

man/rpc_pid.Rd

@@ -12,13 +12,13 @@
 respectively.
 Suppose further the login id is called ``snoweye'', then one may use
 the function \code{rpcopt_set()} to assign/overwrite the login information to
-\code{.pbd_env$RPC.LI} as in next.
+\code{.pbd_env$RPC.LI} below.
 \begin{Code}[title=Set login information]
 > ### Alter login information as needed
-> rpcopt_set(user = "snoweye", hostname = "192.168.56.101", pport = "22")
+> rpcopt_set(user = "snoweye", hostname = "192.168.56.101", pport = 22)
 \end{Code}
 
-In next, the basic login information \code{RPC.LI} describes that
+The basic login information \code{RPC.LI} below describes that
 \code{srpc()} will
 \begin{itemize}
 \item use \code{ssh} (exec.type) to execute a command
@@ -39,7 +39,7 @@
 [1] ""
 
 $pport
-[1] "22"
+[1] 22
 
 $user
 [1] "snoweye"