summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArtyom V. Poptsov <poptsov.artyom@gmail.com>2016-11-24 22:47:44 +0300
committerArtyom V. Poptsov <poptsov.artyom@gmail.com>2016-11-26 00:39:34 +0300
commitbd1d4ea6365ee428ac931bc6a40c51ffab80561a (patch)
treef667b18b7ec599a0d87f89e49fab0034030c6f65
parentkey.scm (get-key-type, get-public-key-hash): Deprecate (diff)
downloadguile-ssh-bd1d4ea6365ee428ac931bc6a40c51ffab80561a.tar.gz
channel.scm (channel-get-stream, channel-get-session): Deprecate
* modules/ssh/channel.scm (channel-get-stream, channel-get-session): Deprecate. (channel-session, channel-stream): New procedures. * libguile-ssh/channel-func.c (guile_ssh_channel_get_stream): Rename to 'gssh_channel_stream'. (guile_ssh_channel_get_session): Rename to 'gssh_channel_session'. * doc/api-channels.texi, NEWS: Update.
-rw-r--r--NEWS4
-rw-r--r--doc/api-channels.texi4
-rw-r--r--libguile-ssh/channel-func.c22
-rw-r--r--modules/ssh/channel.scm30
4 files changed, 38 insertions, 22 deletions
diff --git a/NEWS b/NEWS
index c471768..1d0abef 100644
--- a/NEWS
+++ b/NEWS
@@ -8,10 +8,12 @@ Copyright (C) Artyom V. Poptsov <poptsov.artyom@gmail.com>
notice and this notice are preserved.
* Unreleased
-** Deprecation
*** In (ssh key)
- 'get-key-type' (use 'key-type' instead)
- 'get-public-key-hash' (use 'public-key-hash' instead)
+*** In (ssh channel)
+ - 'channel-get-stream (use 'channel-stream' instead)
+ - 'channel-get-session' (use 'channel-session' instead)
* Changes in version 0.10.2 (2016-11-25)
** New procedures
diff --git a/doc/api-channels.texi b/doc/api-channels.texi
index 97f1e49..c3666fe 100644
--- a/doc/api-channels.texi
+++ b/doc/api-channels.texi
@@ -114,7 +114,7 @@ Example:
@end lisp
@end deffn
-@deffn {Scheme Procedure} channel-get-stream channel
+@deffn {Scheme Procedure} channel-stream channel
Get current stream name from @var{channel}. The @var{channel} must be open.
Throw @code{guile-ssh-error} on error. Return one of the following symbols:
@code{stdout}, @code{stderr}.
@@ -127,7 +127,7 @@ Example:
@end lisp
@end deffn
-@deffn {Scheme Procedure} channel-get-session channel
+@deffn {Scheme Procedure} channel-session channel
Get the session to which belongs the @var{channel}. Throw
@code{guile-ssh-error} on an error. Return the session.
@end deffn
diff --git a/libguile-ssh/channel-func.c b/libguile-ssh/channel-func.c
index f1e3695..319f97a 100644
--- a/libguile-ssh/channel-func.c
+++ b/libguile-ssh/channel-func.c
@@ -425,14 +425,9 @@ Return value is undefined.\
}
#undef FUNC_NAME
-SCM_DEFINE (guile_ssh_channel_get_stream,
- "channel-get-stream", 1, 0, 0,
- (SCM channel),
- "\
-Get current stream name from CHANNEL. Throw `guile-ssh-error' on error.\n\
-Return one of the following symbols: \"stdout\", \"stderr\".\
-")
-#define FUNC_NAME s_guile_ssh_channel_get_stream
+SCM_GSSH_DEFINE (gssh_channel_stream, "%gssh-channel-stream", 1,
+ (SCM channel))
+#define FUNC_NAME s_gssh_channel_stream
{
struct channel_data *cd = _scm_to_channel_data (channel);
@@ -450,14 +445,9 @@ Return one of the following symbols: \"stdout\", \"stderr\".\
}
#undef FUNC_NAME
-SCM_DEFINE (guile_ssh_channel_get_session,
- "channel-get-session", 1, 0, 0,
- (SCM channel),
- "\
-Get the session to which belongs the CHANNEL. Throw `guile-ssh-error' on an \n\
-error. Return the session.\
-")
-#define FUNC_NAME s_guile_ssh_channel_get_session
+SCM_GSSH_DEFINE (gssh_channel_session, "%gssh-channel-session", 1,
+ (SCM channel))
+#define FUNC_NAME s_gssh_channel_session
{
struct channel_data *cd = _scm_to_channel_data (channel);
GSSH_VALIDATE_CHANNEL_DATA (cd, channel, FUNC_NAME);
diff --git a/modules/ssh/channel.scm b/modules/ssh/channel.scm
index ec29238..5660978 100644
--- a/modules/ssh/channel.scm
+++ b/modules/ssh/channel.scm
@@ -37,7 +37,8 @@
;; channel-cancel-forward
;; channel-set-pty-size!
;; channel-set-stream!
-;; channel-get-stream
+;; channel-stream
+;; channel-session
;; channel-open?
;; channel-send-eof
;; channel-eof?
@@ -63,8 +64,10 @@
channel-request-send-exit-status
channel-set-pty-size!
channel-set-stream!
- channel-get-stream
- channel-get-session
+ channel-stream
+ channel-get-stream ; deprecated
+ channel-session
+ channel-get-session ; deprecated
channel-get-exit-status
channel-open?
channel-send-eof
@@ -82,6 +85,27 @@
(throw 'guile-ssh-error "Wrong mode" mode))))
+(define (channel-session channel)
+ "Get the session to which belongs the CHANNEL. Throw 'guile-ssh-error' on
+an error. Return the session."
+ (%gssh-channel-session channel))
+
+(define (channel-get-session channel)
+ (issue-deprecation-warning "'channel-get-session' is deprecated. "
+ "Use 'channel-session' instead.")
+ (%gssh-channel-session channel))
+
+(define (channel-stream channel)
+ "Get current stream name from a CHANNEL. Throw 'guile-ssh-error' on error.
+Return one of the following symbols: stdout, stderr."
+ (%gssh-channel-stream channel))
+
+(define (channel-get-stream channel)
+ (issue-deprecation-warning "'channel-get-stream' is deprecated. "
+ "Use 'channel-stream' instead.")
+ (%gssh-channel-stream channel))
+
+
(define* (channel-open-forward channel
#:key (source-host "localhost") local-port
remote-host (remote-port local-port))