libssh2_session_disconnect_ex.3 (1392B)
1.TH libssh2_session_disconnect_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_session_disconnect_ex - terminate transport layer 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, 10 const char *description, 11 const char *lang); 12 13int 14libssh2_session_disconnect(LIBSSH2_SESSION *session, 15 const char *description); 16.fi 17.SH DESCRIPTION 18\fIsession\fP - Session instance as returned by 19.BR libssh2_session_init_ex(3) 20 21\fIreason\fP - One of the Disconnect Reason constants. 22 23\fIdescription\fP - Human readable reason for disconnection. 24 25\fIlang\fP - Localization string describing the language/encoding of the description provided. 26 27Send a disconnect message to the remote host associated with \fIsession\fP, 28along with a \fIreason\fP symbol and a verbose \fIdescription\fP. 29 30As a convenience, the macro 31.BR libssh2_session_disconnect(3) 32is provided. It calls 33.BR libssh2_session_disconnect_ex(3) 34with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION 35and \fIlang\fP set to an empty string. 36.SH RETURN VALUE 37Return 0 on success or negative on failure. It returns 38LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 39LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 40.SH SEE ALSO 41.BR libssh2_session_init_ex(3)