| Line | |
|---|
| 1 | .TH io_queue_wait 2 2002-09-03 "Linux 2.4" "Linux AIO" |
|---|
| 2 | .SH NAME |
|---|
| 3 | io_queue_wait \- Wait for io requests to complete |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .nf |
|---|
| 6 | .B #include <errno.h> |
|---|
| 7 | .br |
|---|
| 8 | .sp |
|---|
| 9 | .B #include <libaio.h> |
|---|
| 10 | .br |
|---|
| 11 | .sp |
|---|
| 12 | .BI "int io_queue_wait(io_context_t ctx, const struct timespec *timeout);" |
|---|
| 13 | .fi |
|---|
| 14 | .SH DESCRIPTION |
|---|
| 15 | Attempts to read an event from |
|---|
| 16 | the completion queue for the aio_context specified by ctx_id. |
|---|
| 17 | .SH "RETURN VALUES" |
|---|
| 18 | May return |
|---|
| 19 | 0 if no events are available and the timeout specified |
|---|
| 20 | by when has elapsed, where when == NULL specifies an infinite |
|---|
| 21 | timeout. Note that the timeout pointed to by when is relative and |
|---|
| 22 | will be updated if not NULL and the operation blocks. Will fail |
|---|
| 23 | with -ENOSYS if not implemented. |
|---|
| 24 | .SH "RETURN VALUES" |
|---|
| 25 | On success, |
|---|
| 26 | .B io_queue_wait |
|---|
| 27 | returns 0. Otherwise, -error is return, where |
|---|
| 28 | error is one of the Exxx values defined in the Errors section. |
|---|
| 29 | .SH ERRORS |
|---|
| 30 | .TP |
|---|
| 31 | .B EFAULT |
|---|
| 32 | .I iocbs |
|---|
| 33 | referenced data outside of the program's accessible address space. |
|---|
| 34 | .TP |
|---|
| 35 | .B EINVAL |
|---|
| 36 | .I ctx |
|---|
| 37 | refers to an unitialized aio context, the iocb pointed to by |
|---|
| 38 | .I iocbs |
|---|
| 39 | contains an improperly initialized iocb, |
|---|
| 40 | .TP |
|---|
| 41 | .B ENOSYS |
|---|
| 42 | Not implemented |
|---|
| 43 | .SH "SEE ALSO" |
|---|
| 44 | .BR io(3), |
|---|
| 45 | .BR io_cancel(3), |
|---|
| 46 | .BR io_fsync(3), |
|---|
| 47 | .BR io_getevents(3), |
|---|
| 48 | .BR io_prep_fsync(3), |
|---|
| 49 | .BR io_prep_pread(3), |
|---|
| 50 | .BR io_prep_pwrite(3), |
|---|
| 51 | .BR io_queue_init(3), |
|---|
| 52 | .BR io_queue_release(3), |
|---|
| 53 | .BR io_queue_run(3), |
|---|
| 54 | .BR io_set_callback(3), |
|---|
| 55 | .BR io_submit(3), |
|---|
| 56 | .BR errno(3) |
|---|
Note: See
TracBrowser
for help on using the repository browser.
