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 (struct nbd_handle *h, uint32_t flags);
12

DESCRIPTION

14       Issue the flush command to the NBD server.  The function should return
15       when all write commands which have completed have been committed to
16       permanent storage on the server.  Note this will return an error if
17       nbd_can_flush(3) is false.
18
19       The "flags" parameter must be 0 for now (it exists for future NBD
20       protocol extensions).
21

RETURN VALUE

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

ERRORS

26       On error "-1" is returned.
27
28       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
29       of the error.
30

HANDLE STATE

32       The handle must be connected and finished handshaking with the server,
33       otherwise this call will return an error.
34

VERSION

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

SEE ALSO

44       nbd_aio_flush(3), nbd_can_flush(3), nbd_create(3), libnbd(3).
45

AUTHORS

47       Eric Blake
48
49       Richard W.M. Jones
50

52       Copyright (C) 2019 Red Hat Inc.
53

LICENSE

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