Search: 
Available in: IP*WORKS! | SSL
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 properties 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 further details.

ConnectedThis property indicates whether or not the component is bound.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageExpirationThis property denotes the validity period of the current message.
MessageIdThis is the id of the most recently sent message.
MessagePriorityThis is the priority level of the current message.
PasswordThis is the user's password.
RecipientsA list of message recipients.
ScheduledDeliveryThis value tells the server when to deliver the current message.
SenderAddressThe address of the ESME.
ServiceTypeThis indicates the type of service for the current message.
SMPPPortThe server port for SMPP (default 2775).
SMPPServerThis is the SMPP entity to which the component will connect.
SMPPVersionThis is the SMPP version to be used throughout the connection.
SystemTypeThis is a string representing the type of system during a connection.
TimeoutA timeout for the component.
UserIdThis 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 further details.

AddRecipientThis method will add a recipient of the specified type to the recipient list.
CancelMessageThis method will cancel the specified message.
CheckLinkThis method will check the connection to the server.
CheckMessageStatusThis method will retrieve the status of the specified message.
ConfigSets or retrieves a configuration setting.
ConnectThis method will bind as a transceiver to the SMPP service.
DisconnectThis method will disconnect from the SMPP service.
DoEventsThis method processes events from the internal message queue.
InterruptInterrupt the current method.
ReplaceMessageThis method replaces a previously sent message with a new one.
SendCommandThis will format and send a PDU using the specified command id and payload.
SendDataThis method sends raw data to Recipients .
SendMessageThe 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 further details.

ConnectedThis event is fired after a successful bind operation.
ConnectionStatusFired to indicate changes in connection state.
DisconnectedThis event is fired when connection to the SMS service is lost.
ErrorThis event is fired when the server detects an error.
MessageInThis event is fired upon receipt of a message.
MessageStatusThis event is fired upon receipt of a message.
PITrailThis 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 further details.

AddressRangeSpecifies the addr_range parameter when binding.
BindAsReceiverCauses the component to bind as a receiver.
BindAsTransmitterCauses the component to bind as a transmitter.
DataCodingThe data encoding mechanism to be used for the current message.
DestinationNPIThe Number Planning Indicator for the destination ESME
DestinationTONThe Type of Number for the destination ESME
HexStringA hex-encoded binary string to be sent to the current recipient.
IncomingDestinationAddressReturns the dest_addr field inside the received message.
IntermediateNotificationCauses the component to request intermediate notification
MCReceiptThe Type of MC Delivery Receipt requested
MessageModeThe Type of Messaging Mode requested
MessageTypeThe Type of Message.
ProtocolIdThe protocol identifier
SMEAcknowledgementThe Type of SME originated acknowledgement requested
SourceNPIThe Number Planning Indicator for the ESME
SourceTONThe Type of Number for the ESME
SynchronousSendCommandControls whether behaves synchronously or asynchronously
SynchronousSendMessageControls whether behaves synchronously or asynchronously
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
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 (Windows/COM only).

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