1nbd_cache(3)                        LIBNBD                        nbd_cache(3)
2
3
4

NAME

6       nbd_cache - send cache (prefetch) command to the NBD server
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_cache (struct nbd_handle *h, uint64_t count,
12                       uint64_t offset, uint32_t flags);
13

DESCRIPTION

15       Issue the cache (prefetch) command to the NBD server, which if
16       supported by the server causes data to be prefetched into faster
17       storage by the server, speeding up a subsequent nbd_pread(3) call.  The
18       server can also silently ignore this command.  Note this will return an
19       error if nbd_can_cache(3) is false.
20
21       The "flags" parameter must be 0 for now (it exists for future NBD
22       protocol extensions).
23

RETURN VALUE

25       If the call is successful the function returns 0.
26

ERRORS

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

HANDLE STATE

34       The handle must be connected and finished handshaking with the server,
35       otherwise this call will return an 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_CACHE 1
44

SEE ALSO

46       nbd_can_cache(3), nbd_aio_cache(3), nbd_create(3), libnbd(3).
47

AUTHORS

49       Eric Blake
50
51       Richard W.M. Jones
52

54       Copyright (C) 2019 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.2.1                      2019-11-14                      nbd_cache(3)
Impressum