home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / misc~1 / 123 / stcitdoc.arc / EVENTS.DOC < prev    next >
Encoding:
Text File  |  1987-09-09  |  1.8 KB  |  51 lines
  1. EVENTS.DOC
  2.  
  3.             STadel event handling.
  4.  
  5.     Since I ported citadel, there has been a lot of interest in
  6. supporting network interfaces to Fido, UUCP, Arpanet, and a whole
  7. raft of other networks. Now, if I put all that code into STadel, it
  8. would become a huge waddling monster -- but I have some interest in
  9. connecting to the outside world, so I developed this scheme to
  10. replace the current citadel hardwired event code.
  11.  
  12.  
  13.     HOW IT WORKS:
  14.  
  15.     I have identified 3 major types of events -- there are NETWORK
  16. events, which trigger the citadel networker, TIMEOUT events, which
  17. don't bump people off the system, and PREEMPTIVE events, which bump
  18. people off the system.
  19.  
  20.     To add an event to the system, you can use the normal citadel
  21. timeout & network #defines in CTDLCNFG.SYS, or you can use the (new)
  22. #event command:
  23.  
  24.      #event <type> <time> <duration> <name> <flags>
  25.  
  26.     The event type can be TIMEOUT, NETWORK, or PREEMPTIVE, which do
  27. what you'd expect. The time is in HH:MM, 0..23 hours, the duration
  28. is how many minutes this event is expected to last, the name is a
  29. single word name of the event, and the flags are the return code for
  30. a TIMEOUT or PREEMPTIVE event, and are reserved for future use with
  31. the NETWORK -- you must supply that field, however, if you are doing
  32. a network event.
  33.  
  34.     Here's a sample:
  35.  
  36.     #event PREEMPTIVE 5:40 20 fido-net 20
  37.  
  38.     This means that every morning at 5:40, citadel will exit with
  39. return code 20 so that 'fido-net' can run.
  40.  
  41.  
  42.     BUGS AND FEATURES:
  43.  
  44.     It is possible for somebody to stay logged in through a timeout
  45. event and into a preemptive event without the system realizing it,
  46. with hilarious consequences.
  47.  
  48.     An event can return any* condition code, including those codes
  49. reserved for citadel (0 through 3.) Beware, you may get odd results
  50. if you use one of those...
  51.