1nbd_connection_state(3)             LIBNBD             nbd_connection_state(3)
2
3
4

NAME

6       nbd_connection_state - return string describing the state of the
7       connection
8

SYNOPSIS

10        #include <libnbd.h>
11
12        const char * nbd_connection_state (struct nbd_handle *h);
13

DESCRIPTION

15       Returns a descriptive string for the state of the connection.  This can
16       be used for debugging or troubleshooting, but you should not rely on
17       the state of connections since it may change in future versions.
18

RETURN VALUE

20       This call returns a statically allocated string, valid for the lifetime
21       of the process or until libnbd is unloaded by dlclose(3).  You must not
22       try to free the string.
23

ERRORS

25       On error "NULL" 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".  For more information
31       see "Non-NULL parameters" in libnbd(3).
32

VERSION

34       This function first appeared in libnbd 1.0.
35
36       If you need to test if this function is available at compile time check
37       if the following macro is defined:
38
39        #define LIBNBD_HAVE_NBD_CONNECTION_STATE 1
40

SEE ALSO

42       nbd_create(3), libnbd(3).
43

AUTHORS

45       Eric Blake
46
47       Richard W.M. Jones
48

50       Copyright (C) 2019-2021 Red Hat Inc.
51

LICENSE

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