AIO_SUSPEND(3P)

💖 AIO_SUSPEND(3P) — POSIX Programmer's Manual 💖

okay bestie, before we even start — this page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (so like, go check the corresponding Linux manual page for the deets on Linux behavior), or honestly the interface might not even be implemented on Linux at all. 🙈 Not us being dramatic, it's just true.

---

✨ PROLOG ✨

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ — consult the corresponding Linux manual page for details on Linux behavior — or the interface may not be implemented on Linux.

---

🌸 NAME 🌸

aio_suspend — wait for an asynchronous I/O request

Like... yes, that's literally the whole vibe. You're waiting. Patiently. Main character energy but make it blocking. 💅

---

🦋 SYNOPSIS 🦋

#include <aio.h>

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

---

👑 DESCRIPTION 👑

So here's the tea. 🍓

The aio_suspend() function shall suspend the calling thread until one of these three things happens:

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

And listen — if any of the aiocb structures in the list already correspond to completed asynchronous I/O operations (that is, the error status for the operation is not equal to [EINPROGRESS]) at the time of the call, the function shall return without suspending the calling thread. No waiting. It said "not today." 💀

Now let's break down the args, bestie:

• The list argument is an array of pointers to asynchronous I/O control blocks.
• The nent argument indicates 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, which are ignored. 🫶 Chill. They're just vibing.

But 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 cute look. Don't do that.

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. 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. ⏰✨

---

🌈 RETURN VALUE 🌈

Two moods:

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

And here's a lil tip for you — the application may determine which asynchronous I/O completed by scanning the associated error and return status using aio_error() and aio_return(), respectively. iykyk. 💜

---

💅 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. Basically it timed out. Nothing happened. Awkward. 🙈
• EINTR — A signal interrupted the aio_suspend() function. And note this, because it's kinda iconic: 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. Plot twist. 🔥

The following sections are informative.

---

🎀 EXAMPLES 🎀

None. Yeah bestie, nothing here. We move. 💨

---

🧚 APPLICATION USAGE 🧚

None. Still nothing. 😌

---

⭐ RATIONALE ⭐

None. The void is voiding. 💀

---

🦄 FUTURE DIRECTIONS 🦄

None. Crystal ball says... nothing. ✨

---

💖 SEE ALSO 💖

• aio_read()
• aio_write()
• lio_listio()

The Base Definitions volume of POSIX.1‐2017, <aio.h>

---

📜 COPYRIGHT 📜

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 .

---

okay that's the whole page, no cap. 🫶 This little masterpiece comes to you courtesy of IEEE/The Open Group, dated 2017 — and that's the sign-off, bestie. Go wait on some async I/O. You've got this. 💖✨🎀