## SafeFire PPP REXX API Extension

### v1.0

# Message Reference

Informational Messages.

Message | Reason | Description
--- | --- | ---
MSG_00000001 | Clock timer message | This message is passed every second
MSG_00000003 | Connection established | IPCP negotiation is completed and connection may be considered established
MSG_00000004 | Connection lost | IPCP detected loss of connection
MSG_00000005 | Modem status message | Modem has produced status string recognized by SafeFire PPP and translated into some standardized string. Following messages may appear:
Message | Description
--- | ---
modem error | Modem reported error condition.
phone is busy | Phone is busy.
no carrier | Modem can't establish connection.
no dialtone | Modem is not connected to phone line or phone line is not working.
selecting next phone number | Response produced by SafeFire for MSG_00000044 control message (see below).
MSG_00000006 | Carrier loss detected by modem | Modem is signalled carrier loss
MSG_00000007 | Connection at modem level is established | Modem is established connection with other side and switched into data transfer mode.
MSG_00000020 | Phase changed | SafeFire PPP goes through certain phases during work. Each phase change is notified by this message. Following phases may appear:
Phase | Description
--- | ---
AUTH | Perform authentication
CALLBACK | Perform call back negotiations
CFGCON | Connect and perform initial LCP negotiations
DOD | Wait for a packet to start connection
INITIAL | Starting phase
ONLINE | LCP is online. Configure NCPs and start data processing
START | Start connection
STOP | Close current connection and exit SafeFire PPP
STOPPING | Wait for connection close
MSG_00000031 | Idle timer messages | Following messages may appear:
Message | Description
--- | ---
EXPIRED | Idle timer is expired.
number | Number of seconds left before timer will expire.
MSG_00000032 | Connection timer messages | Following messages may appear:
Message | Description
--- | ---
EXPIRED | Connection timer is expired.
number | Number of seconds left before timer will expire.
MSG_00000061 | Our IP | IP address for our interface obtained during IPCP negotiation.
MSG_00000062 | Peer IP | IP address for peer side obtained during IPCP negotiation.
MSG_00000063 | Primary DNS | Primary DNS address received from peer.
MSG_00000064 | Secondary DNS | Secondary DNS address received from peer.
MSG_000000F0 | Init | Initialization. *
MSG_000000F1 | Done | Deinitialization.*
MSG_000000F2 | Start | Start work. *
MSG_000000F3 | Stop | Stop work. *

* At present time there are no significant difference between Init - Start and Done - Stop pairs. But future versions of SafeFire PPP may change the situation. In general difference between Init and Start (as well as between Done and Stop) is that Init and Done messages are appear only once but Start and Stop will be issued by SafeFire PPP every time when internal structure is started and stopped.

Control messages.

Message | Action | Description
--- | --- | ---
MSG_00000043 | Exit program | Reset connection and exit SafeFire PPP.
MSG_00000044 | Next phone | Skip to next phone number or initiate immediate redial.*
MSG_00000045 | Cancel redial timer | Skip to next phone number or initiate immediate redial.*
MSG_00000046 | Reset connection | Reset current connection if connection established.
MSG_00000047 | Trigger DoD | Trigger DoD if DoD is enabled and connection is not active.
MSG_00000051 | Reset idle timer | Reset idle timer to value set in configuration file.
MSG_00000052 | Reset connection timer | Reset connection timer to value set in configuration file.

* At present time this two messages are identical but in future version of SafeFire PPP their functions will be separated according to Action.

Return to documentation index | SafeFire PPP (C) Link Guard Solutions 1999, 2000