shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-04 12:20:42 +09:00
Code Issues Packages Projects Releases Wiki Activity

doc: correct ssh_channel_read_timeout units

Browse Source 
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Jon Simons
2014-01-28 20:42:59 -08:00
committed by Andreas Schneider
parent 45d28c7682
commit f29f10876a
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/libssh/libssh.h
View File

@@ -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);

12
src/channels.c
View File

@@ -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