[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# debug::heartbeat(n) 1.0.1 tcllib "debug narrative"

## Name

debug::heartbeat - debug narrative - heartbeat

## Synopsis

- package require Tcl 8.5
- package require debug::heartbeat ?1.0.1?
- package require debug ?1?

- debug heartbeat ?delta?

## Description

## API

debug heartbeat ?delta?

  This method activates or disables a heartbeat with which to monitor the event loop of an event-based Tcl application.

  It reserves the debug tag heartbeat for its operation and writes a message every delta milliseconds.

  A delta-value <= 0 disables the heartbeat.

  The message produced by the heartbeat contains a sequence counter and the time in milliseconds since the last beat, thus providing insight into timing variationsn and deviations from the nominal delta.

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category debug of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## Keywords

debug, heartbeat, log, narrative, trace

## Category

debugging, tracing, and logging

## Copyright

Copyright © 200?, Colin McCormack, Wub Server Utilities
Copyright © 2012, Andreas Kupries <andreas_kupries@users.sourceforge.net>