aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Simons <jon@jonsimons.org>2014-01-28 20:42:59 -0800
committerAndreas Schneider <asn@cryptomilk.org>2014-02-02 22:21:07 +0100
commitf29f10876a3801a83af064f14f250c1a8d9c08a0 (patch)
tree47df6867932335e03b4353ef3028a9adec2f23cf
parent45d28c76829c96ff23d328c8420e936cf0ef1e72 (diff)
downloadlibssh-f29f10876a3801a83af064f14f250c1a8d9c08a0.tar.gz
libssh-f29f10876a3801a83af064f14f250c1a8d9c08a0.tar.xz
libssh-f29f10876a3801a83af064f14f250c1a8d9c08a0.zip
doc: correct ssh_channel_read_timeout units
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
-rw-r--r--include/libssh/libssh.h2
-rw-r--r--src/channels.c12
2 files changed, 7 insertions, 7 deletions
diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h
index 31bcc869..b3f6ae4b 100644
--- a/include/libssh/libssh.h
+++ b/include/libssh/libssh.h
@@ -377,7 +377,7 @@ LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr,
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr);
LIBSSH_API int ssh_channel_poll_timeout(ssh_channel channel, int timeout, int is_stderr);
LIBSSH_API int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr);
-LIBSSH_API int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout);
+LIBSSH_API int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout_ms);
LIBSSH_API int ssh_channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count,
int is_stderr);
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value);
diff --git a/src/channels.c b/src/channels.c
index 9327616d..51e96fe7 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -2720,16 +2720,16 @@ int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_std
/**
* @brief Reads data from a channel.
*
- * @param[in] channel The channel to read from.
+ * @param[in] channel The channel to read from.
*
- * @param[in] dest The destination buffer which will get the data.
+ * @param[in] dest The destination buffer which will get the data.
*
- * @param[in] count The count of bytes to be read.
+ * @param[in] count The count of bytes to be read.
*
- * @param[in] is_stderr A boolean value to mark reading from the stderr flow.
+ * @param[in] is_stderr A boolean value to mark reading from the stderr flow.
*
- * @param[in] timeout A timeout in seconds. A value of -1 means infinite
- * timeout.
+ * @param[in] timeout_ms A timeout in milliseconds. A value of -1 means
+ * infinite timeout.
*
* @return The number of bytes read, 0 on end of file or SSH_ERROR
* on error. In nonblocking mode it Can return 0 if no data