home *** CD-ROM | disk | FTP | other *** search
/ Mega CD-ROM 1 / megacd_rom_1.zip / megacd_rom_1 / DESQVIEW / CMONITOR.ZIP / CMONITOR.DOC < prev    next >
Text File  |  1988-12-09  |  12KB  |  257 lines
  1. ==============================================================================
  2. CMONITOR  --  CarrierMonitor Documentation   Version 1.3     December 7, 1988
  3. ==============================================================================
  4.                 (New material is noted in right margin)                      |
  5.  
  6. PURPOSE.
  7. --------
  8.  
  9. CMONITOR is designed to work with DESQview and communications programs
  10. such as COM-AND, RBBS and other BBS or HOST type programs that have the
  11. capability of allowing a remote user to shell to DOS.  A loss of carrier
  12. under these conditions prevents returning from the shell and logging off
  13. thus effectively locking up the machine.  CMONITOR solves this problem.
  14. Its operation is similar to WATCHDOG, but CMONITOR takes advantage of the
  15. multi-tasking capability of DESQview. CMONITOR monitors the carrier on the
  16. com port being used by the BBS.  If carrier is lost, CMONITOR closes the
  17. DESQview window in which the BBS is running and immediately re-opens the
  18. window, thus restarting the BBS without re-booting and interrupting other
  19. tasks in progress. WATCHDOG causes a warm boot of the computer.  CMONITOR
  20. will work with COM1, COM2, COM3 or COM4 using the standard base addresses
  21. for these ports.
  22.  
  23. INSTALLATION.
  24. -------------
  25.  
  26. CMONITOR must be installed.  The file CMONITOR.ARC contains the following
  27. files:
  28.          CMONITOR.COM ...... the actual carrier monitor
  29.          CMON.COM .......... the CMONITOR loader and un-loader
  30.          CM-PIF.DVP ........ the DESQview PIF for CMONITOR
  31.          CMONITOR.DOC ...... this file
  32.          CMONITOR.ASM ...... the source file less the DVAPI.INC file
  33.          CMON.ASM .......... the source file less the DVAPI.INC file
  34.  
  35. Un-arc the files and copy CM-PIF.DVP to your DESQview sub-directory. Copy
  36. CMONITOR.COM and CMON.COM to whichever sub-directory you want. Suggest you
  37. put then in your DV or BBS sub-directory.
  38.  
  39. With DESQview loaded open an 'Add Program' window, select 'Other', enter
  40. your DV sub-directory and select CMONITOR from the resulting list.  Then
  41. open a 'Change Program' window and enter CM for CMONITOR.  On the
  42. 'Program' line either delete the path preceding CMONITOR.COM or put in the
  43. correct sub-directory.  You will need to edit the 'Parameter' line to
  44. correctly reflect the name and location of your PIF for your BBS program.
  45. The second parameter is the number of the COM port being used by the BBS.
  46. Just enter 1 for COM1 or 2 for COM2 etc. The second parameter must be
  47. separated by one and only one space from the BBS PIF name.  The 'Directory'
  48. entry may be blanked if you included the path in the 'Program' line.
  49. Otherwise put in the correct sub-directory for the location of
  50. CMONITOR.COM.  If you want to change the name of the CMONITOR window from
  51. CM to something else, you may do that.  Don't change any of the other
  52. settings.  Appendix A contains the screens from 'Change Program' for the
  53. CM-PIF.DVP file.
  54.  
  55. You must also make a change to the PIF for your comm program using 'Change
  56. Program.'  On the 'Advanced Options' screen insert an asterisk at the
  57. beginning of the 'Shared Program Pathname' field just as in the PIF for CM
  58. in Appendix A.  Your comm program and CMONITOR will run as shared
  59. programs.  You probably also have your comm program already setup to run
  60. in background, but for CMONITOR to work the comm program must be set to
  61. run in background.  If you are using DESQview 2.2, you need to make sure
  62. the 'Share CPU when foreground' is set to Y.
  63.  
  64. USAGE.
  65. ------
  66.  
  67. CMON is the program that loads and un-loads CMONITOR for the carrier
  68. monitoring task.  The syntax for CMON is:
  69.  
  70.          CMON [d:\path\CM-PIF.DVP | OFF]
  71.  
  72. where [ | ] denotes the two options.  Use the qualified filespec for the
  73. CM PIF for loading CMONITOR and OFF for un-loading it.  RBBS is run from a
  74. batch file.  Users of WATCHDOG will find that there are two entries for
  75. WATCHDOG in the RBBS.BAT file.  Change the entry WATCHDOG OFF to CMON OFF
  76. and change WATCHDOG ON to CMON d:\path\CM-PIF.DVP.  Users of COM-AND may
  77. include the script commands RUN "CMON.COM d:\path\CM-PIF.DVP" and RUN
  78. "CMON.COM OFF" at appropriate points in their scripts.
  79.  
  80. When CMON d:\path\CM-PIF.DVP is executed, if there is a carrier on the com
  81. port specified, it will open the CMONITOR window, display an installed
  82. message, and begin monitoring the carrier. If the carrier is lost on the
  83. com port being monitored, CMONITOR will detect the loss and immediately
  84. close the BBS window.  It will then re-open the BBS window, display a
  85. restart message with time and date, and CMONITOR will exit closing its own
  86. window.
  87.  
  88. The restart message is not of much use unless you want to maintain a log
  89. in a file or on your printer of the restarts.  The output from CMONITOR
  90. may be redirected using the standard DOS technique.  If you want to use
  91. this feature, you will need to make some changes to the CM-PIF.DVP file.
  92. Change 'Memory size' to 30k.  Delete .COM from the 'Program' field.
  93. Change the 'Parameters' field to something like this:
  94.  
  95.          C:\DV\xx-PIF.DVP 1 >>C:\BBS\RESTART.LOG
  96.  
  97. where xx is your comm window.  Of course you can redirect to PRN or any
  98. other file.
  99.  
  100. If the window you are working in when a remote user causes CMONITOR to be
  101. loaded covers the upper left corner of the screen (e.g. full screen) and
  102. is set to run in background, then you only will notice a slight delay as
  103. CMONITOR loads.  You will be returned to the task on which you were
  104. working.  Otherwise you will have to manually switch back to your original
  105. task.
  106.  
  107. The same procedure for returning to the task you were working on when         |
  108. carrier is lost and CMONITOR reloads your comm program is now implemented.    |
  109. For this return procedure to work in both cases you should have an            |
  110. asterisk entered in the 'Shared Program Pathname' field of the PIF for        |
  111. each of the programs you are likely to be in when CMONITOR is active.         |
  112.  
  113. If CMONITOR is not loaded when CMON OFF is executed, nothing will happen.
  114. If CMONITOR is loaded, CMON OFF will close the CMONITOR window.  CMONITOR
  115. is not a TSR so there is no problem with memory allocation in opening and
  116. closing a DESQview window containing CMONITOR.  That is one of the
  117. advantages of multi-tasking systems.
  118.  
  119. You will not need the syntax for CMONITOR since the PIF file is included
  120. here, but for completeness the syntax is:
  121.  
  122.          CMONITOR d:\path\xx-PIF.DVP y
  123.                                     ^only one space
  124.  
  125. where xx is the two character name of your comm program and y is the com
  126. port to be modified (in the range 1..4).  The output from CMONITOR may be
  127. redirected.
  128.  
  129. REQUIREMENTS.
  130. -------------
  131.  
  132. CMONITOR requires DESQview 2.00 or higher.  Neither CMONITOR nor CMON will
  133. execute without DESQview.
  134.  
  135. HOW DOES IT WORK?
  136. -----------------
  137.  
  138. CMONITOR is a good example of using the DESQview Applications Program
  139. Interface for communicating between processes running in different
  140. windows.  The source code is included so that you can get an idea of the
  141. power of the API.  When CMON executes in the load option, it opens the
  142. CMONITOR window and sends CMONITOR a message with the identification of
  143. the comm program window in which CMON is executing.  When CMONITOR is
  144. loaded it reads the message from CMON, loads the PIF for the comm program,
  145. names its mailbox so CMON can find it later, and begins monitoring the
  146. carrier and waiting for a close message from CMON.  The carrier is
  147. monitored by checking bit 7 of the Modem Status Register.  If carrier is
  148. lost, CMONITOR closes the comm program window, reopens it, sends the
  149. restart message and exits itself.  CMON OFF sends a close message to
  150. CMONITOR which is located by looking for the named mailbox belonging to
  151. CMONITOR. When CMONITOR receives the close message, it stops monitoring
  152. and exits.
  153.  
  154. All of this will take place without any impact on other windows that are
  155. open accept for a slight delay while CMONITOR switches to itself and does
  156. the reloading.  You may continue tasks you were working on after the BBS
  157. restarts.  CM runs in background and checks the status of the carrier
  158. during each background timeslice it gets.  CM is very fast and gives up
  159. the remainder of its timeslice once a check has been made.  Of course you
  160. can control this frequency by the 'Performance' ratio specified in the
  161. DESQview SETUP routine.
  162.  
  163.  
  164. xMONITOR SERIES.
  165. ----------------
  166.  
  167. The author intends to write other xMONITOR programs for non-DV
  168. applications that are running in DESQview.  These xMONITOR programs will
  169. provide DESQview capabilities to applications that were not written
  170. specifically to operate in DESQview.  For example I have written FMONITOR
  171. for managing the font changes of the Hercules Graphics Card Plus when used
  172. by programs such as WordPerfect 5.0 in DESQview.
  173.  
  174. COPYRIGHT.
  175. ----------
  176.  
  177. CMONITOR and the xMONITOR series are copyrighted by John Poindexter 1988.
  178. DESQview and the API are copyrighted by Quarterdeck Office Systems.
  179. COM-AND is copyrighted by Caber Software.  RBBS is copyrighted by D.
  180. Thomas Mack.
  181.  
  182. SHAREWARE.
  183. ----------
  184.  
  185. You are encouraged to copy the CMONITOR.ARC file and share it freely
  186. with others.  You have the luxury of trying out the program, at
  187. your own pace and in the comfort of your own home or workplace.  This is
  188. not a crippled or "demo" copy, but the complete working version of the
  189. program.
  190.  
  191. After you have used CMONITOR for a reasonable evaluation period you
  192. should either discontinue use of the program or register your copy by
  193. sending $5.00 to the author as indicated below. Your support is important
  194. and greatly appreciated. With it, Shareware authors are encouraged to
  195. design and distribute new products. Without it, a great deal of high
  196. quality, low cost software will cease to be available.
  197.  
  198. I will be interested in receiving comments about CMONITOR and will
  199. consider making suggested changes to suit users.
  200.  
  201. John Poindexter
  202. 10 Barrington Fare
  203. Rockville, MD 20850
  204.  
  205. SIG004 The SOURCE
  206. December 7, 1988
  207.  
  208. APPENDIX A.
  209. -----------
  210.  
  211. Display screens from DESQview 2.01 'Change Program' for CM-PIF.DVP.
  212.  
  213.                               Change a Program
  214.  
  215. Program Name............: CMONITOR
  216.  
  217. Keys to Use on Open Menu: CM                         Memory Size (in K):   3
  218. ────────────────────────────────────────────────────────────────────────────
  219. Program...: D:\WORK\CMONITOR.COM
  220.  
  221. Parameters: C:\DV\CA-PIF.DVP 1
  222.  
  223. Directory.: D:\WORK
  224. ────────────────────────────────────────────────────────────────────────────
  225. Options:
  226.                     Writes directly to screen......: [N]
  227.                     Displays graphics information..: [N]
  228.                     Can be swapped out of memory...: [N]
  229.                     Requires floppy diskette.......: [N]
  230.  
  231.  Press F1 for advanced options                  Press ┘ when you are DONE
  232.  
  233. ────────────────────────────────────────────────────────────────────────────
  234.                      Change a Program Advanced Options
  235.  
  236. System Memory (in K).......:   0   Maximum Program Memory Size (in K)..:
  237.  
  238. Script Buffer Size.......:     0   Maximum Expanded Memory Size (in K):
  239.  
  240. Text Pages: 1  Graphics Pages: 0   Initial Mode:        Interrupts: 00 to FF
  241. ────────────────────────────────────────────────────────────────────────────
  242. Window Position:
  243.    Maximum Height:  25       Starting Height:   2       Starting Row...:  23
  244.    Maximum Width.:  80       Starting Width.:  60       Starting Column:   1
  245. ────────────────────────────────────────────────────────────────────────────
  246.                                Shared Program
  247. Pathname..: *
  248.  
  249. Data......:
  250. ────────────────────────────────────────────────────────────────────────────
  251. Options:
  252.    Close on exit to DOS.........: [Y]      Uses its own colors.........: [N]
  253.    Allow Close Window command...: [Y]      Runs only in foreground.....: [N]
  254.    Uses math coprocessor........: [N]      Keyboard conflict (0-4).....: [0]
  255.  
  256.  Press F1 for standard options                  Press ┘ when you are DONE
  257.