libssh2_session_init_ex.3 (1812B)
1.TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_session_init_ex - initializes an SSH session object 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8LIBSSH2_SESSION * 9libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myalloc)), 10 LIBSSH2_FREE_FUNC((*myfree)), 11 LIBSSH2_REALLOC_FUNC((*myrealloc)), 12 void *abstract); 13 14LIBSSH2_SESSION * 15libssh2_session_init(void); 16.fi 17.SH DESCRIPTION 18\fImyalloc\fP - Custom allocator function. Refer to the section on Callbacks 19for implementing an allocator callback. Pass a value of NULL to use the 20default system allocator. 21 22\fImyfree\fP - Custom de-allocator function. Refer to the section on Callbacks 23for implementing a deallocator callback. Pass a value of NULL to use the 24default system deallocator. 25 26\fImyrealloc\fP - Custom re-allocator function. Refer to the section on 27Callbacks for implementing a reallocator callback. Pass a value of NULL to 28use the default system reallocator. 29 30\fIabstract\fP - Arbitrary pointer to application specific callback data. 31This value will be passed to any callback function associated with the named 32session instance. 33 34Initializes an SSH session object. By default system memory allocators 35(malloc(), free(), realloc()) will be used for any dynamically allocated memory 36blocks. Alternate memory allocation functions may be specified using the 37extended version of this API call, and/or optional application specific data 38may be attached to the session object. 39 40This method must be called first, prior to configuring session options or 41starting up an SSH session with a remote server. 42.SH RETURN VALUE 43Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors. 44.SH SEE ALSO 45.BR libssh2_session_free(3) 46.BR libssh2_session_handshake(3)