AuErrorEvent(3)

💖 AuErrorEvent — bestie, it's giving "error event structure" ✨

okay so real talk, this is a page from the audiolib manual (that's the Library Functions Manual, section 3, iykyk), and it's all about AuErrorEvent. it's short, it's sweet, it's iconic, and yes we're reading the whole thing together. grab a snack 🍓

🌸 Structures 🌸

first up, the vibes. you get it by including this:

#include <audio/audiolib.h>

and here's the union AuEvent, where our girl auerror is just chilling in the middle of the friend group:

typedef union _AuEvent
{
    . . .
    AuErrorEvent auerror;
    . . .
}AuEvent;

and then the struct itself, the main character 👑

typedef struct _AuErrorEvent
{
    int type;
    AuUint32 serial;
    AuBool send_event;
    AuServer *server;
    AuTime time;
    AuID resourceid;
    unsigned char error_code;
    unsigned char request_code;
    unsigned char minor_code;
    union
    {
        AuUint32 l[4];
    }data;
}AuErrorEvent;

✨ Members ✨

every single field, no skipping, no cap:

• type — the event type. error events are type 0. that's the whole personality.
• serial — the serial number of the failed request. like a little receipt for the L that was taken 💀
• send_event — AuTrue if the event came from a SendEvent protocol request.
• server — the connection to the audio server that the event was read from. your link to the mothership 🛸
• time — the server time in milliseconds when the event was generated. timestamped, fr fr ⏰
• resourceid — the resource ID or other value of the failed request.
• error_code — the error code of the failed request.
• request_code — the protocol major request code of the failed request.
• minor_code — the protocol minor request code of the failed request.
• data — Never used? 🙈 that's it, that's the whole description. the manual itself is like "idk bestie". we respect the honesty.

🦋 Description 🦋

error events are sent to clients to alert them of non-fatal errors encountered while processing requests. so like — not a full meltdown, just a lil "hey, that one didn't work, but we're fine". a gentle heads up. a soft launch of bad news 🫶

🌈 See Also 🌈

go read these next, bestie, they're all in the same universe:

• AuAnyEvent
• AuElementNotifyEvent
• AuGrabNotifyEvent
• AuMonitorNotifyEvent

and also audiolib — the Network Audio System C Language Interface. the whole saga. the cinematic universe. 🔥

and that's the page!! 💅 this was audiolib - events, version 1.9.4, dated 1.9.4 (yeah they put it twice, and honestly? consistency queen 👑), from the AuErrorEvent(3) era. stan a well-documented error struct. periodt ✨🎀