The Datafile PD-CD 5

home *** CD-ROM | disk | FTP | other *** search

/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / n / newsflash / !FileBase / !NewsFlash / Docs / Developers / Messages < prev next >

Wrap

Text File | 1996-08-06 | 20.6 KB | 950 lines

Last update: 5/1/96 NewsFlash Wimp Messages (for doors generally) NewsFlash Message Code 1 : &BFFC0 Message format: 0 : Block length 4 : NewsFlash's (module) task handle 8 : my_ref 12 : your_ref 16 : &BFFC0 20 : NewsFlash Message Code 24 : Task handle of original sender (0 if NewsFlash module) 28 : Line number from 0 (-1 if N/A) 32 : Message data NewsFlash Message Code 2 : &BFFC1 Message format: 0 : Block length 4 : Task handle of original sender 8 : my_ref 12 : your_ref 16 : &BFFC1 20 : NewsFlash Message Code 24 : Reserved (should be 0) 28 : Line number from 0 (-1 if N/A) 32 : Message data NewsFlash Utility Manager Code : &BFFC2 0 : Block length 4 : Task handle of original sender 8 : my_ref 12 : your_ref 16 : &BFFC2 20 : Util manager code 24 : Reserved (should be 0) 28 : Line number from 0 (-1 if N/A) 32 : Message data NewsFlash Door Manager Code : &BFFC3 0 : Block length 4 : Task handle of original sender 8 : my_ref 12 : your_ref 16 : &BFFC3 20 : Door manager code 24 : Reserved (should be 0) 28 : Line number from 0 (-1 if N/A) 32 : Message data NewsFlash message codes: ============================================================================ Message types: Door only - This message is sent only to the door (if any) that has claimed the line in question. All tasks - This message is sent to all wimp tasks. From Tasks - This message is sent from a task to NewsFlash Messages: ----------------------------------------------- NewsFlash_Quit Code : 0 Type : Door only You must release the line (and quit?). ----------------------------------------------- NewsFlash_IncomingMessage Code : 1 Type : Door only A message has been sent by another program or the sysop. You should display it somehow. Block + 32 = 0 if sent by sysop. = 1 if sent by NewsFlash main app = 2 if sent by another program Block + 36 = Null terminated message string. ----------------------------------------------- NewsFlash_StartDoor Code : 2 Type : All tasks A command in the script file has signalled that a door has been requested to 'start'. Block + 32 = 0 if text ID = 1 if numeric ID Block + 36 = Door ID ----------------------------------------------- NewsFlash_CarrierLost Code : 3 Type : Door only The user has hungup or the main BB has quit. You should quit and not release the line if you have claimed it. ----------------------------------------------- NewsFlash_User Code : 4 Type : All tasks Allows user messages Block + 32 = User code Block + 36 = Data Current user codes: 0 - Battleships door message ----------------------------------------------- NewsFlash_Incoming Code : 5 Type : All tasks NewsFlash has answered an incomming call Block + 32 = Baud rate ----------------------------------------------- NewsFlash_Logon Code : 6 Type : All tasks A user has logged on. Block + 32 = Baud rate Block + 36 = User number Block + 40 = Null terminated user name ----------------------------------------------- NewsFlash_Logoff Code : 7 Type : All tasks Block + 32 = Baud rate Block + 36 = User number Block + 40 = Call duration (seconds) Block + 44 = Non-zero to indicate user dropped carrier (0 otherwise) Block + 48 = Number of calls by this user Block + 52 = 5 byte time of call start Block + 57 = Null terminated user name A user has hung up or logged off ----------------------------------------------- NewsFlash_Starting Code : 8 Type : All tasks NewsFlash has just been loaded. ----------------------------------------------- NewsFlash_Dying Code : 9 Type : All tasks NewsFlash is being quit. ----------------------------------------------- NewsFlash_SysopChatRequest Code : 10 Type : All tasks A user has requested a chat with the sysop. Block + 32 = User number Block + 36 = Topic ----------------------------------------------- NewsFlash_StartSysopChat Code : 11 Type : All tasks This call is sent after the chat request has been acknowledged. It should be acknoledged within 10 wimp polls or NF will timeout and continue with the script. ----------------------------------------------- NewsFlash_ForceLogon Code : 12 Type : From Tasks This call is sent to NewsFlash to force a logon without having to wait for a connect code. Block + 32 = Connect speed ----------------------------------------------- NewsFlash_ForceLogoff Code : 13 Type : From Tasks This call forces NewsFlash to disconnect a user. ----------------------------------------------- NewsFlash_Sleep Code : 14 Type : From Tasks This call tells NewsFlash to 'go to sleep'. NewsFlash will send the NewsFlash_Sleeping message once it is asleep. ----------------------------------------------- NewsFlash_Wakeup Code : 15 Type : From Tasks This call tells NewsFlash to wakeup. ----------------------------------------------- NewsFlash_Sleeping Code : 16 Type : All tasks This call indicates that NewsFlash is now asleep. ----------------------------------------------- NewsFlash_Woken Code : 17 Type : All tasks This call indicates that NewsFlash has just woken up. ----------------------------------------------- NewsFlash_StartTask Code : 18 Type : From Tasks This call is used to start various tasks within the NewsFlash application, which will fully multitask until they are finished. Block + 32 = Task type Block + 36 and above depend on task type Task types: Send string directly to serial port Block + 32 = 0 Block + 36 = Size of data to send Block + 40 = Data to send Send message to user and waits for keyboard ack Block + 32 = 1 Block + 36 = Size of message to send Block + 40 = Data to send Weed message base Block + 32 = 2 Block + 36 = Weed time unit: 0 = Second 1 = Minute 2 = Hour 3 = Day 4 = Week 5 = Month 6 = Year Block + 40 = Number of time units Scan out outbound mail Block + 32 = 3 Toss mail Block + 32 = 4 ----------------------------------------------- NewsFlash_FileTransferStarted Code : 19 Type : All tasks This indicates a file transfer has just started ----------------------------------------------- NewsFlash_FileTransferFinish Code : 20 Type : All tasks This indicates a file transfer has just finished ----------------------------------------------- NewsFlash_FileTransferFileSent Code : 21 Type : All tasks This indicates a file has just been sent. ----------------------------------------------- NewsFlash_Log Code : 22 Type : From tasks Block + 32 = String to log ----------------------------------------------- NewsFlash_Logged Code : 23 Type : All tasks Block + 32 = String that has just been log ----------------------------------------------- NewsFlash_HHE Code : 24 Type : All tasks Reserved for NFHHE only ----------------------------------------------- NewsFlash_StartUtility Code : 25 Type : All tasks This message is sent by a task to start a utility. Utility Manager will respond with UtilityMananger_UtilityStarting or UtilityManager_StartFailed Block + 32 = Utility ID Block + 36 = Reference word (0 for none) Block + 40 = Paramaters ----------------------------------------------- NewsFlash_StartDoor Code : 26 Type : All tasks This message is sent by a task to start a door. Door manager will respond with DoorManager_DoorStarting or DoorManager_RunFailed. Block + 32 = Door name ----------------------------------------------- NewsFlash_SetVariable Code : 27 Type : All tasks Block + 32 = Variable type (0 = string, 1 = int) Block + 36 = Offset to string in message block (from Block + 0) or 32-bit int Block + 40 = Variable name ----------------------------------------------- NewsFlash_ReadVariable Code : 28 Type : All tasks Block + 32 = Variable name ----------------------------------------------- NewsFlash_VariableValue Code : 29 Type : All tasks Block + 32 = Variable type (0 = string, 1 = int) Block + 36 = Offset to string in message block (from Block + 0) or 32-bit int Block + 40 = Variable name ----------------------------------------------- ============================================================================ Utility Manager message codes: ============================================================================ Message types: All tasks - This message is sent to all wimp tasks. From tasks - This message is sent from a task to the Utility Manager To task - This message is sent only to a paticular task as a response To utility - This message is sent to a specific utility only From utility - This message is sent by a utility to Utility Manager Messages: ----------------------------------------------- UtilityManager_Starting Code : 0 Type : All tasks ----------------------------------------------- UtilityManager_Dying Code : 1 Type : All tasks ----------------------------------------------- UtilityManager_RequestVersion Code : 2 Type : From tasks Make a request to the utilty manager to broadcast it's version ----------------------------------------------- UtilityManager_Version Code : 3 Type : All tasks Block + 32 = Version word (&RRRRHHLL) Block + 36 = Version string ----------------------------------------------- UtilityManager_VerifyUtilityList Code : 4 Type : From tasks Make a request to the utilty manager to verify a list of utilities by returning UtilityManager_ActiveUtilities and UtilityManager_InactiveUtilities Block + 32 = Utility ID 1 Block + 36 = Utility ID 2 ... Block + ?? = -1 terminator ----------------------------------------------- UtilityManager_VerifyUtilityListID Code : 5 Type : From tasks Make a request to the utilty manager to verify a list of utilities by returning UtilityManager_ActiveUtilitiesID and UtilityManager_InactiveUtilitiesID Block + 32 = Utility ID 1 Block + 36 = Custom ID 1 Block + 40 = Utility ID 2 ... Block + 44 = Custom ID 2 .... Block + ?? = -1 ----------------------------------------------- UtilityManager_RequestUtilityList Code : 6 Type : From tasks Make a request to the utilty manager to broadcast a complete list of utilities by returning UtilityManager_UtilityList ----------------------------------------------- UtilityManager_ActiveUtilities Code : 7 Type : To task Returns a list of active utilites Block + 32 = Active Utility ID 1 Block + 36 = Active Utility ID 2 .... Block + ?? = 0 ----------------------------------------------- UtilityManager_InactiveUtilites Code : 8 Type : To task Returns a list of inactive utilites Block + 32 = Inactive Utility ID 1 Block + 36 = Inactive Utility ID 2 .... Block + ?? = -1 ----------------------------------------------- UtilityManager_ActiveUtilitiesID Code : 9 Type : To task Returns a list of active utilites Block + 32 = Active Utility Custom ID 1 Block + 36 = Active Utility Custom ID 2 .... Block + ?? = -1 ----------------------------------------------- UtilityManager_InactiveUtilitesID Code : 10 Type : To task Returns a list of inactive utilites Block + 32 = Inactive Utility Custom ID 1 Block + 36 = Inactive Utility Custom ID 2 .... Block + ?? = -1 ----------------------------------------------- UtilityManager_UtilityList Code : 11 Type : All tasks Returns a list of active utilites Block + 32 = Active Utility ID 1 Block + 36 = Active Utility ID 2 .... Block + ?? = -1 ----------------------------------------------- UtilityManager_ActivateUtility Code : 12 Type : From tasks Request that a utilty be activated (made present). Note: The task must not assume that the utility will be activated and must wait for a UtilityManager_UtilityActivated Block + 32 = Utility ID ----------------------------------------------- UtilityManager_DeactivateUtility Code : 13 Type : From tasks Block + 32 = Utility ID Request that a utilty be deactivated. Note: The task must not assume that the utility will be deactivated and must wait for a UtilityManager_UtilityDeactivated ----------------------------------------------- UtilityManager_UtilityActivated Code : 14 Type : All tasks Block + 32 = Utility ID ----------------------------------------------- UtilityManager_UtilityDeactivated Code : 15 Type : All tasks Block + 32 = Utility ID ----------------------------------------------- UtilityManager_StartUtility Code : 16 Type: From tasks This message is sent by a task to start a utility. Utility Manager will respond with UtilityMananger_UtilityStarting or UtilityManager_StartFailed Block + 24 = 0 or task handle of sender (instead of +4) Block + 32 = Utility ID Block + 36 = Reference word (0 for none) Block + 40 = Run hidden Block + 44 = Paramaters ----------------------------------------------- UtilityManager_UtilityFinished Code : 17 Type: To task Block + 32 = Utility ID Block + 36 = Reference word as passed in UtilityManager_StartUtility Block + 40 = Task was completed succesfully ----------------------------------------------- UtilityManager_UtilityVerify Code : 18 Type: All tasks Block + 32 = Utility ID Block + 36 = Task handle of utility Block + 40 = Paramaters This is sent by Utility Manager so that utilities can stop other utilites starting if they want to, by using UtilityManager_Abort ----------------------------------------------- UtilityManager_Paramaters Code : 19 Type: To utility Block + 24 = Task handle of initiator Block + 32 = Utility ID Block + 36 = User reference word Block + 40 = Hide main window Block + 44 = Paramaters This is sent by the Utility Manager to give the utility it's paramaters. The utility should wait for a short while (perhaps 10 wimp polls) to allow other utilities to tell it to abort. If no abort message is received the utility can go on. Then it should send Utility_UtilityStarting or Utility_StartFailed to Utility Manager. ----------------------------------------------- UtilityManager_Abort Code : 20 Type: To utility Block + 32 = Utility ID This may be sent by another utility to tell the utility to quit before doing anything. This will be sent shortly after UtilityManager_Paramaters. ----------------------------------------------- UtilityManager_RequestStatus Code : 21 Type: To utility The utility should respond by sending UtilityManager_StatusUpdate. If the utility does not respond within a certain time the utility will be assumed to be not responding and asked to quit. ----------------------------------------------- UtilityManager_StatusUpdate Code : 22 Type: From utility Block + 32 = Utility is frozen or paused Block + 36 = Progress as a percentage (-1 for unknown) Block + 40 = Status description ----------------------------------------------- UtilityManager_RequestQuit Code : 23 Type: To utility Requests that a utility quits ----------------------------------------------- UtilityManager_ForceQuit Code : 24 Type: To utility Requests that a utility quits as soon as possible. If a utility does something illegal it will usually be sent this message. However, it should send a UtilityManager_Quitting before it quits. ----------------------------------------------- UtilityManager_Freeze Code : 25 Type: To utility Requests that a utility freezes (becomes inactive) ----------------------------------------------- UtilityManager_UnFreeze Code : 26 Type: To utility Requests that a utility unfreezes (becomes active) ----------------------------------------------- UtilityManager_Quitting Code : 27 Type: From utility This message is broadcast by a utility when it quits Block + 32 = Intended task was completed ----------------------------------------------- UtilityManager_UtilityStarting Code : 28 Type: From util / To task This message is sent to a task to acknowledge that a utility is starting. Block + 32 = Utility ID Block + 36 = Your reference ID ----------------------------------------------- UtilityManager_StartFailed Code : 29 Type: From util / To task This message is sent to a task if a utility could not be started Block + 32 = Utility ID Block + 36 = Your reference ID Block + 40 = Error message ----------------------------------------------- UtilityManager_Rescanned Code : 30 Type: All tasks This message is broadcast by utility manager when the ulitity list has been regenerated. ----------------------------------------------- UtilityManager_Frozen Code : 31 Type: All tasks This message is broadcast by utility manager, or sent by a utility, when a utility is paused or frozen. ----------------------------------------------- UtilityManager_UnFrozen Code : 32 Type: All tasks This message is broadcast by utility manager, or sent by a utility, when a utility is unpaused or unfrozen. ----------------------------------------------- UtilityManager_OpenWindow Code : 33 Type: To utility This message is sent to a utility to request that it opens it's main window and/or brings it to the front. ----------------------------------------------- UtilityManager_CloseWindow Code : 34 Type: To utility This message is sent to a utility to request that it closes it's main window. ----------------------------------------------- UtilityManager_ProgressDetails Code : 35 Type: From utility Block + 32 = Utility ID Block + 36 = Your reference ID Block + 40 onwards defined by utility This message may be sent by a utility directly to it's initiator to give detailed progress information. ----------------------------------------------- UtilityManager_UtilityCommunication Code : 36 Type: From/To utility Block + 32 = Utility ID Block + 36 = Your reference ID Block + 40 onwards defined by utility This message is used for direct communication between a utility and it's initiator. ----------------------------------------------- ============================================================================ Door Manager message codes: ============================================================================ Message types: All tasks - This message is sent to all wimp tasks. From tasks - This message is sent from a task to the Door Manager To task - This message is sent only to a paticular task as a response Messages: ----------------------------------------------- DoorManager_Starting Code : 0 Type : All tasks Make a request to the door manager to broadcast it's version ----------------------------------------------- DoorManager_Dying Code : 1 Type : All tasks Make a request to the door manager to broadcast it's version ----------------------------------------------- DoorManager_RequestVersion Code : 2 Type : From tasks Make a request to the door manager to broadcast it's version ----------------------------------------------- DoorManager_Version Code : 3 Type : All tasks Block + 32 = Version word (&RRRRHHLL) Block + 36 = Version string ----------------------------------------------- DoorManager_RunDoor Code : 4 Type: From tasks This makes a request for a door to start. The door manager will respond with DoorManager_DoorStarting or DoorManager_UnknownDoor. Block + 24 = 0 or task handle of sender (instead of +4) Block + 32 = Door name to start Block + .. = Optional paramaters ----------------------------------------------- DoorManager_DoorStarting Code : 5 Type: To task This is sent to acknowledge DoorManager_RunDoor. Block + 32 = Door name ----------------------------------------------- DoorManager_RunFailed Code : 6 Type: To task This is sent in response to DoorManager_RunDoor if the door could not be started. Block + 32 = Error message ----------------------------------------------- DoorManager_RequestDoorInfo Code : 7 Type: From tasks This is sent by a task to request the door manager to broadcast information on a door Block + 32 = Door name ----------------------------------------------- DoorManager_DoorInfo Code : 8 Type: To tasks Block + 32 = Door name Door version string Door author Physical door path Physical door !Help file path ----------------------------------------------- Contacting me ------------- If anyone wishes to contact me please send e-mail to: Chris Davis.. Fidonet 2:253/417.6 or 2:257/501.7 Internet chris@armadilo.demon.co.uk Highlander BBS 01452 384557/384702