1nbd_connect_socket(3)               LIBNBD               nbd_connect_socket(3)
2
3
4

NAME

6       nbd_connect_socket - connect directly to a connected socket
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_connect_socket (
12              struct nbd_handle *h, int sock
13            );
14

DESCRIPTION

16       Pass a connected socket "sock" through which libnbd will talk to the
17       NBD server.
18
19       The caller is responsible for creating and connecting this socket by
20       some method, before passing it to libnbd.
21
22       If this call returns without error then socket ownership is passed to
23       libnbd.  Libnbd will close the socket when the handle is closed.  The
24       caller must not use the socket in any way.
25
26       This call returns when the connection has been made.  By default, this
27       proceeds all the way to transmission phase, but nbd_set_opt_mode(3) can
28       be used for manual control over option negotiation performed before
29       transmission phase.
30

RETURN VALUE

32       If the call is successful the function returns 0.
33

ERRORS

35       On error -1 is returned.
36
37       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
38       of the error.
39
40       The following parameters must not be NULL: "h".  For more information
41       see "Non-NULL parameters" in libnbd(3).
42

HANDLE STATE

44       The handle must be newly created, otherwise this call will return an
45       error.
46

VERSION

48       This function first appeared in libnbd 1.2.
49
50       If you need to test if this function is available at compile time check
51       if the following macro is defined:
52
53        #define LIBNBD_HAVE_NBD_CONNECT_SOCKET 1
54

SEE ALSO

56       nbd_aio_connect_socket(3), nbd_connect_command(3), nbd_create(3),
57       nbd_set_opt_mode(3), libnbd(3), socket(7).
58

AUTHORS

60       Eric Blake
61
62       Richard W.M. Jones
63

65       Copyright Red Hat
66

LICENSE

68       This library is free software; you can redistribute it and/or modify it
69       under the terms of the GNU Lesser General Public License as published
70       by the Free Software Foundation; either version 2 of the License, or
71       (at your option) any later version.
72
73       This library is distributed in the hope that it will be useful, but
74       WITHOUT ANY WARRANTY; without even the implied warranty of
75       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
76       Lesser General Public License for more details.
77
78       You should have received a copy of the GNU Lesser General Public
79       License along with this library; if not, write to the Free Software
80       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
81       02110-1301 USA
82
83
84
85libnbd-1.16.5                     2023-09-26             nbd_connect_socket(3)
Impressum