Function:     eventmonitor

Purpose:      Monitoring utility for debugging event-driven tasks.

Category:     SYSTEM

File:         eventmonitor.c

Author:       J.P. Terlouw

Use:          #include "eventmonitor.h"
              bool state, newstate;
              char *key;

              state = eventmonitor(key, newstate);

Description:  eventmonitor() allows the programmer to switch the monitoring
              utility on and off, or specify a keyword which can be used
              to switch the utility interactively.

              If switched on, eventmonitor() outputs all Hermes-generated
              events to the screen and the logfile.

              There are two modes of operation:

              1. key is a user input keyword.
                 Associate or disassociate keyword with the monitor.
                 newstate == TRUE: associate;
                 newstate == FALSE: disassociate.
                 When a keyword is associated with the monitor, monitoring
                 can be switched by the user. "YES" switches on, "NO"
                 switches off.

              2. key == NULL.
                 In this case the monitor is switched directly:
                 newstate == TRUE switches on;
                 newstate == FALSE switches off.

              In both cases the current monitoring state is returned.

Related Docs: events.dc3, ScheduleRead.dc3, ScheduleWrite.dc3,
              ScheduleTimer.dc3, DescheduleAll.dc3, MainLoop.dc2, AttachXt.dc2.

Updates:      Mar 17, 1999: JPT, Document created.