libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_session_init_ex - initializes an SSH session object
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
LIBSSH2_SESSION *
11
libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myalloc)),
12
                        LIBSSH2_FREE_FUNC((*myfree)),
13
                        LIBSSH2_REALLOC_FUNC((*myrealloc)),
14
                        void *abstract);
15

16
LIBSSH2_SESSION *
17
libssh2_session_init(void);
18
.fi
19
.SH DESCRIPTION
20
\fImyalloc\fP - Custom allocator function. Refer to the section on Callbacks
21
for implementing an allocator callback. Pass a value of NULL to use the
22
default system allocator.
23

24
\fImyfree\fP - Custom de-allocator function. Refer to the section on Callbacks
25
for implementing a deallocator callback. Pass a value of NULL to use the
26
default system deallocator.
27

28
\fImyrealloc\fP - Custom re-allocator function. Refer to the section on
29
Callbacks for implementing a reallocator callback. Pass a value of NULL to
30
use the default system reallocator.
31

32
\fIabstract\fP - Arbitrary pointer to application specific callback data.
33
This value will be passed to any callback function associated with the named
34
session instance.
35

36
Initializes an SSH session object. By default system memory allocators
37
(malloc(), free(), realloc()) will be used for any dynamically allocated memory
38
blocks. Alternate memory allocation functions may be specified using the
39
extended version of this API call, and/or optional application specific data
40
may be attached to the session object.
41

42
This method must be called first, prior to configuring session options or
43
starting up an SSH session with a remote server.
44
.SH RETURN VALUE
45
Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors.
46
.SH SEE ALSO
47
.BR libssh2_session_free(3)
48
.BR libssh2_session_handshake(3)
49