IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

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.

CallerIdThe identifier of the caller.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the component is connected.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageThe message being sent (alphanumeric).
PagerIdThe identifying number of the pager to send a Message to.
ServerNameThe name or address of the SNPP server.
ServerPortThe server port for SNPP (default 444).
TimeoutA 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.

ConfigSets or retrieves a configuration setting .
ConnectConnects to an SNPP server.
DisconnectDisconnects from an SNPP gateway.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ResetResets the server state created during the connection.
SendSends 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.

ConnectionStatusFired to indicate changes in connection state.
ErrorInformation about errors during data delivery.
PITrailTraces 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.

LoginIDLogin ID used to authenticate with an SNPP server.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0