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 (struct nbd_handle *h, int sock);
12

DESCRIPTION

14       Pass a connected socket "sock" through which libnbd will talk to the
15       NBD server.
16
17       The caller is responsible for creating and connecting this socket by
18       some method, before passing it to libnbd.
19
20       If this call returns without error then socket ownership is passed to
21       libnbd.  Libnbd will close the socket when the handle is closed.  The
22       caller must not use the socket in any way.
23

RETURN VALUE

25       If the call is successful the function returns 0.
26

ERRORS

28       On error "-1" is returned.
29
30       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
31       of the error.
32

HANDLE STATE

34       The handle must be newly created, otherwise this call will return an
35       error.
36

VERSION

38       This function first appeared in libnbd 1.2.
39
40       If you need to test if this function is available at compile time check
41       if the following macro is defined:
42
43        #define LIBNBD_HAVE_NBD_CONNECT_SOCKET 1
44

SEE ALSO

46       nbd_aio_connect_socket(3), nbd_connect_command(3), nbd_create(3),
47       libnbd(3), socket(7).
48

AUTHORS

50       Eric Blake
51
52       Richard W.M. Jones
53

55       Copyright (C) 2019-2021 Red Hat Inc.
56

LICENSE

58       This library is free software; you can redistribute it and/or modify it
59       under the terms of the GNU Lesser General Public License as published
60       by the Free Software Foundation; either version 2 of the License, or
61       (at your option) any later version.
62
63       This library is distributed in the hope that it will be useful, but
64       WITHOUT ANY WARRANTY; without even the implied warranty of
65       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
66       Lesser General Public License for more details.
67
68       You should have received a copy of the GNU Lesser General Public
69       License along with this library; if not, write to the Free Software
70       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
71       02110-1301 USA
72
73
74
75libnbd-1.10.1                     2021-10-25             nbd_connect_socket(3)
Impressum