File: io_queue_wait.3

package info (click to toggle)
libaio 0.3.110-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,132 kB
  • ctags: 749
  • sloc: ansic: 1,931; makefile: 195; sh: 14
file content (56 lines) | stat: -rw-r--r-- 1,458 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.TH io_queue_wait 2 2009-06-10 "Linux 2.4" "Linux AIO"
.SH NAME
io_queue_wait \- Wait for io requests to complete
.SH SYNOPSIS
.nf
.B #include <errno.h>
.br
.sp
.B #include <libaio.h>
.br
.sp
.BI "int io_queue_wait(io_context_t " ctx_id ", const struct timespec *" timeout ");"
.fi
.SH DESCRIPTION
Attempts to read an event from
the completion queue for the aio_context specified by \fIctx_id\fP.
.SH "RETURN VALUES"
May return
\fI0\fP if no events are available and the timeout specified
by when has elapsed, where when == NULL specifies an infinite
\fItimeout\fP. Note that the \fItimeout\fP pointed to by when is relative and
will be updated if not NULL and the operation blocks.  Will fail
with -\fBENOSYS\fP if not implemented.
.SH "RETURN VALUES"
On success,
.B io_queue_wait
returns \fI0\fP. Otherwise, -error is return, where
error is one of the Exxx values defined in the Errors section.
.SH ERRORS
.TP
.B EFAULT
.I iocbs
referenced data outside of the program's accessible address space.
.TP
.B EINVAL
.I ctx_id
refers to an unitialized aio context, the \fIiocb\fP pointed to by
.I iocbs 
contains an improperly initialized iocb.
.TP
.B ENOSYS 
Not implemented.
.SH "SEE ALSO"
.BR io (3),
.BR io_cancel (3),
.BR io_fsync (3),
.BR io_getevents (3),
.BR io_prep_fsync (3),
.BR io_prep_pread (3),
.BR io_prep_pwrite (3),
.BR io_queue_init (3),
.BR io_queue_release (3),
.BR io_queue_run (3),
.BR io_set_callback (3),
.BR io_submit (3),
.BR errno (3).