File: io_getevents.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 (79 lines) | stat: -rw-r--r-- 2,597 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.\"/* io_getevents:
.\" *      Attempts to read at least min_nr events and up to nr events from
.\" *      the completion queue for the aio_context specified by ctx_id.  May
.\" *      fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
.\" *      if nr is out of range, if when is out of range.  May fail with
.\" *      -EFAULT if any of the memory specified to is invalid.  May return
.\" *      0 or < min_nr if no events are available and the timeout specified
.\" *      by when has elapsed, where when == NULL specifies an infinite
.\" *      timeout.  Note that the timeout pointed to by when is relative and
.\" *      will be updated if not NULL and the operation blocks.  Will fail
.\" *      with -ENOSYS if not implemented.
.\" */
.\"asmlinkage long sys_io_getevents(io_context_t ctx_id,
.\"                                 long min_nr,
.\"                                 long nr,
.\"                                 struct io_event *events,
.\"                                 struct timespec *timeout)
.\"
.TH io_getevents 2 2009-06-10 "Linux 2.4" "Linux AIO"
.SH NAME
io_getevents \- Read resulting events from io requests
.SH SYNOPSIS
.nf
.B #include <errno.h>
.sp
.br
.B #include <libaio.h>
.br
.sp
struct iocb {
	void		*data;
	unsigned	key;
	short		aio_lio_opcode;
	short		aio_reqprio;
	int		aio_fildes;
};
.sp
struct io_event {
        unsigned        PADDED(data, __pad1);
        unsigned        PADDED(obj,  __pad2);
        unsigned        PADDED(res,  __pad3);
        unsigned        PADDED(res2, __pad4);
};
.sp
.BI "int io_getevents(io_context_t " ctx ", long " nr ", struct io_event *" events "[], struct timespec *" timeout ");"

.fi
.SH DESCRIPTION
Attempts to read  up to nr events from
the completion queue for the aio_context specified by \fIctx\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
timeout.  Note that the timeout 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 ERRORS
.TP
.B EINVAL 
If ctx_id is invalid, if min_nr is out of range,
if nr is out of range, if when is out of range.  
.TP
.B EFAULT 
If any of the memory specified to is invalid.
.SH "SEE ALSO"
.BR io (3),
.BR io_cancel (3),
.BR io_fsync (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_queue_wait (3),
.BR io_set_callback (3),
.BR io_submit (3),
.BR errno (3).