debug::heartbeat(n)

💖 debug::heartbeat — the manual, but make it make sense 💖

okay bestie, so this is debug::heartbeat(n) — it lives in the debug narrative corner of the Tcllib world, and it's genuinely one of those tiny tools that's lowkey iconic once you get it. no cap. let's go 🫶

---

✨ NAME ✨

debug::heartbeat — debug narrative — heartbeat

like... it's a heartbeat. for your debug narrative. the name ate and left no crumbs 💅

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require debug::heartbeat ?1.0.2?

package require debug ?1?

debug heartbeat ?delta?

that's it. that's the whole vibe check ✨

---

🦋 DESCRIPTION 🦋

🎀 API 🎀

• debug heartbeat ?delta? — this is the method, and what it does is turn a heartbeat on or off, so you can keep an eye on the event loop of an event-based Tcl application. basically you're giving your app a little pulse check, and honestly? main character energy 🔥

it reserves the debug tag heartbeat all for itself, so that tag is taken, okay? no sharing. it's booked. and then it writes a message every delta milliseconds. tick... tick... tick... 🫀

if your delta value is <= 0, the heartbeat gets disabled. like, off. gone. no beat. 💀

the message the heartbeat spits out contains a sequence counter plus the time in milliseconds since the last beat. which is genuinely so useful, because it gives you insight into timing variations and deviations from the nominal delta. iykyk — that's how you catch your event loop being messy 🙈

---

😭 BUGS, IDEAS, FEEDBACK 😭

ngl, this document — and the package it describes — will undoubtedly contain bugs and other problems. it's software, bestie, it's giving "we tried our best" 💀

please report them in the category debug of the Tcllib Trackers:

http://core.tcl.tk/tcllib/reportlist

and fr fr, if you have ideas for enhancements for either the package and/or the documentation, please report those too. we want them. we love them. send them 🫶

when you're proposing code changes, please provide unified diffs, i.e. the output of diff -u. that's the format, that's the assignment, periodt.

also note, and this is important: attachments are strongly preferred over inlined patches. to make an attachment, go to the Edit form of the ticket right after you create it, and then use the left-most button in the secondary navigation bar. yes, it's a little quest, but you got this 🌈

---

👑 KEYWORDS 👑

debug, heartbeat, log, narrative, trace

---

🌈 CATEGORY 🌈

debugging, tracing, and logging

---

💜 COPYRIGHT 💜

Copyright (c) 200?, Colin McCormack, Wub Server Utilities

Copyright (c) 2012, Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

okay that's the whole page, bestie!! this one's from tcllib, version 1.0.2, and it's the debug::heartbeat(n) manual page — section n, in case you were wondering. go make your event loop behave 💅✨💖