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 (struct nbd_handle *h,
12                             const char *hostname,
13                             const char *port);
14

DESCRIPTION

16       Connect (synchronously) to the NBD server listening on "hostname:port".
17       The "port" may be a port name such as "nbd", or it may be a port number
18       as a string such as "10809".  This call returns when the connection has
19       been made.
20

RETURN VALUE

22       If the call is successful the function returns 0.
23

ERRORS

25       On error "-1" is returned.
26
27       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
28       of the error.
29
30       The following parameters must not be NULL: "h", "hostname", "port".
31       For more information see "Non-NULL parameters" in libnbd(3).
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.0.
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_TCP 1
44

SEE ALSO

46       nbd_aio_connect_tcp(3), nbd_create(3), libnbd(3).
47

AUTHORS

49       Eric Blake
50
51       Richard W.M. Jones
52
54       Copyright (C) 2019-2021 Red Hat Inc.
55

LICENSE

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