1nbd_connect_tcp(3)                  LIBNBD                  nbd_connect_tcp(3)
2
3
4

NAME

6       nbd_connect_tcp - connect to NBD server over a TCP port
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_connect_tcp (
12              struct nbd_handle *h, const char *hostname,
13              const char *port
14            );
15

DESCRIPTION

17       Connect (synchronously) to the NBD server listening on "hostname:port".
18       The "port" may be a port name such as "nbd", or it may be a port number
19       as a string such as "10809".
20
21       This call returns when the connection has been made.  By default, this
22       proceeds all the way to transmission phase, but nbd_set_opt_mode(3) can
23       be used for manual control over option negotiation performed before
24       transmission phase.
25

RETURN VALUE

27       If the call is successful the function returns 0.
28

ERRORS

30       On error -1 is returned.
31
32       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
33       of the error.
34
35       The following parameters must not be NULL: "h", "hostname", "port".
36       For more information see "Non-NULL parameters" in libnbd(3).
37

HANDLE STATE

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

VERSION

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

SEE ALSO

51       nbd_aio_connect_tcp(3), nbd_create(3), nbd_set_opt_mode(3), libnbd(3).
52

AUTHORS

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

59       Copyright Red Hat
60

LICENSE

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