AIO_SUSPEND(3POSIX)

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

💤 AIO_SUSPEND(3POSIX) 💤

okay bestie, so this is a page from the POSIX Programmer's Manual — the POSIX Programmer's Manual, if we're being official about it. Pull up a chair (or a beanbag, no judgement) 🫶

🌸 PROLOG 🌸

Real talk before we even start: 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, go peek at the corresponding Linux manual page for the actual tea ☕. Or, plot twist, the interface may not be implemented on Linux at all. It's giving "check your distro first, babe" 💅

✨ NAME ✨

aio_suspend — wait for an asynchronous I/O request 🕰️

Like, you're just gonna sit there until your async I/O finishes. Main character energy: patiently waiting, glowing, unbothered.

🎀 SYNOPSIS 🎀

#include <aio.h>

int aio_suspend(const struct aiocb *const list[], int nent,
    const struct timespec *timeout);

💖 DESCRIPTION 💖

okay so here's the vibe. aio_suspend() suspends the calling thread until one of these three things happens:

  • at least one of the asynchronous I/O operations referenced by the list argument has completed ✅
  • a signal interrupts the function 📣
  • or, if timeout is not NULL, until the time interval specified by timeout has passed ⏳

But wait, there's more 🍓 — if any of the aiocb structures in the list correspond to completed asynchronous I/O operations (meaning the error status for the operation is not equal to [EINPROGRESS]) at the time of the call, the function just returns without suspending the calling thread at all. No napping, no waiting, straight back to you. Slay.

Now, the details:

  • list is an array of pointers to asynchronous I/O control blocks.
  • nent tells you the number of elements in the array.
  • Each aiocb structure pointed to has been used in initiating an asynchronous I/O request via aio_read(), aio_write(), or lio_listio().
  • This array may contain null pointers — those are ignored, they're just there, minding their own business 🙈
  • If this array contains pointers that refer to aiocb structures that have not been used in submitting asynchronous I/O, the effect is undefined. ⚠️ Not a vibe. Don't do it.

And if the time interval indicated in the timespec structure pointed to by timeout passes before any of the I/O operations referenced by list are completed, then aio_suspend() shall return with an error. Rude, but okay.

Oh and — if the Monotonic Clock option is supported, the clock that shall be used to measure this time interval shall be the CLOCK_MONOTONIC clock. Clock nerdery, we love to see it 🕰️✨

🔥 RETURN VALUE 🔥

  • If aio_suspend() returns after one or more asynchronous I/O operations have completed, the function shall return zero. 🎉
  • Otherwise, the function shall return a value of -1 and set errno to indicate the error. 💀

And here's the cute part: the application may determine which asynchronous I/O completed by scanning the associated error and return status using aio_error() and aio_return(), respectively. Detective mode 🕵️♀️

😭 ERRORS 😭

The aio_suspend() function shall fail if:

  • EAGAIN — No asynchronous I/O indicated in the list referenced by list completed in the time interval indicated by timeout. Nothing happened. Silence. Crickets. 🦗
  • EINTR — A signal interrupted the aio_suspend() function. And here's the plot twist, bestie: since each asynchronous I/O operation may possibly provoke a signal when it completes, this error return may be caused by the completion of one (or more) of the very I/O operations being awaited. The thing you're waiting for woke you up. Iconic behaviour, honestly. 🔔

The following sections are informative. (iykyk)

🙈 EXAMPLES 🙈

None.

(yeah. nothing. not a single one. we're on our own out here 😭)

💅 APPLICATION USAGE 💅

None.

🧚 RATIONALE 🧚

None.

🌈 FUTURE DIRECTIONS 🌈

None.

🫶 SEE ALSO 🫶

  • aio_read()
  • aio_write()
  • lio_listio()
  • 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. (they said it, not me — the original is the final boss 👑) 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 came to you courtesy of IEEE/The Open Group, 2017, filed under AIO_SUSPEND(3POSIX) — go forth and await your async I/O with grace, no cap 🦋✨

📦 where this page comes from