1nbd_connection_state(3) LIBNBD nbd_connection_state(3)
2
3
4
6 nbd_connection_state - return string describing the state of the
7 connection
8
10 #include <libnbd.h>
11
12 const char * nbd_connection_state (struct nbd_handle *h);
13
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
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
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
31 This function first appeared in libnbd 1.0.
32
33 If you need to test if this function is available at compile time check
34 if the following macro is defined:
35
36 #define LIBNBD_HAVE_NBD_CONNECTION_STATE 1
37
39 nbd_create(3), libnbd(3).
40
42 Eric Blake
43
44 Richard W.M. Jones
45
47 Copyright (C) 2019 Red Hat Inc.
48
50 This library is free software; you can redistribute it and/or modify it
51 under the terms of the GNU Lesser General Public License as published
52 by the Free Software Foundation; either version 2 of the License, or
53 (at your option) any later version.
54
55 This library is distributed in the hope that it will be useful, but
56 WITHOUT ANY WARRANTY; without even the implied warranty of
57 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
58 Lesser General Public License for more details.
59
60 You should have received a copy of the GNU Lesser General Public
61 License along with this library; if not, write to the Free Software
62 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
63 02110-1301 USA
64
65
66
67libnbd-1.2.1 2019-11-14 nbd_connection_state(3)