home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR9 / WIZTOO.ZIP / ROSWIZ.MAN < prev    next >
Text File  |  1993-09-23  |  3KB  |  93 lines
  1.                                                           September 20, 1993
  2.                                                           Fairfield, Iowa
  3.  
  4.                 Roster Wizard User's Manual
  5.  
  6. INSTALLATION:
  7.  
  8. The Roster Wizard is distributed in a compressed file, WIZTOOLS.ZIP
  9. Use PKWARE's PKUNZIP to extract the contents of this file as follows:
  10.  
  11. c:\WIZTOOLS>PKUNZIP -d WIZTOOLS.ZIP
  12.  
  13. NOTE: The "-d" option creates two subdirectories,  ".\ROSWIZ" and
  14.       ".\ROSWIZ\EXAMPLE"
  15.  
  16.  
  17. ROSTER CHANNEL THEORY:
  18.  
  19. A Roster provides a list of servers available to clients.  Clients use
  20. functions First and Next to scan through the list of servers calling
  21. each one.
  22.  
  23. Servers use functions Connect and Disconnect make themselves available
  24. to clients.
  25.  
  26. See the example to get a better understanding of this concept.
  27.  
  28.  
  29. ROSTER WIZARD USE:
  30.  
  31. The Roster Wizard comes bundled with two static source code files:
  32.  
  33.     1) CHANNEL.H
  34.     2) CHANNEL.CPP  -- Implements a channel list used by REGISTER.CPP
  35.  
  36. The Roster Wizard reads a channel specification file and generates
  37. four files:
  38.  
  39.     1) CHNNLDEF.H   -- Declares each channel specified as a class.
  40.     2) ROSTER.H     -- Declares class Roster which includes methods
  41.                        for each roster channel.
  42.     3) ROSTER.CPP   -- Defines the class Roster's methods.
  43.     4) APP.CPP      -- Code templates available for a programmer to use
  44.                        writing broadcast channel client and servers.
  45.  
  46.  
  47. Usage: >ROSWIZ <specification file name>
  48.  
  49. Each Roster Channel is specified as a C++ function prototype in the
  50. channel specification file.  An entry in this file has the following format:
  51.  
  52. <roster server function prototype> [default return value] {max receivers};
  53.  
  54. where: "[default return value]" is optional; it defaults to 0.
  55.        "{max receivers}" is optional; it defaults to 10.  No more the
  56.        "max receivers" can be connected to any one channel at a time.
  57.  
  58. IMPORTANT: The function prototype used to declare a server
  59.            must include argument type specifiers AND argument names.
  60.            
  61. There can be up to 200 entries in the specification file.
  62.  
  63. Build your project with output files REGISTER.CPP and static file CHANNEL.CPP
  64. Include files CHNNLDEF.H and REGISTER.H when writing client/server modules.
  65.  
  66. EXAMPLE:
  67.  
  68. If you unzipped the distribution file with the "-d" option then an example
  69. subdirectory ".\ROSWIZ\EXAMPLE" was created.  Read file "README.TXT" in this
  70. subdirectory for an explanation of the example.
  71.  
  72.  
  73. SOURCE CODE:
  74.  
  75. If you unzipped the distribution file with the "-d" option then the Roster 
  76. Wizard's source code was stored in subdirectory ".\ROSWIZ"   The Wizard's 
  77. source code is supplied because you may want to modify this program to satisfy 
  78. your personal coding style. Read file "ROSWIZ.TXT" in subdirectory ".\ROSWIZ" 
  79. for a description of the design of the Wizard program. 
  80.  
  81.  
  82. SUPPORT:
  83.  
  84. For more information, contact:
  85.  
  86. Rob Buck
  87. The Aerosoft Company
  88. 51 N. Cromwell
  89. Fairfield, IA  52556
  90. (515) 472-7586
  91. CompuServe: 72260,3551
  92.  
  93.