libssh2_session_init_ex - initializes an SSH session object
#include <libssh2.h> LIBSSH2_SESSION * libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myal- loc)), LIBSSH2_FREE_FUNC((*myfree)), LIBSSH2_REALLOC_FUNC((*myreal- loc)), void *abstract); LIBSSH2_SESSION * libssh2_session_init(void);
libssh2 manual libssh2_session_init_ex(3ssh2)
NAME
libssh2_session_init_ex - initializes an SSH session object
SYNOPSIS
#include <libssh2.h>
LIBSSH2_SESSION * libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myal-
loc)), LIBSSH2_FREE_FUNC((*myfree)), LIBSSH2_REALLOC_FUNC((*myreal-
loc)), void *abstract);
LIBSSH2_SESSION * libssh2_session_init(void);
DESCRIPTION
myalloc - Custom allocator function. Refer to the section on Callbacks
for implementing an allocator callback. Pass a value of NULL to use the
default system allocator.
myfree - Custom de-allocator function. Refer to the section on Call-
backs for implementing a deallocator callback. Pass a value of NULL to
use the default system deallocator.
myrealloc - Custom re-allocator function. Refer to the section on Call-
backs for implementing a reallocator callback. Pass a value of NULL to
use the default system reallocator.
abstract - Arbitrary pointer to application specific callback data.
This value will be passed to any callback function associated with the
named session instance.
Initializes an SSH session object. By default system memory allocators
(malloc(), free(), realloc()) will be used for any dynamically allo-
cated memory blocks. Alternate memory allocation functions may be spec-
ified 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.
RETURN VALUE
Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on
errors.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_session_free(3) libssh2_session_handshake(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 0.15 1 Jun 2007
libssh2_session_init_ex(3ssh2)