TICKIT_TER...MEOUT_MSEC(3)

💖 TICKIT_TER...MEOUT_MSEC(3) 💖

okay bestie, so this one lives in the Library Functions Manual and it's a <pink>tickit</pink> thing — the terminal library, yk? it's called tickit_term_input_check_timeout_msec and it's literally the girl who keeps track of time for your terminal input. no cap.

✨ NAME ✨

tickit_term_input_check_timeout_msec — terminal timeout behaviour 🌸

🦋 SYNOPSIS 🦋

#include <tickit.h>

int tickit_term_input_check_timeout_msec(TickitTerm *tt);

Link with -ltickit.

💅 DESCRIPTION 💅

okay so tickit_term_input_check_timeout_msec() does the input-related timeout behaviour — the stuff that handles multi-byte input events, the Escape key (yes queen, Escape is complicated, she's not like other keys), and other things. iykyk. 🔥

the way it works is: it returns a value telling you how many milliseconds of delay it wants before you call it again. so like, "hey bestie, give me this many ms and then come back to me, mwah." 💖

when you do call it again, it may perform any timeout behaviours that are required, and then it either hands you another timeout delay or a -1, which means there is no longer a need for timeout. periodt. ✨

heads up: calling it may result in TICKIT_EV_KEY events. so like, events can just show up. that's the vibe check.

also, this function invokes deferred TICKIT_EV_RESIZE events if they're enabled by tickit_term_observe_sigwinch(3). lowkey multitasking icon. 👑

🎀 RETURN VALUE 🎀

tickit_term_input_check_timeout_msec() returns a number indicating a timeout delay in milliseconds. that's it, that's the tea. 🍓

🌈 SEE ALSO 🌈

• tickit_term_build(3)
• tickit_term_input_push_bytes(3)
• tickit_term_bind_event(3)
• tickit_term(7)
• tickit(7)

and that's the whole page, bestie!! 💜 this was the TICKIT_TER...MEOUT_MSEC(3) girl from the Library Functions Manual, doing her little timeout dance so your terminal input stays iconic. go read the tickit pages next, they're all in the same fam. mwah 🫶✨🧚