d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a8cb7cca02
freebsd-skq/lib/libc/sys/aio_waitcomplete.2

138 lines
3.7 KiB
Groff
Raw Normal View History

Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.\" Copyright (c) 1999 Christopher M Sedore.
.\" 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 ``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 THE AUTHOR 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$
.\"
.Dd January 19, 2000
.Dt AIO_WAITCOMPLETE 2
.Os
.Sh NAME
.Nm aio_waitcomplete
.Nd wait for the next completion of an aio request
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In aio.h
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Ft int
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
.Fn aio_waitcomplete "struct aiocb **iocbp" "struct timespec *timeout"
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Sh DESCRIPTION
The
.Fn aio_waitcomplete
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call waits for completion of an asynchronous I/O request.
Apply the accepted line breaking rules.
2000-06-23 15:01:18 +00:00
Upon completion,
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Fn aio_waitcomplete
returns the result of the function and sets
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
.Fa iocbp
Apply the accepted line breaking rules.
2000-06-23 15:01:18 +00:00
to point to the structure associated with the original request.
If an asynchronous I/O request is completed before
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Fn aio_waitcomplete
is called, it returns immediately with the completed request.
.Pp
If
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
.Fa timeout
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
is a non-NULL pointer, it specifies a maximum interval to wait for a
Apply the accepted line breaking rules.
2000-06-23 15:01:18 +00:00
asynchronous I/O request to complete.
If
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
.Fa timeout
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
is a NULL pointer,
.Fn aio_waitcomplete
Apply the accepted line breaking rules.
2000-06-23 15:01:18 +00:00
waits indefinitely.
To effect a poll, the
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
.Fa timeout
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
argument should be non-NULL, pointing to a zero-valued timeval structure.
.Pp
The
.Fn aio_waitcomplete
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call also serves the function of
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Fn aio_return ,
thus
.Fn aio_return
should not be called for the control block returned in
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
.Fa iocbp .
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Sh RETURN VALUES
If an asynchronous I/O request has completed,
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
2000-06-23 05:05:44 +00:00
.Fa iocbp
Apply the accepted line breaking rules.
2000-06-23 15:01:18 +00:00
is set to point to the control block passed with the original request,
and the status is returned as described in
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Xr read 2 ,
.Xr write 2 ,
or
.Xr fsync 2 .
On failure,
.Fn aio_waitcomplete
returns
.Dv -1 ,
sets iocbp to
.Dv NULL
Mark up errno as a variable (Va), not as a defined value (Dv). Do not terminate the cross-reference list in the SEE ALSO section with a period.
2000-06-23 15:02:29 +00:00
and sets
.Va errno
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
to indicate the error condition.
.Sh ERRORS
The
.Fn aio_waitcomplete
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call fails if:
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Bl -tag -width Er
.It Bq Er EINVAL
The specified time limit is invalid.
.It Bq Er EAGAIN
The process has not yet called
.Fn aio_read
or
.Fn aio_write .
.It Bq Er EINTR
A signal was delivered before the timeout expired and before any
asynchronous I/O requests completed.
.It Bq Er EWOULDBLOCK
.It Bq Er EINPROGRESS
The specified time limit expired before any asynchronous I/O requests
completed.
.El
.Sh SEE ALSO
.Xr aio_cancel 2 ,
.Xr aio_error 2 ,
.Xr aio_read 2 ,
.Xr aio_return 2 ,
.Xr aio_suspend 2 ,
.Xr aio_write 2 ,
.Xr fsync 2 ,
.Xr read 2 ,
Explain to users that they may want to kldload aio. Move Xref sections. Submitted by: Craig Rodrigues <rodrigc@attbi.com>
2002-10-22 16:12:27 +00:00
.Xr write 2 ,
* Modernize aio(4), providing instructions for static and dynamic kernel linking. * Fix disorder in the SEE ALSO sections of aio_*(2). * Remove unnecessary cross-references from the SEE ALSO sections of aio_*(2); config(8), kldload(8) and kldunload(8) are cross-referenced from aio(4). * Remove the KERNEL OPTIONS sections from aio_*(2), now that these pages cross-reference aio(4), which contains suitable kernel linking reference material.
2002-10-24 12:57:05 +00:00
.Xr aio 4
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Sh STANDARDS
The
.Fn aio_waitcomplete
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call is a
Use Fx macro wherever possible.
2000-11-14 11:20:58 +00:00
.Fx Ns -specific
extension.
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Sh HISTORY
The
.Fn aio_waitcomplete
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call first appeared in
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.Fx 4.0 .
.Sh AUTHORS
The
.Fn aio_waitcomplete
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe.
2002-12-18 09:22:32 +00:00
system call and this manual page were written by
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu>
2000-03-21 10:25:22 +00:00
.An Christopher M Sedore Aq cmsedore@maxwell.syr.edu .
Reference in New Issue Copy Permalink