lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-29 01:03:57 +03:00
Code Activity

options: Document that the caller needs to close the socket

Browse Source 
Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
This commit is contained in:
Andreas Schneider
2022-04-19 16:22:41 +02:00
committed by Jakub Jelen
parent 4b20d7ad18
commit ca51565056
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/client.c
View File

@@ -693,8 +693,13 @@ int ssh_get_openssh_version(ssh_session session)
/** /**
* @brief Disconnect from a session (client or server). * @brief Disconnect from a session (client or server).
*
* The session can then be reused to open a new session. * The session can then be reused to open a new session.
* *
* @note Note that this function wont close the socket if it was set with
* @ssh_options_set and SSH_OPTIONS_FD. You're responsible for closing the
* socket. This is new behavior in libssh 0.10.
*
* @param[in] session The SSH session to use. * @param[in] session The SSH session to use.
*/ */
void void

7
src/options.c
View File

@@ -265,9 +265,10 @@ int ssh_options_set_algo(ssh_session session,
* The file descriptor to use (socket_t).\n * The file descriptor to use (socket_t).\n
* \n * \n
* If you wish to open the socket yourself for a reason * If you wish to open the socket yourself for a reason
* or another, set the file descriptor. Don't forget to * or another, set the file descriptor and take care of closing
* set the hostname as the hostname is used as a key in * it (this is new behavior in libssh 0.10).
* the known_host mechanism. * Don't forget to set the hostname as the hostname is used
* as a key in the known_host mechanism.
* *
* - SSH_OPTIONS_BINDADDR: * - SSH_OPTIONS_BINDADDR:
* The address to bind the client to (const char *). * The address to bind the client to (const char *).