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.
33 lines
1.2 KiB
Groff
33 lines
1.2 KiB
Groff
.\" $Id: libssh2_session_init.3,v 1.3 2007/06/06 12:34:07 jehousley Exp $
|
|
.\"
|
|
.TH libssh2_session_init 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_init - initializes an SSH session object
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
LIBSSH2_SESSION *libssh2_session_init_ex(
|
|
LIBSSH2_ALLOC_FUNC((*myalloc)),
|
|
LIBSSH2_FREE_FUNC((*myfree)),
|
|
LIBSSH2_REALLOC_FUNC((*myrealloc)),
|
|
void *abstract);
|
|
|
|
LIBSSH2_SESSION *libssh2_session_init(void);
|
|
.SH DESCRIPTION
|
|
Initializes an SSH session object. By default system memory allocators
|
|
(malloc(), free(), realloc()) will be used for any dynamically allocated memory
|
|
blocks. Alternate memory allocation functions may be specified using the
|
|
extended version of this API call, and/or optional application specific data
|
|
may be attached to the session object.
|
|
|
|
This method must be called first, prior to configuring session options or
|
|
starting up an SSH session with a remote server.
|
|
.SH RETURN VALUE
|
|
Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors.
|
|
.SH ERRORS
|
|
LIBSSH2_ERROR_EAGAIN
|
|
Marked for non-blocking I/O but the call would block.
|
|
.SH "SEE ALSO"
|
|
.BI libssh2_session_free(3),
|
|
.BI libssh2_session_startup(3)
|