summaryrefslogtreecommitdiffstats
path: root/lib/libc/sys/aio_write.2
diff options
context:
space:
mode:
authorchris <chris@FreeBSD.org>2000-06-23 05:05:44 +0000
committerchris <chris@FreeBSD.org>2000-06-23 05:05:44 +0000
commita6d911fe4ec44bd192bc844817123acbfbb79fd8 (patch)
tree8888b98b7734fc74018a7258777e65e84b9969da /lib/libc/sys/aio_write.2
parent884ed8fd45a157d537285e599ff01a509ff189b8 (diff)
downloadFreeBSD-src-a6d911fe4ec44bd192bc844817123acbfbb79fd8.zip
FreeBSD-src-a6d911fe4ec44bd192bc844817123acbfbb79fd8.tar.gz
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples:
``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd''
Diffstat (limited to 'lib/libc/sys/aio_write.2')
-rw-r--r--lib/libc/sys/aio_write.244
1 files changed, 22 insertions, 22 deletions
diff --git a/lib/libc/sys/aio_write.2 b/lib/libc/sys/aio_write.2
index c6f1706..2038c07 100644
--- a/lib/libc/sys/aio_write.2
+++ b/lib/libc/sys/aio_write.2
@@ -40,11 +40,11 @@
The
.Fn aio_write
function allows the calling process to write
-.Ar iocb->aio_nbytes
+.Fa iocb->aio_nbytes
from the buffer pointed to by
-.Ar iocb->aio_buf
+.Fa iocb->aio_buf
to the descriptor
-.Ar iocb->aio_fildes .
+.Fa iocb->aio_fildes .
The call returns immediately after the write request has been enqueued
to the descriptor; the write may or may not have completed at the time
the call returns. If the request could not be enqueued, generally due
@@ -54,24 +54,24 @@ request.
If
.Dv O_APPEND
is set for
-.Ar iocb->aio_fildes ,
+.Fa iocb->aio_fildes ,
.Fn aio_write
operations append to the file in the same order as the calls were
made. If
.Dv O_APPEND
is not set for the file descriptor, the write operation will occur at
the absolute position from the beginning of the file plus
-.Ar iocb->aio_offset .
+.Fa iocb->aio_offset .
.Pp
If
.Dv _POSIX_PRIORITIZED_IO
is defined, and the descriptor supports it, then the enqueued
operation is submitted at a priority equal to that of the calling
process minus
-.Ar iocb->aio_reqprio .
+.Fa iocb->aio_reqprio .
.Pp
The
-.Ar iocb
+.Fa iocb
pointer may be subsequently used as an argument to
.Fn aio_return
and
@@ -80,20 +80,20 @@ in order to determine return or error status for the enqueued operation
while it is in progress.
.Pp
If the request is successfully enqueued, the value of
-.Ar iocb->aio_offset
+.Fa iocb->aio_offset
can be modified during the request as context, so this value must not
be referenced after the request is enqueued.
.Sh RESTRICTIONS
The Asynchronous I/O Control Block structure pointed to by
-.Ar iocb
+.Fa iocb
and the buffer that the
-.Ar iocb->aio_buf
+.Fa iocb->aio_buf
member of that structure references must remain valid until the
operation has completed. For this reason, use of auto (stack) variables
for these objects is discouraged.
.Pp
The asynchronous I/O control buffer
-.Ar iocb
+.Fa iocb
should be zeroed before the
.Fn aio_read
call to avoid passing bogus context information to the kernel.
@@ -103,9 +103,9 @@ buffer contents after the request has been enqueued, but before the
request has completed, are not allowed.
.Pp
If the file offset in
-.Ar iocb->aio_offset
+.Fa iocb->aio_offset
is past the offset maximum for
-.Ar iocb->aio_fildes ,
+.Fa iocb->aio_fildes ,
no I/O will occur.
.Sh RETURN VALUES
.Rv -std aio_write
@@ -128,26 +128,26 @@ call is made, or asynchronously, at any time thereafter. If they
are detected at call time,
.Fn aio_write
returns -1 and sets
-.Ar errno
+.Va errno
appropriately; otherwise the
.Fn aio_return
function must be called, and will return -1, and
.Fn aio_error
must be called to determine the actual value that would have been
returned in
-.Ar errno .
+.Va errno .
.Pp
.Bl -tag -width Er
.It Bq Er EBADF
-.Ar iocb->aio_fildes
+.Fa iocb->aio_fildes
is invalid, or is not opened for writing.
.It Bq Er EINVAL
The offset
-.Ar iocb->aio_offset
+.Fa iocb->aio_offset
is not valid, the priority specified by
-.Ar iocb->aio_reqprio
+.Fa iocb->aio_reqprio
is not a valid priority, or the number of bytes specified by
-.Ar iocb->aio_nbytes
+.Fa iocb->aio_nbytes
is not valid.
.El
.Pp
@@ -163,14 +163,14 @@ function is either one of the error returns from the
call, or one of:
.Bl -tag -width Er
.It Bq Er EBADF
-.Ar iocb->aio_fildes
+.Fa iocb->aio_fildes
is invalid for writing.
.It Bq Er ECANCELED
The request was explicitly canceled via a call to
.Fn aio_cancel .
.It Bq Er EINVAL
The offset
-.Ar iocb->aio_offset
+.Fa iocb->aio_offset
would be invalid.
.El
.Sh STANDARDS
@@ -189,6 +189,6 @@ This manual page was written by
.Sh BUGS
Asynchronous I/O operations cannot be canceled in this implementation.
Invalid information in
-.Ar iocb->_aiocb_private
+.Fa iocb->_aiocb_private
may confuse the kernel.
OpenPOWER on IntegriCloud