xcb_sync_query_alarm(3)

📦
version 1.17.0 · 4 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, debian trixie, fedora 43, fedora 44, nixpkgs unstable, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 xcb_sync_query_alarm — the manual page, but make it make sense 💖

okay bestie, welcome to the xcb_sync_query_alarm(3) page, filed under XCB Requests. Yes it's a 3-section libc-style manual page, yes we're doing this, and yes you're gonna slay it. 🦋

✨ NAME ✨

xcb_sync_query_alarm — (the original literally leaves this blank, so like… it's the request that queries an alarm. That's the vibe. 🙈)

🌸 SYNOPSIS 🌸

First thing's first, you gotta bring the header in:

#include <xcb/sync.h>

🎀 Request function

xcb_sync_query_alarm_cookie_t
       xcb_sync_query_alarm(xcb_connection_t *conn,
       xcb_sync_alarm_t alarm);

🎀 Reply datastructure

typedef struct xcb_sync_query_alarm_reply_t {
    uint8_t            response_type;
    uint8_t            pad0;
    uint16_t           sequence;
    uint32_t           length;
    xcb_sync_trigger_t trigger;
    xcb_sync_int64_t   delta;
    uint8_t            events;
    uint8_t            state;
    uint8_t            pad1[2];
} xcb_sync_query_alarm_reply_t;

🎀 Reply function

xcb_sync_query_alarm_reply_t
       *xcb_sync_query_alarm_reply(xcb_connection_t *conn,
       xcb_sync_query_alarm_cookie_t cookie, xcb_generic_error_t **e);

🫶 REQUEST ARGUMENTS 🫶

  • conn — your XCB connection to X11. the whole reason you're here tbh 💅
  • alarm — TODO: NOT YET DOCUMENTED. yeah bestie, the docs just… didn't. iconic of them, honestly. 😭

👑 REPLY FIELDS 👑

  • response_type — the type of this reply, and in this case it's XCB_SYNC_QUERY_ALARM. This field also lives in the xcb_generic_reply_t, so you can use it to tell replies apart from each other. she's the ID check at the door. ✨
  • sequence — the sequence number of the last request processed by the X11 server. lowkey the timeline tracker. ⭐
  • length — how long the reply is, measured in words. and no, not vibes — a word here is 4 bytes. fr fr. 📏
  • trigger — TODO: NOT YET DOCUMENTED. 💀
  • delta — TODO: NOT YET DOCUMENTED. 💀
  • events — TODO: NOT YET DOCUMENTED. 💀
  • state — TODO: NOT YET DOCUMENTED. 💀

🌈 DESCRIPTION 🌈

(empty. the original page just… has the heading and then nothing. it's giving "no thoughts, head empty" but make it documentation. 🧚)

⭐ RETURN VALUE ⭐

You get back an xcb_sync_query_alarm_cookie_t. 🍪 Errors? You gotta handle those when you call the reply function, xcb_sync_query_alarm_reply.

But wait — if you'd rather handle errors in the event loop instead, use xcb_sync_query_alarm_unchecked. See xcb-requests(3) for the details. pick your fighter, bestie. 🔥

💅 ERRORS 💅

This request does never generate any errors. not one. zero. a clean queen. 👑

🦋 SEE ALSO 🦋

(blank in the original — nothing listed, so nothing to list. the silence is the message. 🙈)

💜 AUTHOR 💜

Generated from sync.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. they're literally asking for your notes, so send them if you got them. 🫶

ok and that's the whole page, bestie. every flag, field, signature, TODO: NOT YET DOCUMENTED., and #include line is still here — the facts did not change, only the attitude. 💖

and finally, the cute sign-off: this one comes from X Version 11, shipped with libxcb 1.17.0, in the manual page xcb_sync_query_alarm(3). periodt. ✨🎀🌈

📦 where this page comes from