1nbd_flush(3)                        LIBNBD                        nbd_flush(3)
2
3
4

NAME

6       nbd_flush - send flush command to the NBD server
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_flush (
12              struct nbd_handle *h, uint32_t flags
13            );
14

DESCRIPTION

16       Issue the flush command to the NBD server.  The function should return
17       when all write commands which have completed have been committed to
18       permanent storage on the server.  Note this will generally return an
19       error if nbd_can_flush(3) is false.
20
21       The "flags" parameter must be 0 for now (it exists for future NBD
22       protocol extensions).
23
24       By default, libnbd will reject attempts to use this function with
25       parameters that are likely to result in server failure, such as
26       requesting an unknown command flag.  The nbd_set_strict_mode(3)
27       function can be used to alter which scenarios should await a server
28       reply rather than failing fast.
29

RETURN VALUE

31       If the call is successful the function returns 0.
32

ERRORS

34       On error -1 is returned.
35
36       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
37       of the error.
38
39       The following parameters must not be NULL: "h".  For more information
40       see "Non-NULL parameters" in libnbd(3).
41

HANDLE STATE

43       The handle must be connected with the server, otherwise this call will
44       return an error.
45

VERSION

47       This function first appeared in libnbd 1.0.
48
49       If you need to test if this function is available at compile time check
50       if the following macro is defined:
51
52        #define LIBNBD_HAVE_NBD_FLUSH 1
53

SEE ALSO

55       nbd_aio_flush(3), nbd_can_flush(3), nbd_create(3),
56       nbd_set_strict_mode(3), libnbd(3).
57

AUTHORS

59       Eric Blake
60
61       Richard W.M. Jones
62

64       Copyright Red Hat
65

LICENSE

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