4b8db8c1ab
all the way up to the user interface. All code modules bug sftp.c have been completed. Functions that return an "int", or similar return LIBSSH2CHANNEL_EAGAIN to indicate some part of the call would block, in non-blocking mode. Functions that return a structure, like "LIBSSH2_CHANNEL *", return NULL and set the libssh2 error. The error can be obtained with either libssh2_session_last_error() or libssh2_session_last_errno(). Either of these will return the error code of LIBSSH2_ERROR_EAGAIN if the call would block, in non-blocking mode. The current state of a function and some variable are keep in the structures so that on the next call the operation that would block can be retried again with the same data.
21 lines
786 B
Groff
21 lines
786 B
Groff
.\" $Id: libssh2_session_disconnect_ex.3,v 1.1 2007/06/06 12:34:07 jehousley Exp $
|
|
.\"
|
|
.TH libssh2_session_disconnect_ex 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_disconnect_ex - terminate transport layer
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
int ibssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang);
|
|
.SH DESCRIPTION
|
|
Terminates the transport layer connection with the remote host.
|
|
Note that all authentication and connection layer objects become unusable
|
|
at this point and should be explicitly freed prior to disconnection.
|
|
.SH RETURN VALUE
|
|
0 on success, \-1 on failure
|
|
.SH ERRORS
|
|
LIBSSH2_ERROR_EAGAIN
|
|
Marked for non-blocking I/O but the call would block.
|
|
.SH "SEE ALSO"
|
|
.BI libssh2_session_init(3)
|