AuScanForTypedEvent(3)

💅 AuScanForTypedEvent(3) — bestie edition

okay so this is a page from the Library Functions Manual, and today's main character is AuScanForTypedEvent — she's a libaudiolib girlie and she's here to find you the event. the one. the specific type. periodt. 💖

✨ NAME ✨

AuScanForTypedEvent — return the first event of a specific type 🎯

🌸 SYNOPSIS 🌸

#include <audio/audiolib.h>

AuBool AuScanForTypedEvent(server, mode, dequeue, type, event)
    AuServer *server;
    int mode;
    AuBool dequeue;
    int type;
    AuEvent *event; /* RETURN */

like. she takes five things and gives you back an AuBool. we love a functional queen 👑

🎀 ARGUMENTS 🎀

• server — the connection to the audio server, bestie. that's your line to the whole operation. 🫶
• mode — how far you're willing to look for a match. it's gotta be one of these constants, no substitutions: AuEventsQueuedAlready, AuEventsQueuedAfterReading, or AuEventsQueuedAfterFlush. ✨
• dequeue — if a matching event gets found, do we yank it out of the queue or not. yes or no, that's the whole vibe. 💅
• type — the type of event you're matching. it should be one of these constants: AuEventTypeElementNotify, AuEventTypeGrabNotify, or AuEventTypeMonitorNotify. pick your fighter. 🔥
• event — returns the matching event if found. that's the prize, the trophy, the return value moment. 👑

💜 DESCRIPTION 💜

okay so AuScanForTypedEvent scans the event queue looking for the first event that matches type. that's the whole job. that's her purpose. she's locked in. 🔍

the mode is what decides how hard she's willing to look, and honestly the way that she escalates?? iconic. let's break it down:

• if mode is AuEventsQueuedAlready, AuScanForTypedEvent only checks for events already in the queue. low effort, lowkey. she's just peeking. 🙈
• if mode is AuEventsQueuedAfterReading, and a matching event isn't found already in the queue, AuScanForTypedEvent attempts to read more events out of the application's connection. she goes and looks for it. main character energy fr fr. 🌈
• if mode is AuEventsQueuedAfterFlush and a matching event isn't already in the queue or isn't waiting to be read, AuScanForTypedEvent flushes the output queue and attempts to read more events out of the application's connection. that's the full send. she flushes the output queue. she reads more. she does not give up. ⭐

and then: if dequeue is AuTrue, and a matching event is found, it is removed from the queue. gone. dequeued. she took it. 💀

🦋 SEE ALSO 🦋

• AuEventsQueued
• AuScanEvents
• AuNextEvent
• audiolib — Network Audio System C Language Interface

and that's the whole page, bestie. 💖 this is all from audiolib, section event handling, version 1.9.4 — go forth and find your event. slay. 🎀✨🫶