libssh2/share/man/man3/libssh2_session_init.3

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