diff options
| author | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-12-20 01:54:45 +0300 |
|---|---|---|
| committer | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-12-20 01:54:45 +0300 |
| commit | 7a53850f9bf266d4427bd505b86729e02f266e0a (patch) | |
| tree | 7f766163c94998083af8c372a5b2ccebeda50409 /doc | |
| parent | node.scm (node-run-server): Use a remote pipe (diff) | |
| download | guile-ssh-7a53850f9bf266d4427bd505b86729e02f266e0a.tar.gz | |
node.scm: Allow to stop a RREPL server
* modules/ssh/dist/node.scm (make-node): Add 'stop-repl-server?' keyed option.
(node-stop-server): New procedure.
(node-eval): Stop a REPL server after evaluation is done, if it is
explicitly requested.
* doc/api-dist.texi: Update description of 'make-node', add description of
'node-stop-server'.
* NEWS: Update.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api-dist.texi | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/api-dist.texi b/doc/api-dist.texi index c6dcc8f..6561c26 100644 --- a/doc/api-dist.texi +++ b/doc/api-dist.texi @@ -23,13 +23,19 @@ instead of @code{#<unspecified>}. Node management procedures: -@deffn {Scheme Procedure} make-node session [repl-port=37146] [#:start-repl-server?=#t] +@deffn {Scheme Procedure} make-node session [repl-port=37146] [#:start-repl-server?=#t] [#:stop-repl-server?=#f] Make a new node that uses an SSH @var{session} to connect to a @var{repl-port} number on the remote side. Return a new node. If @var{start-repl-server?} is set to @code{#t} (which is by default) then start a REPL server on a remote host automatically in case when it is not started yet. + +If @var{stop-repl-server?} is set to #t then a REPL server will be stopped as +soon as an evaluation is done. Alternatively you could use +@code{node-stop-server} procedure from @code{(ssh dist node)} to stop the +server when it is not needed anymore. + @end deffn @deffn {Scheme Procedure} node? x @@ -161,6 +167,10 @@ Open a remote REPL (RREPL). Return a new RREPL channel. Run a REPL server on a @var{node}. @end deffn +@deffn {Scheme Procedure} node-stop-server node +Stop a RREPL server on a @var{node}. +@end deffn + @deffn {Scheme Procedure} node-guile-version node Get Guile version installed on a @var{node}, return the version string. Return @code{#f} if Guile is not installed. |
