home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / comms / newsflash / !NewsFlash / Docs / Messages < prev    next >
Text File  |  1995-07-15  |  5KB  |  270 lines
  1. Last update: 7/5/95
  2.  
  3. NewsFlash Wimp Messages (for doors generally)
  4.  
  5. NewsFlash Message Code 1 : &BFFC0
  6.  
  7. Message format:
  8.  
  9. 0    : Block length
  10. 4    : NewsFlash's (module) task handle
  11. 8    : my_ref
  12. 12   : your_ref
  13. 16   : &BFFC0
  14. 20   : NewsFlash Message Code
  15. 24   : Task handle of original sender (0 if NewsFlash module)
  16. 28   : Line number from 0 (-1 if N/A)
  17. 32   : Message data
  18.  
  19. NewsFlash Message Code 2 : &BFFC1
  20.  
  21. Message format:
  22.  
  23. 0    : Block length
  24. 4    : Task handle of original sender
  25. 8    : my_ref
  26. 12   : your_ref
  27. 16   : &BFFC1
  28. 20   : NewsFlash Message Code
  29. 24   : Reserved (should be 0)
  30. 28   : Line number from 0 (-1 if N/A)
  31. 32   : Message data
  32.  
  33. Message types:
  34.  
  35. Door only  - This message is sent only to the door (if any) that has claimed
  36. the line in question.
  37.  
  38. All tasks  - This message is sent to all wimp tasks.
  39.  
  40. From Tasks - This message is sent from a task to NewsFlash
  41.  
  42. Messages:
  43.  
  44. -----------------------------------------------
  45.  
  46. NewsFlash_Quit                  Code : 0
  47.  
  48. Type : Door only
  49.  
  50. You must release the line (and quit?).
  51.  
  52. -----------------------------------------------
  53.  
  54. NewsFlash_IncommingMessage      Code : 1
  55.  
  56. Type : Door only
  57.  
  58. A message has been sent by another program or the sysop. You should display
  59. it somehow.
  60.  
  61. Block + 32 = 0 if sent by sysop.
  62.            = 1 if sent by NewsFlash main app
  63.            = 2 if sent by another program
  64. Block + 36 = Null terminated message string.
  65.  
  66. -----------------------------------------------
  67.  
  68. NewsFlash_StartDoor             Code : 2
  69.  
  70. Type : All tasks
  71.  
  72. A command in the script file has signalled that a door has been requested to
  73. 'start'.
  74.  
  75. Block + 32 = 0 if text ID
  76.            = 1 if numeric ID
  77. Block + 36 = Door ID
  78.  
  79. -----------------------------------------------
  80.  
  81. NewsFlash_CarrierLost           Code : 3
  82.  
  83. Type : Door only
  84.  
  85. The user has hungup or the main BB has quit. You should quit and not release
  86. the line if you have claimed it.
  87.  
  88. -----------------------------------------------
  89.  
  90. NewsFlash_User                  Code : 4
  91.  
  92. Type : All tasks
  93.  
  94. Allows user messages
  95.  
  96. Block + 32 = User code
  97. Block + 36 = Data
  98.  
  99. Current user codes:
  100.  
  101. 0 - Battleships door message
  102.  
  103. -----------------------------------------------
  104.  
  105. NewsFlash_Incomming             Code : 5
  106.  
  107. Type : All tasks
  108.  
  109. NewsFlash has answered an incomming call 
  110.  
  111. Block + 32 = Baud rate
  112.  
  113. -----------------------------------------------
  114.  
  115. NewsFlash_Logon                 Code : 6
  116.  
  117. Type : All tasks
  118.  
  119. A user has logged on.
  120.  
  121. Block + 32 = Baud rate
  122. Block + 36 = User number
  123. Block + 40 = Null terminated user name
  124.  
  125. -----------------------------------------------
  126.  
  127. NewsFlash_Logoff                Code : 7
  128.  
  129. Type : All tasks
  130.  
  131. A user has hung up or logged off
  132.  
  133. -----------------------------------------------
  134.  
  135. NewsFlash_Starting              Code : 8
  136.  
  137. Type : All tasks
  138.  
  139. NewsFlash has just been loaded.
  140.  
  141. -----------------------------------------------
  142.  
  143. NewsFlash_Dying                 Code : 9
  144.  
  145. Type : All tasks
  146.  
  147. NewsFlash is being quit.
  148.  
  149. -----------------------------------------------
  150.  
  151. NewsFlash_SysopChatRequest      Code : 10
  152.  
  153. Type : All tasks
  154.  
  155. A user has requested a chat with the sysop.
  156.  
  157. Block + 32 = User number
  158. Block + 36 = Topic
  159.  
  160. -----------------------------------------------
  161.  
  162. NewsFlash_StartSysopChat        Code : 11
  163.  
  164. Type : All tasks
  165.  
  166. This call is sent after the chat request has been acknowledged. It should be
  167. acknoledged within 10 wimp polls or NF will timeout and continue with the
  168. script.
  169.  
  170. -----------------------------------------------
  171.  
  172. NewsFlash_ForceLogon            Code : 12
  173.  
  174. Type : From Tasks
  175.  
  176. This call is sent to NewsFlash to force a logon without having to wait for a
  177. connect code.
  178.  
  179. Block + 32 = Connect speed
  180.  
  181. -----------------------------------------------
  182.  
  183. NewsFlash_ForceLogoff           Code : 13
  184.  
  185. Type : From Tasks
  186.  
  187. This call forces NewsFlash to disconnect a user. 
  188.  
  189. -----------------------------------------------
  190.  
  191. NewsFlash_Sleep                 Code : 14
  192.  
  193. Type : From Tasks
  194.  
  195. This call tells NewsFlash to 'go to sleep'. NewsFlash will send the
  196. NewsFlash_Sleeping message once it is asleep.
  197.  
  198. -----------------------------------------------
  199.  
  200. NewsFlash_Wakeup                Code : 15
  201.  
  202. Type : From Tasks
  203.  
  204. This call tells NewsFlash to wakeup.
  205.  
  206. -----------------------------------------------
  207.  
  208. NewsFlash_Sleeping              Code : 16
  209.  
  210. Type : All tasks
  211.  
  212. This call indicates that NewsFlash is now asleep.
  213.  
  214. -----------------------------------------------
  215.  
  216. NewsFlash_Woken                 Code : 17
  217.  
  218. Type : All tasks
  219.  
  220. This call indicates that NewsFlash has just woken up.
  221.  
  222. -----------------------------------------------
  223.  
  224. NewsFlash_StartTask             Code : 18
  225.  
  226. Type : From Tasks
  227.  
  228. This call is used to start various tasks within the NewsFlash application,
  229. which will fully multitask until they are finished.
  230.  
  231. Block + 32 = Task type
  232. Block + 36 and above depend on task type
  233.  
  234. Task types:
  235.  
  236. Send string directly to serial port
  237.  
  238. Block + 32 = 0
  239. Block + 36 = Size of data to send
  240. Block + 40 = Data to send
  241.  
  242. Send message to user and waits for keyboard ack
  243.  
  244. Block + 32 = 1
  245. Block + 36 = Size of message to send
  246. Block + 40 = Data to send
  247.  
  248. Weed message base
  249.  
  250. Block + 32 = 2
  251. Block + 36 = Weed time unit:
  252.  
  253. 0 = Second
  254. 1 = Minute
  255. 2 = Hour
  256. 3 = Day
  257. 4 = Week
  258. 5 = Month
  259. 6 = Year
  260.  
  261. Block + 40 = Number of time units
  262.  
  263. Scan out outbound mail
  264.  
  265. Block + 32 = 3
  266.  
  267. Toss mail
  268.  
  269. Block + 32 = 4
  270.