diff options
author | jhb <jhb@FreeBSD.org> | 2016-07-25 23:38:14 +0000 |
---|---|---|
committer | jhb <jhb@FreeBSD.org> | 2016-07-25 23:38:14 +0000 |
commit | c9c19c9c8410b1dcbd760d5382a6071ed8396652 (patch) | |
tree | a84cc30934d8e2d6cb4b4b0f9101dad42b0a7f49 /lib/libc/sys/aio_write.2 | |
parent | 00f2c01573745a81d0ad6e4e2a640f0cf3f46140 (diff) | |
download | FreeBSD-src-c9c19c9c8410b1dcbd760d5382a6071ed8396652.zip FreeBSD-src-c9c19c9c8410b1dcbd760d5382a6071ed8396652.tar.gz |
MFC 302899: Add documentation for the sigevent structure.
- Add a sigevent(3) manpage to give a general overview of the sigevent
structure and the available notification mechanisms.
- Document that AIO requests contain a nested sigevent structure that can
be used to request completion notification.
- Expand the sigevent details in other manuals to note details such as
the extra values stored in a queued signal's information or in a posted
kevent.
Diffstat (limited to 'lib/libc/sys/aio_write.2')
-rw-r--r-- | lib/libc/sys/aio_write.2 | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/lib/libc/sys/aio_write.2 b/lib/libc/sys/aio_write.2 index 291fd71..076ce50 100644 --- a/lib/libc/sys/aio_write.2 +++ b/lib/libc/sys/aio_write.2 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 2, 1999 +.Dd July 15, 2016 .Dt AIO_WRITE 2 .Os .Sh NAME @@ -85,6 +85,12 @@ If the request is successfully enqueued, the value of .Fa iocb->aio_offset can be modified during the request as context, so this value must not be referenced after the request is enqueued. +.Pp +The +.Fa iocb->aio_sigevent +structure can be used to request notification of the request's +completion as described in +.Xr aio 4 . .Sh RESTRICTIONS The Asynchronous I/O Control Block structure pointed to by .Fa iocb @@ -119,6 +125,10 @@ system call will fail if: .Bl -tag -width Er .It Bq Er EAGAIN The request was not queued because of system resource limitations. +.It Bq Er EINVAL +The asynchronous notification method in +.Fa iocb->aio_sigevent.sigev_notify +is invalid or not supported. .It Bq Er ENOSYS The .Fn aio_write @@ -186,6 +196,7 @@ would be invalid. .Xr aio_return 2 , .Xr aio_suspend 2 , .Xr aio_waitcomplete 2 , +.Xr sigevent 3 , .Xr siginfo 3 , .Xr aio 4 .Sh STANDARDS |