mirror of https://github.com/mkerrisk/man-pages
86 lines
2.3 KiB
Groff
86 lines
2.3 KiB
Groff
.\" Copyright (C) 2003 Free Software Foundation, Inc.
|
|
.\" This file is distributed according to the GNU General Public License.
|
|
.\" See the file COPYING in the top level source directory for details.
|
|
.\"
|
|
.\" .de Sh \" Subsection
|
|
.\" .br
|
|
.\" .if t .Sp
|
|
.\" .ne 5
|
|
.\" .PP
|
|
.\" \fB\\$1\fR
|
|
.\" .PP
|
|
.\" ..
|
|
.\" .de Sp \" Vertical space (when we can't use .PP)
|
|
.\" .if t .sp .5v
|
|
.\" .if n .sp
|
|
.\" ..
|
|
.\" .de Ip \" List item
|
|
.\" .br
|
|
.\" .ie \\n(.$>=3 .ne \\$3
|
|
.\" .el .ne 3
|
|
.\" .IP "\\$1" \\$2
|
|
.\" ..
|
|
.TH "IO_GETEVENTS" 2 "2003-02-21" "Linux 2.4" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
io_getevents \- read asynchronous I/O events from the completion queue
|
|
.SH "SYNOPSIS"
|
|
.nf
|
|
.\" .ad l
|
|
.\" .hy 0
|
|
.B #include <linux/time.h>
|
|
.B #include <libaio.h>
|
|
.\" #include <linux/aio.h>
|
|
.sp
|
|
.\" .HP 19
|
|
.BI "int io_getevents(aio_context_t " ctx_id ", long " min_nr ", long " nr ,
|
|
.BI " struct io_event *" events \
|
|
", struct timespec *" timeout );
|
|
.\" .ad
|
|
.\" .hy
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBio_getevents\fR() attempts to read at least \fImin_nr\fR events and
|
|
up to \fInr\fR events from the completion queue of the AIO context
|
|
specified by \fIctx_id\fR.
|
|
\fItimeout\fR specifies the amount of time to wait for events,
|
|
where a NULL timeout waits until at least \fImin_nr\fR events
|
|
have been seen.
|
|
Note that \fItimeout\fR is relative and will be updated if not NULL
|
|
and the operation blocks.
|
|
.SH "RETURN VALUE"
|
|
.PP
|
|
On success,
|
|
\fBio_getevents\fR() returns the number of events read: 0 if no events are
|
|
available or < \fImin_nr\fR if the \fItimeout\fR has elapsed;
|
|
on failure, it returns one of the errors listed under ERRORS.
|
|
.SH "ERRORS"
|
|
.TP
|
|
.B EINVAL
|
|
\fIctx_id\fR is invalid. \fImin_nr\fR is out of range or \fInr\fR is
|
|
out of range.
|
|
.TP
|
|
.B EFAULT
|
|
Either \fIevents\fR or \fItimeout\fR is an invalid pointer.
|
|
.TP
|
|
.B ENOSYS
|
|
\fBio_getevents\fR() is not implemented on this architecture.
|
|
.SH "CONFORMING TO"
|
|
.PP
|
|
\fBio_getevents\fR() is Linux specific and should not be used in
|
|
programs that are intended to be portable.
|
|
.SH "VERSIONS"
|
|
.PP
|
|
The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBio_setup\fR(2), \fBio_submit\fR(2), \fBio_getevents\fR(2),
|
|
\fBio_cancel\fR(2), \fBio_destroy\fR(2).
|
|
.\" .SH "NOTES"
|
|
.\"
|
|
.\" .PP
|
|
.\" The asynchronous I/O system calls were written by Benjamin LaHaise.
|
|
.\"
|
|
.\" .SH AUTHOR
|
|
.\" Kent Yoder.
|