Changeset View
Changeset View
Standalone View
Standalone View
head/share/man/man4/aio.4
| Show All 21 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd July 21, 2016 | .Dd June 22, 2017 | ||||
| .Dt AIO 4 | .Dt AIO 4 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm aio | .Nm aio | ||||
| .Nd asynchronous I/O | .Nd asynchronous I/O | ||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| ▲ Show 20 Lines • Show All 117 Lines • ▼ Show 20 Lines | |||||
| .Vt sigevent | .Vt sigevent | ||||
| structure in the | structure in the | ||||
| .Va aio_sigevent | .Va aio_sigevent | ||||
| field which can be used to request notification when an operation completes. | field which can be used to request notification when an operation completes. | ||||
| .Pp | .Pp | ||||
| For | For | ||||
| .Dv SIGEV_KEVENT | .Dv SIGEV_KEVENT | ||||
| notifications, | notifications, | ||||
| the posted kevent will contain: | the | ||||
| .Va sigevent | |||||
| .Ap | |||||
| s | |||||
| .Va sigev_notify_kqueue | |||||
bjk: I'm pretty sure the 's' can go on the same line as the ".Ap", but we try to avoid this… | |||||
| field should contain the descriptor of the kqueue that the event should be attached | |||||
| to, its | |||||
| .Va sigev_notify_kevent_flags | |||||
| field may contain | |||||
| .Dv EV_ONESHOT , | |||||
| .Dv EV_CLEAR , and/or | |||||
| .Dv EV_DISPATCH , and its | |||||
bjkUnsubmitted Not Done Inline ActionsBut here no text should appear on the same line as the .Dv after the comma. bjk: But here no text should appear on the same line as the .Dv after the comma. | |||||
| .Va sigev_notify | |||||
| field should be set to | |||||
| .Dv SIGEV_KEVENT . | |||||
| The posted kevent will contain: | |||||
| .Bl -column ".Va filter" | .Bl -column ".Va filter" | ||||
| .It Sy Member Ta Sy Value | .It Sy Member Ta Sy Value | ||||
| .It Va ident Ta asynchronous I/O control buffer pointer | .It Va ident Ta asynchronous I/O control buffer pointer | ||||
| .It Va filter Ta Dv EVFILT_AIO | .It Va filter Ta Dv EVFILT_AIO | ||||
| .It Va flags Ta Dv EV_EOF | |||||
| .It Va udata Ta | .It Va udata Ta | ||||
| value stored in | value stored in | ||||
| .Va aio_sigevent.sigev_value | .Va aio_sigevent.sigev_value | ||||
| .El | .El | ||||
| .Pp | .Pp | ||||
| For | For | ||||
| .Dv SIGEV_SIGNO | .Dv SIGEV_SIGNO | ||||
| and | and | ||||
| ▲ Show 20 Lines • Show All 45 Lines • Show Last 20 Lines | |||||
I'm pretty sure the 's' can go on the same line as the ".Ap", but we try to avoid this construction in general; something like "the sigev_notify_kqueue field of the sigevent structure" would be a more typical phrasing, I think.