shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-11 10:40:27 +09:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documenation of ssh_select().

Browse Source
This commit is contained in:
Andreas Schneider
2010-04-04 15:46:51 +02:00
parent a75a2bf533
commit e26c6d20fe
1 changed files with 17 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
libssh/connect.c
View File

@@ -438,8 +438,10 @@ socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
} }
/** /**
* @addtogroup ssh_session * @addtogroup libssh_session
* @{ */ *
* @{
*/
/** /**
* @brief A wrapper for the select syscall * @brief A wrapper for the select syscall
@@ -447,25 +449,25 @@ socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
* This functions acts more or less like the select(2) syscall.\n * This functions acts more or less like the select(2) syscall.\n
* There is no support for writing or exceptions.\n * There is no support for writing or exceptions.\n
* *
* @param channels Arrays of channels pointers terminated by a NULL. * @param[in] channels Arrays of channels pointers terminated by a NULL.
* It is never rewritten. * It is never rewritten.
* *
* @param outchannels Arrays of same size that "channels", there is no need * @param[out] outchannels Arrays of same size that "channels", there is no need
* to initialize it. * to initialize it.
* *
* @param maxfd Maximum +1 file descriptor from readfds. * @param[in] maxfd Maximum +1 file descriptor from readfds.
* *
* @param readfds A fd_set of file descriptors to be select'ed for * @param[in] readfds A fd_set of file descriptors to be select'ed for
* reading. * reading.
* *
* @param timeout A timeout for the select. * @param[in] timeout A timeout for the select.
* *
* @return -1 if an error occured. E_INTR if it was interrupted. In that case, * @return -1 if an error occured. E_INTR if it was interrupted, in
* just restart it. * that case, just restart it.
* *
* @warning libssh is not threadsafe here. That means that if a signal is caught * @warning libssh is not threadsafe here. That means that if a signal is caught
* during the processing of this function, you cannot call ssh functions on * during the processing of this function, you cannot call ssh
* sessions that are busy with ssh_select(). * functions on sessions that are busy with ssh_select().
* *
* @see select(2) * @see select(2)
*/ */
@@ -587,5 +589,6 @@ int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd,
return 0; return 0;
} }
/** @} */ /* @} */
/* vim: set ts=2 sw=2 et cindent: */
/* vim: set ts=4 sw=4 et cindent: */