diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-15 09:54:10 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-15 09:54:10 -0500 |
| commit | e49a36cb0b37cc3ad1c3f191fb439b17f6365539 (patch) | |
| tree | 1c39de36e4c7a90413f55288ed86d076cef1afbf /cpukit/posix/include/aio.h | |
| parent | libcsupport: Update file header for termios.h to remove link, add description. (diff) | |
| download | rtems-e49a36cb0b37cc3ad1c3f191fb439b17f6365539.tar.bz2 | |
posix: Doxygen Enhancement Task #5
http://www.google-melange.com/gci/task/view/google/gci2012/7959229
Diffstat (limited to 'cpukit/posix/include/aio.h')
| -rw-r--r-- | cpukit/posix/include/aio.h | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h index de0bdd5603..f4f824ab69 100644 --- a/cpukit/posix/include/aio.h +++ b/cpukit/posix/include/aio.h @@ -23,6 +23,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_AIO POSIX Asynchronous I/O Support + * + * @ingroup POSIX + * + * @brief POSIX Asynchronous Input and Output + */ + #if defined(_POSIX_ASYNCHRONOUS_IO) /* @@ -126,10 +134,18 @@ ssize_t aio_return( const struct aiocb *aiocbp ); -/* +/** + * @brief Cancel Asynchronous I/O Operation + * * 6.7.7 Cancel Asynchronous I/O Operation, P1003.1b-1993, p. 163 + * + * @param[in] filedes is the file descriptor + * @param[in] aiocbp is the asynchronous I/O control block + * + * @return This method returns AIO_CANCELED if the requested operation(s) + * were canceled. Otherwise, AIO_NOTCANCELED is returned indicating + * that at least one of the requested operation(s) cannot be canceled */ - int aio_cancel( int filedes, struct aiocb *aiocbp |