103 lines
2.9 KiB
Groff
103 lines
2.9 KiB
Groff
|
.\" $NetBSD: aio_return.3,v 1.1 2007/05/04 22:37:35 rmind Exp $
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 1999 Softweyr LLC.
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
|
||
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE
|
||
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||
|
|
.\" SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.\" $FreeBSD: /repoman/r/ncvs/src/lib/libc/sys/aio_return.2,v 1.19 2006/10/07 10:49:20 trhodes Exp $
|
||
|
|
.\"
|
||
|
|
.Dd May 4, 2007
|
||
|
|
.Dt AIO_RETURN 3
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm aio_return
|
||
|
|
.Nd retrieve return status of asynchronous I/O operation (REALTIME)
|
||
|
|
.Sh LIBRARY
|
||
|
|
.Lb librt
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In aio.h
|
||
|
|
.Ft int
|
||
|
|
.Fn aio_return "struct aiocb *aiocbp"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn aio_return
|
||
|
|
system call returns the final status of the asynchronous I/O request
|
||
|
|
associated with the structure pointed to by
|
||
|
|
.Fa aiocbp .
|
||
|
|
.Pp
|
||
|
|
The
|
||
|
|
.Fn aio_return
|
||
|
|
system call
|
||
|
|
should only be called once, to obtain the final status of an asynchronous
|
||
|
|
I/O operation once it has completed
|
||
|
|
.Xr ( aio_error 3
|
||
|
|
returns something other than
|
||
|
|
.Er EINPROGRESS ) .
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
If the asynchronous I/O request has completed, the status is returned
|
||
|
|
as described in
|
||
|
|
.Xr read 2 ,
|
||
|
|
.Xr write 2 ,
|
||
|
|
or
|
||
|
|
.Xr fsync 2 .
|
||
|
|
Otherwise,
|
||
|
|
.Fn aio_return
|
||
|
|
returns \-1 and sets
|
||
|
|
.Va errno
|
||
|
|
to indicate the error condition.
|
||
|
|
.Sh ERRORS
|
||
|
|
The
|
||
|
|
.Fn aio_return
|
||
|
|
system call will fail if:
|
||
|
|
.Bl -tag -width Er
|
||
|
|
.It Bq Er EINVAL
|
||
|
|
The
|
||
|
|
.Fa aiocbp
|
||
|
|
argument
|
||
|
|
does not reference a completed asynchronous I/O request.
|
||
|
|
.El
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr fsync 2 ,
|
||
|
|
.Xr read 2 ,
|
||
|
|
.Xr write 2 ,
|
||
|
|
.Xr aio_cancel 3 ,
|
||
|
|
.Xr aio_error 3 ,
|
||
|
|
.Xr aio_suspend 3 ,
|
||
|
|
.Xr aio_write 3
|
||
|
|
.Sh STANDARDS
|
||
|
|
The
|
||
|
|
.Fn aio_return
|
||
|
|
system call
|
||
|
|
is expected to conform to the
|
||
|
|
.St -p1003.1-2001
|
||
|
|
standard.
|
||
|
|
.Sh HISTORY
|
||
|
|
The
|
||
|
|
.Fn aio_return
|
||
|
|
system call first appeared in
|
||
|
|
.Nx 5.0 .
|
||
|
|
.Sh AUTHORS
|
||
|
|
This
|
||
|
|
manual page was written by
|
||
|
|
.An Wes Peters Aq wes@softweyr.com .
|