xcb_sync_create_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_create_alarm(3) 💖

okay bestie, welcome to the XCB Requests corner of the universe, where we're talking about xcb_sync_create_alarm(3). pull up a chair, grab a boba, and let's get into it ✨

🌸 NAME 🌸

xcb_sync_create_alarm — and that's it. that's the whole name section. just the function name, a dash, and vibes. no description, no nothing. the manpage really said "figure it out" 💀 iconic behaviour honestly.

🦋 SYNOPSIS 🦋

first things first, you gotta pull in the header, no cap:

#include <xcb/sync.h>

✨ Request function ✨

and here's the actual function signature, copy it exactly bestie, don't freestyle:

xcb_void_cookie_t xcb_sync_create_alarm(xcb_connection_t *conn,
       xcb_sync_alarm_t id, uint32_t value_mask, const
       void *value_list);

🎀 REQUEST ARGUMENTS 🎀

  • conn — your XCB connection to X11. the whole lil' bridge to the X server. slay.
  • id — TODO: NOT YET DOCUMENTED. yeah. the manpage literally left this one on read. 🫠
  • value_mask — TODO: NOT YET DOCUMENTED. also left on read. 💀
  • value_list — TODO: NOT YET DOCUMENTED. yep. three for three. the documentation is not giving what it's supposed to gave. 😭
ngl, if you need the real tea on these args, the manpage itself doesn't have it. that's not me being cute, that's genuinely what it says. no cap.

🌈 DESCRIPTION 🌈

so. the DESCRIPTION section... is empty. nothing there. not a single word. it's giving "silent treatment" energy. 💅

we move.

👑 RETURN VALUE 👑

this one returns an xcb_void_cookie_t. and because it's a void cookie, any errors (if there even are any) have to be handled over in the event loop. that's the whole deal.

and hey, if you'd rather handle errors directly instead of waiting around in the event loop, there's xcb_request_check — use xcb_sync_create_alarm_checked for that. see xcb-requests(3) for all the deets. 🫶

💀 ERRORS 💀

okay so this is the good news section:

This request does never generate any errors.

never. zero. none. not a single one. we love a low-maintenance request that doesn't cause drama. 💖

🔥 SEE ALSO 🔥

...bestie, it's blank. the SEE ALSO section has no references. the cross-referencing really said "no thoughts, head empty." 🍓 (well, except for that xcb-requests(3) mention up in RETURN VALUE, which is where the actual pointer lives. iykyk.)

🧚 AUTHOR 🧚

Generated from sync.xml. and if you've got corrections or improvements, hit up xcb@lists.freedesktop.org — they're taking notes, fr fr. ✨

and that's the whole page, bestie! this one's from X Version 11, libxcb 1.17.0, and it's the xcb_sync_create_alarm(3) manual page. go forth and create those alarms, you absolute main character. 💅💜🦋

📦 where this page comes from