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
33       The following parameters must not be NULL: "h".  For more information
34       see "Non-NULL parameters" in libnbd(3).
35

HANDLE STATE

37       The handle must be newly created, otherwise this call will return an
38       error.
39

VERSION

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

SEE ALSO

49       nbd_aio_connect_socket(3), nbd_connect_command(3), nbd_create(3),
50       libnbd(3), socket(7).
51

AUTHORS

53       Eric Blake
54
55       Richard W.M. Jones
56

58       Copyright (C) 2019-2021 Red Hat Inc.
59

LICENSE

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