Products
Support
Downloads
Purchase
Company
Subscriptions
Search: 
Available in: IP*WORKS!
Smpp Class
SMPP Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The Smpp component implements a lightweight message transmission interface using the Short Message Peer-to-Peer protocol, most known for its use in cellular text messaging.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The Smpp component will bind as a transceiver, and thus can send and receive messages from the server. Additionally, it can send single and multi-recipient messages, and can upload data.

Using Smpp is quite easy. First, simply set the SMPPServer, SMPPPort, and, if needed, the SMPPVersion properties. Second, a single call to the Connect method with a specified user id and password will connect the component.

Transmitting messages is just as easy. You can manipulate the Recipients collection directly, or just use AddRecipient method to add recipients one-by-one to the recipient list. After all recipients have been added, a single call to the SendMessage method will transmit the specified message. If the send is successful, the method will set and return the value of the MessageId property. Otherwise, an Error event will fire for each unsuccessful message destination.

The Smpp component supports message and data transmission, as well as auxiliary operations such as CheckMessageStatus and ReplaceMessage. All non-implemented features of the protocol are supported through the SendCommand method and PITrail event. Due to the nature of the protocol, all methods and operations are implemented synchronously.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

Connected This property indicates whether or not the component is bound.
Firewall A set of properties related to firewall access.
Idle The current status of the component.
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageExpiration This property denotes the validity period of the current message.
MessageId This is the id of the most recently sent message.
MessagePriority This is the priority level of the current message.
Password This is the user's password.
Recipients A list of message recipients.
SMPPPort The server port for SMPP (default 2775).
SMPPServer This is the SMPP entity to which the component will connect.
SMPPVersion This is the SMPP version to be used throughout the connection.
ScheduledDelivery This value tells the server when to deliver the current message.
SenderAddress The address of the ESME.
ServiceType This indicates the type of service for the current message.
SystemType This is a string representing the type of system during a connection.
Timeout A timeout for the component.
UserId This value is used for identification with the SMPP service.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

AddRecipient This method will add a recipient of the specified type to the recipient list.
CancelMessage This method will cancel the specified message.
CheckLink This method will check the connection to the server.
CheckMessageStatus This method will retrieve the status of the specified message.
Config Sets or retrieves a component configuration setting.
Connect This method will bind as a transceiver to the SMPP service.
Disconnect This method will disconnect from the SMPP service.
DoEvents This method processes events from the internal message queue.
Interrupt Interrupt the current method.
ReplaceMessage This method replaces a previously sent message with a new one.
SendCommand This will format and send a PDU using the specified command id and payload.
SendData This method sends raw data to Recipients.
SendMessage The methods sends a message to all recipients in the recipient list.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Connected This event is fired after a successful bind operation.
ConnectionStatus Fired to indicate changes in connection state.
Disconnected This event is fired when connection to the SMS service is lost.
Error This event is fired when the server detects an error.
MessageIn This event is fired upon receipt of a message.
MessageStatus This event is fired upon receipt of a message.
PITrail This event is fired once for each PDU sent between the client and server.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
BindAsTransmitter Causes the component to bind as a transmitter.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
DataCoding The data encoding mechanism to be used for the current message.
DestinationNPI The Number Planning Indicator for the destination ESME
DestinationTON The Type of Number for the destination ESME
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HexString A hex-encoded binary string to be sent to the current recipient.
InBufferSize The size in bytes of the incoming queue of the socket.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProtocolId The protocol identifier
SocketHandle The handle of the main socket used by the component.
SourceNPI The Number Planning Indicator for the ESME
SourceTON The Type of Number for the ESME
TcpNoDelay Whether or not to delay when sending packets
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.