SNPP Class

Properties Methods Events Configuration Settings Errors

The SNPP Component is used to send pages through the internet using the SNPP protocol.

Class Name

IPWorks_SNPP

Procedural Interface

 ipworks_snpp_open();
 ipworks_snpp_close($res);
 ipworks_snpp_register_callback($res, $id, $function);
 ipworks_snpp_get_last_error($res);
 ipworks_snpp_get_last_error_code($res);
 ipworks_snpp_set($res, $id, $index, $value);
 ipworks_snpp_get($res, $id, $index);
 ipworks_snpp_do_config($res, $configurationstring);
 ipworks_snpp_do_connect($res);
 ipworks_snpp_do_disconnect($res);
 ipworks_snpp_do_doevents($res);
 ipworks_snpp_do_interrupt($res);
 ipworks_snpp_do_reset($res);
 ipworks_snpp_do_send($res);

Remarks

It is a client implementation of Simple Network Paging Protocol Version 3 as specified in RFC 1861. Service extensions level 2 are supported intrinsically and the user can access all of level 3 extensions.

SNPP allows for immediate notification of message delivery, gives absolute flexibility over the content sent to the recipient, allows the specification of multiple choice responses, etc.

To send a message the ServerName, recipient's PagerId and Message properties should be filled out (at a minimum). The Send method is then used to deliver the message.

The server's response is given in the PITrail events and by the LastReply property. Customized commands may be sent using the Command property.

Optional properties include: CallerId, ServerPort and LocalHost

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


CallerId	The identifier of the caller.
Command	Used to send additional commands directly to the server.
Connected	Shows whether the component is connected.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
Idle	The current status of the component.
LastReply	The last reply from the server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Message	The message being sent (alphanumeric).
PagerId	The identifying number of the pager to send a Message to.
ServerName	The name or address of the SNPP server.
ServerPort	The server port for SNPP (default 444).
Timeout	A timeout for the component.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


Config	Sets or retrieves a configuration setting .
Connect	Connects to an SNPP server.
Disconnect	Disconnects from an SNPP gateway.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
Reset	Resets the server state created during the connection.
Send	Sends the current message.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


ConnectionStatus	Fired to indicate changes in connection state.
Error	Information about errors during data delivery.
PITrail	Traces the commands sent to the server, and the respective replies.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


LoginID	Login ID used to authenticate with an SNPP server.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.