AIO_ERROR(3POSIX)

📦 version 2017a, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 AIO_ERROR(3POSIX) 💖

okay so bestie, welcome to the POSIX Programmer's Manual 💅 this one's aio_error from section 3POSIX, and it's genuinely one of the cutest little calls in the async I/O family. let's get into it 🦋

🌸 PROLOG 🌸

so like, real talk first: this manual page is part of the POSIX Programmer's Manual. the Linux implementation of this interface may differ (so if you're on Linux, pls go consult the corresponding Linux manual page for the deets on Linux behavior), or honestly the interface may not even be implemented on Linux at all. no cap. 😭

✨ NAME ✨

aio_error — retrieve errors status for an asynchronous I/O operation

🎀 SYNOPSIS 🎀

#include <aio.h>

int aio_error(const struct aiocb *aiocbp);

💫 DESCRIPTION 💫

so here's the vibe: the aio_error() function shall return the error status associated with the aiocb structure referenced by the aiocbp argument. 🫶

and what even is the error status for an async I/O operation, you ask? it's the errno value that would be set by the corresponding read(), write(), fdatasync(), or fsync() operation. like, it's literally the same energy, just delivered async. if the operation has not yet completed, then the error status shall be equal to [EINPROGRESS]. ⏳

⚠️ okay and this part is important: if the aiocb structure pointed to by aiocbp is not associated with an operation that has been scheduled, the results are undefined. undefined behavior is not a slay, it's a 💀. don't do it.

🔥 RETURN VALUE 🔥

  • if the asynchronous I/O operation has completed successfully → 0 shall be returned. we love a clean zero. ✨
  • if the asynchronous operation has completed unsuccessfully → the error status shall be returned, as described for read(), write(), fdatasync(), and fsync(). 😭
  • if the asynchronous I/O operation has not yet completed → [EINPROGRESS] shall be returned. she's still cooking 🍓

and if the aio_error() function itself fails, it shall return -1 and set errno to indicate the error. classic.

🌈 ERRORS 🌈

the aio_error() function may fail if:

  • EINVAL — the aiocbp argument does not refer to an asynchronous operation whose return status has not yet been retrieved.

and that's it, that's the whole list, she's a short queen 👑

the following sections are informative. (iykyk, informative means it's not the normative rules, it's the ✨ lore ✨)

🧚 EXAMPLES 🧚

None.

like literally none. iconic minimalism. 💅

🌸 APPLICATION USAGE 🌸

None.

💜 RATIONALE 💜

None.

🦋 FUTURE DIRECTIONS 🦋

None.

⭐ SEE ALSO ⭐

aio_cancel(), aio_fsync(), aio_read(), aio_return(), aio_write(), close(), exec, exit(), fork(), lio_listio(), lseek(), read()

and the Base Definitions volume of POSIX.1‐2017, <aio.h> 📚

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

and that's the whole page bestie!! 🫶 this one came to you courtesy of IEEE/The Open Group, dated 2017, and it lives in the 3POSIX manual. go forth and check your async errors, main character 💖✨

📦 where this page comes from