aio_cancel (2)

Leading comments

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 othe...

(The comments found at the beginning of the groff file "man2/aio_cancel.2freebsd".)

NAME

aio_cancel - cancel an outstanding asynchronous I/O operation (REALTIME)

LIBRARY

Lb libc

SYNOPSIS

In aio.h Ft int Fn aio_cancel int fildes struct aiocb *iocb

DESCRIPTION

The Fn aio_cancel system call cancels the outstanding asynchronous I/O request for the file descriptor specified in Fa fildes . If Fa iocb is specified, only that specific asynchronous I/O request is cancelled.

Normal asynchronous notification occurs for cancelled requests. Requests complete with an error result of Er ECANCELED .

RESTRICTIONS

The Fn aio_cancel system call does not cancel asynchronous I/O requests for raw disk devices. The Fn aio_cancel system call will always return AIO_NOTCANCELED for file descriptors associated with raw disk devices.

RETURN VALUES

The Fn aio_cancel system call returns -1 to indicate an error, or one of the following:

Bq AIO_CANCELED

All outstanding requests meeting the criteria specified were cancelled.

Bq AIO_NOTCANCELED

Some requests were not cancelled, status for the requests should be checked with aio_error2.

Bq AIO_ALLDONE

All of the requests meeting the criteria have finished.

ERRORS

An error return from Fn aio_cancel indicates:

Bq Er EBADF

The Fa fildes argument is an invalid file descriptor.

SEE ALSO

aio_error2, aio_read2, aio_return2, aio_suspend2, aio_write2, aio(4)

STANDARDS

The Fn aio_cancel system call is expected to conform to the St -p1003.1 standard.

HISTORY

The Fn aio_cancel system call first appeared in Fx 3.0 . The first functional implementation of Fn aio_cancel appeared in Fx 4.0 .

AUTHORS

An -nosplit This manual page was originally written by An Wes Peters Aq wes@softweyr.com . An Christopher M Sedore Aq cmsedore@maxwell.syr.edu updated it when Fn aio_cancel was implemented for Fx 4.0 .