1nbd_aio_pread_structured(3)         LIBNBD         nbd_aio_pread_structured(3)
2
3
4

NAME

6       nbd_aio_pread_structured - read from the NBD server
7

SYNOPSIS

9        #include <libnbd.h>
10
11        typedef struct {
12          int (*callback) (void *user_data, const void *subbuf,
13                           size_t count, uint64_t offset,
14                           unsigned status, int *error);
15          void *user_data;
16          void (*free) (void *user_data);
17        } nbd_chunk_callback;
18
19        typedef struct {
20          int (*callback) (void *user_data, int *error);
21          void *user_data;
22          void (*free) (void *user_data);
23        } nbd_completion_callback;
24
25        int64_t nbd_aio_pread_structured (struct nbd_handle *h,
26                                          void *buf, size_t count,
27                                          uint64_t offset,
28                                          nbd_chunk_callback chunk_callback,
29                                          nbd_completion_callback completion_callback,
30                                          uint32_t flags);
31

DESCRIPTION

33       Issue a read command to the NBD server.
34
35       To check if the command completed, call nbd_aio_command_completed(3).
36       Or supply the optional "completion_callback" which will be invoked as
37       described in "Completion callbacks" in libnbd(3).
38
39       Other parameters behave as documented in nbd_pread_structured(3).
40

RETURN VALUE

42       This call returns the 64 bit cookie of the command.  The cookie is ≥ 1.
43       Cookies are unique (per libnbd handle, not globally).
44

ERRORS

46       On error "-1" is returned.
47
48       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
49       of the error.
50

HANDLE STATE

52       The handle must be connected and finished handshaking with the server,
53       otherwise this call will return an error.
54

VERSION

56       This function first appeared in libnbd 1.0.
57
58       If you need to test if this function is available at compile time check
59       if the following macro is defined:
60
61        #define LIBNBD_HAVE_NBD_AIO_PREAD_STRUCTURED 1
62

SEE ALSO

64       "Issuing asynchronous commands" in libnbd(3), nbd_aio_pread(3),
65       nbd_pread_structured(3), nbd_create(3), libnbd(3).
66

AUTHORS

68       Eric Blake
69
70       Richard W.M. Jones
71

73       Copyright (C) 2019 Red Hat Inc.
74

LICENSE

76       This library is free software; you can redistribute it and/or modify it
77       under the terms of the GNU Lesser General Public License as published
78       by the Free Software Foundation; either version 2 of the License, or
79       (at your option) any later version.
80
81       This library is distributed in the hope that it will be useful, but
82       WITHOUT ANY WARRANTY; without even the implied warranty of
83       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
84       Lesser General Public License for more details.
85
86       You should have received a copy of the GNU Lesser General Public
87       License along with this library; if not, write to the Free Software
88       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
89       02110-1301 USA
90
91
92
93libnbd-1.2.1                      2019-11-14       nbd_aio_pread_structured(3)
Impressum