SMPP Component
Properties Methods Events Config Settings Errors
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.
Syntax
nsoftware.IPWorks.SMPP
Remarks
The SMPP component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.
The Smpp Component will bind as a transceiver, and thus it can send and receive messages from the server. Additionally, it can send single and multirecipient messages and also 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 at a time 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 nonimplemented features of the protocol are supported through the SendCommand method and PITrail event. Because of 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.
Connected | This property indicates whether the component is connected. |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the component. |
LocalHost | This property includes 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 property indicates the identifier of the most recently sent message. |
MessagePriority | This property indicates the priority level of the current message. |
Password | This property contains the user's password. |
Protocol | This property defines the SMPP protocol to be used. |
Recipients | This property includes the list of message recipients. |
ScheduledDelivery | This property tells the server when to deliver the current message. |
SenderAddress | This property contains the address of the External Short Messaging Entity (ESME). |
ServiceType | This property indicates the type of service for the current message. |
SMPPPort | This property contains the server port for secure SMPP (default 2775). |
SMPPServer | This property is the SMPP entity to which the component will connect. |
SMPPVersion | This property indicates the SMPP version to be used throughout the connection. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SSLStartMode | This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. |
SystemType | This property contains a string representing the type of system during a connection. |
Timeout | This property includes the timeout for the component. |
UserId | This property 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.
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 configuration setting. |
Connect | This method will bind as a transceiver to the SMPP service. |
ConnectTo | 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 | This method interrupts the current method. |
ReplaceMessage | This method replaces a previously sent message with a new one. |
Reset | This method will reset the component. |
SendCommand | This method will format and send a protocol data unit (PDU) using the specified command identifier and payload. |
SendData | This method sends raw data to Recipients . |
SendMessage | This method 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.
Connected | This event is fired after a successful bind operation. |
ConnectionStatus | This event is fired to indicate changes in the 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 protocol data unit (PDU) sent between the client and server. |
ReadyToSend | This event is fired when the component is ready to send data. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AddressRange | Specifies the addr_range parameter when binding. |
BinaryDataCoding | Whether or not to binary encode the message when DataCoding is set. |
BindAsReceiver | Causes the component to bind as a receiver. |
BindAsTransmitter | Causes the component to bind as a transmitter. |
CustomTLV | Optional TLV parameters added after the mandatory parameters and before the payload. |
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. |
DoSplitLargeMessages | Splits long messages and returns the UDH and Message Parts. |
HexString | A hex-encoded binary string to be sent to the current recipient. |
IntermediateNotification | Causes the component to request intermediate notification. |
MaxCIMDSMSLength | Indicates the maximum SMS message length for the CIMD protocol. |
MaxSMSLength | Indicates the maximum SMS message length. |
MCReceipt | The Type of MC Delivery Receipt requested. |
MessageInReceiptedMessageId | The receipted_message_id field of an incoming deliver_sm PDU. |
MessageMode | The Type of Messaging Mode requested. |
MessageType | The Type of Message. |
PDUFormat | The format of the PDU. |
ProtocolId | The protocol identifier. |
ReplaceIfPresent | Indicates whether the replace_if_present_flag is enabled when sending a message. |
SMEAcknowledgement | The Type of SME originated acknowledgment requested. |
SourceNPI | The Number Planning Indicator for the ESME. |
SourceTON | The Type of Number for the ESME. |
SplitLargeMessages | Determines whether large messages are split into multiple parts. |
SplitMessageMethod | Determines how large messages are split into multiple parts. |
StatusReportRequest | Defines in what cases a status report is created by the server. |
SubAddr | Defines a unique index for application instance. |
SynchronousSendCommand | Controls whether SendCommand behaves synchronously or asynchronously. |
SynchronousSendMessage | Controls whether SendMessage behaves synchronously or asynchronously. |
UseGSM7BitEncoding | Whether or not to use GSM 7-bit encoding. |
UseGSM7bitEncodingCompression | Whether to compress GSM 7-bit encoded characters. |
WaitForBanner | Specifies the CIMD2 banner the component will wait for when connecting. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
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). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
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. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
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 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. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Connected Property (SMPP Component)
This property indicates whether the component is connected.
Syntax
Default Value
False
Remarks
This property indicates whether the component is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Firewall Property (SMPP Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (SMPP Component)
This property specifies the current status of the component.
Syntax
Default Value
True
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
LocalHost Property (SMPP Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
MessageExpiration Property (SMPP Component)
This property denotes the validity period of the current message.
Syntax
Default Value
""
Remarks
This property indicates the Message Center expiration time, after which the message should be discarded if not delivered to the destination. It can be set using absolute or relative time formats.
Absolute Time Format is a 16-character string represented as "YYMMDDhhmmsstnnp" where:
YY | the last two digits of the year (00-99) |
MM | month (01-12) |
DD | day (01-31) |
hh | hour (00-23) |
mm | minute (00-59) |
ss | second (00-59) |
t | tenths of a second (0-9) |
nn | quarter-hour time difference between local time and UTC time (00-48) |
p | "+" or "-" indicating the direction of the time offset in nn |
Relative Time Format is the same 16-character string where "p" should be set to "R" for "relative". For relative time, "tnn" are ignored and thus should be set to a constant value of "000".
MessageId Property (SMPP Component)
This property indicates the identifier of the most recently sent message.
Syntax
Default Value
""
Remarks
This property indicates the identifier of the most recently sent message. After a successful call to SendMessage, this property will be set to the server-assigned Id for that message.
This property is read-only and not available at design time.
MessagePriority Property (SMPP Component)
This property indicates the priority level of the current message.
Syntax
public SMPPMessagePriorities MessagePriority { get; set; }
enum SMPPMessagePriorities { smppMessagePriorityLow, smppMessagePriorityNormal, smppMessagePriorityHigh, smppMessagePriorityUrgent }
Public Property MessagePriority As SmppMessagePriorities
Enum SMPPMessagePriorities smppMessagePriorityLow smppMessagePriorityNormal smppMessagePriorityHigh smppMessagePriorityUrgent End Enum
Default Value
1
Remarks
When sending a message, this property will tell the server what type of priority to assign to the message. The effect of the message priority setting depends on the Message Center (MC) manufacturer and the network on which the target recipient lies. For example, some MCs may immediately forward "urgent" messages, some networks may use the priority setting as a visual indicator of the message's urgency (e.g., blinking icons), and some networks may entirely ignore the priority setting.
Password Property (SMPP Component)
This property contains the user's password.
Syntax
Default Value
""
Remarks
This property contains the user's password. When binding to the SMPPServer, the client must provide a known user identifier and a valid password for that Id.
The two ways to bind are (1) by calling Connect with a user identifier and password, which will set the UserId and this property before connecting; or (2) by setting those two properties and calling SendMessage while not connected.
Protocol Property (SMPP Component)
This property defines the SMPP protocol to be used.
Syntax
public SMPPProtocols Protocol { get; set; }
enum SMPPProtocols { smppSMPP, smppCIMD2 }
Public Property Protocol As SmppProtocols
Enum SMPPProtocols smppSMPP smppCIMD2 End Enum
Default Value
0
Remarks
This property defines the protocol to be used when connecting to the server. Possible values are as follows:
0 (smppSMPP - default) | SMPP for traditional SMPP servers |
1 (smppCIMD2) | CIMD2 for Nokia Short Message Service Center servers |
Recipients Property (SMPP Component)
This property includes the list of message recipients.
Syntax
public SMPPRecipientList Recipients { get; }
Public Property Recipients As SMPPRecipientList
Remarks
This property is used to specify the recipient(s) of the message. Each recipient is represented by an SMPPRecipient type, which contains fields for the address and type of address for the recipient.
An AddRecipient method also may be used to add recipients to this collection property.
This collection is indexed from 0 to count -1.
Please refer to the SMPPRecipient type for a complete list of fields.ScheduledDelivery Property (SMPP Component)
This property tells the server when to deliver the current message.
Syntax
Default Value
""
Remarks
This property is used by the component when sending a message to inform the Message Center to forward the message to the intended recipients at a specific time. It can be set using absolute or relative time formats.
Absolute Time Format is a 16-character string represented as "YYMMDDhhmmsstnnp" where:
YY | the last two digits of the year (00-99) |
MM | month (01-12) |
DD | day (01-31) |
hh | hour (00-23) |
mm | minute (00-59) |
ss | second (00-59) |
t | tenths of a second (0-9) |
nn | quarter-hour time difference between local time and UTC time (00-48) |
p | "+" or "-" indicating the direction of the time offset in nn |
Relative Time Format is the same 16-character string where "p" should be set to "R" for "relative". For relative time, "tnn" are ignored and thus should be set to a constant value of "000".
SenderAddress Property (SMPP Component)
This property contains the address of the External Short Messaging Entity (ESME).
Syntax
Default Value
""
Remarks
This property contains the address of the External Short Messaging Entity (ESME). The SMPP protocol allows an ESME to specify its address, whether it is a phone number or an IP address. If this property is not set, the component will default to the value in LocalHost.
ServiceType Property (SMPP Component)
This property indicates the type of service for the current message.
Syntax
public SMPPServiceTypes ServiceType { get; set; }
enum SMPPServiceTypes { smppServiceDefault, smppServiceCMT, smppServiceCPT, smppServiceVMN, smppServiceVMA, smppServiceWAP, smppServiceUSSD, smppServiceCBS }
Public Property ServiceType As SmppServiceTypes
Enum SMPPServiceTypes smppServiceDefault smppServiceCMT smppServiceCPT smppServiceVMN smppServiceVMA smppServiceWAP smppServiceUSSD smppServiceCBS End Enum
Default Value
0
Remarks
When sending messages, this property is used to define the SMS application service to be associated with the message. The Message Center (MC) will use the value to determine the availability of enhanced messaging services and to control the teleservice used on the air interface.
The values are defined in the SMPP 5.0 specification as follows:
"" (NULL) | MC Default |
CMT | Cellular Messaging |
CPT | Cellular Paging |
VMN | Voice Mail Notification |
VMA | Voice Mail Alerting |
WAP | Wireless Application Protocol |
USSD | Unstructured Supplementary Services Data |
CBS | Cell Broadcast Service |
SMPPPort Property (SMPP Component)
This property contains the server port for secure SMPP (default 2775).
Syntax
Default Value
2775
Remarks
For an implicit Secure Sockets Layer (SSL), use port 3551 (please refer to the SSLStartMode property for more information).
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
SMPPServer Property (SMPP Component)
This property is the SMPP entity to which the component will connect.
Syntax
Default Value
""
Remarks
This property is the instant messaging server to which the component will connect when the Connect method is called. This property must contain a valid SMPP service application address.
SMPPVersion Property (SMPP Component)
This property indicates the SMPP version to be used throughout the connection.
Syntax
public SMPPSMPPVersions SMPPVersion { get; set; }
enum SMPPSMPPVersions { smppVersion50, smppVersion34, smppVersion33 }
Public Property SMPPVersion As SmppSMPPVersions
Enum SMPPSMPPVersions smppVersion50 smppVersion34 smppVersion33 End Enum
Default Value
1
Remarks
This property contains the SMPP version to be used throughout the connection.
The default value is version 3.4 because it is the most widely used version of the protocol.
Choosing the highest mutually supported version is generally recommended. Version 3.4 is the default value; however, if version 5.0 is supported, it is recommended.
SSLAcceptServerCert Property (SMPP Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (SMPP Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLEnabled Property (SMPP Component)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
Default Value
False
Remarks
This property specifies whether TLS/SSL is enabled in the component. When False (default), the component operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
SSLProvider Property (SMPP Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public SMPPSSLProviders SSLProvider { get; set; }
enum SMPPSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As SmppSSLProviders
Enum SMPPSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (SMPP Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SSLStartMode Property (SMPP Component)
This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.
Syntax
public SMPPSSLStartModes SSLStartMode { get; set; }
enum SMPPSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone }
Public Property SSLStartMode As SmppSSLStartModes
Enum SMPPSSLStartModes sslAutomatic sslImplicit sslExplicit sslNone End Enum
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the component will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The component will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. |
SystemType Property (SMPP Component)
This property contains a string representing the type of system during a connection.
Syntax
Default Value
""
Remarks
This property contains a string representing the type of system during a connection. Some SMS servers require that a system type be supplied during connection. The system type is a string representation, usually as an abbreviation, of a particular kind of system. The string cannot exceed 12 bytes.
Timeout Property (SMPP Component)
This property includes the timeout for the component.
Syntax
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.
The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the component throws an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
UserId Property (SMPP Component)
This property is used for identification with the SMPP service.
Syntax
Default Value
""
Remarks
This property is used for identification with the SMPP service. When binding to the SMPPServer, the client must provide a known user identifier and a valid password for that Id.
The two ways to bind are (1) by calling Connect with a user Id and password, which will set the UserId and Password properties before connecting; or (2) by setting those two properties and calling SendMessage while not connected.
AddRecipient Method (SMPP Component)
This method will add a recipient of the specified type to the recipient list.
Syntax
public void AddRecipient(int recipientType, string recipientAddress); Async Version public async Task AddRecipient(int recipientType, string recipientAddress); public async Task AddRecipient(int recipientType, string recipientAddress, CancellationToken cancellationToken);
Public Sub AddRecipient(ByVal RecipientType As Integer, ByVal RecipientAddress As String) Async Version Public Sub AddRecipient(ByVal RecipientType As Integer, ByVal RecipientAddress As String) As Task Public Sub AddRecipient(ByVal RecipientType As Integer, ByVal RecipientAddress As String, cancellationToken As CancellationToken) As Task
Remarks
This method will add a recipient of the specified type to the recipient list. For normal-type recipients, the addresses should be either a dotted IPv4 address (for sending messages to other SMS-enabled applications) or the directory number of a mobile phone. To send messages to distributed lists, the name of the list should be used.
Valid values for RecipientType are as follows:
0 (smppRecipientTypeNormal) | Normal SME (Short Message Entity) Address |
1 (smppRecipientTypeList) | Distribution List |
CancelMessage Method (SMPP Component)
This method will cancel the specified message.
Syntax
public void CancelMessage(string messageId); Async Version public async Task CancelMessage(string messageId); public async Task CancelMessage(string messageId, CancellationToken cancellationToken);
Public Sub CancelMessage(ByVal MessageId As String) Async Version Public Sub CancelMessage(ByVal MessageId As String) As Task Public Sub CancelMessage(ByVal MessageId As String, cancellationToken As CancellationToken) As Task
Remarks
This method will cancel the message stored on the SMPPServer under the value in MessageId.
CheckLink Method (SMPP Component)
This method will check the connection to the server.
Syntax
public void CheckLink(); Async Version public async Task CheckLink(); public async Task CheckLink(CancellationToken cancellationToken);
Public Sub CheckLink() Async Version Public Sub CheckLink() As Task Public Sub CheckLink(cancellationToken As CancellationToken) As Task
Remarks
This method will check the connection to the server. This method is used to ensure that the host on the other end of the connection is still active, or that it is still available. Although a socket connection may still be available between the client and server, the SMS application on the server may have been taken offline without releasing the socket or the CPU may be bogged down. This method will send a PDU to the server and wait the length of Timeout for a response.
CheckMessageStatus Method (SMPP Component)
This method will retrieve the status of the specified message.
Syntax
public void CheckMessageStatus(string messageId); Async Version public async Task CheckMessageStatus(string messageId); public async Task CheckMessageStatus(string messageId, CancellationToken cancellationToken);
Public Sub CheckMessageStatus(ByVal MessageId As String) Async Version Public Sub CheckMessageStatus(ByVal MessageId As String) As Task Public Sub CheckMessageStatus(ByVal MessageId As String, cancellationToken As CancellationToken) As Task
Remarks
This method will retrieve the last known status of the message stored on the server under MessageId. The component will fire a MessageStatus containing the parsed response from the server.
Config Method (SMPP Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (SMPP Component)
This method will bind as a transceiver to the SMPP service.
Syntax
public void Connect(); Async Version public async Task Connect(); public async Task Connect(CancellationToken cancellationToken);
Public Sub Connect() Async Version Public Sub Connect() As Task Public Sub Connect(cancellationToken As CancellationToken) As Task
Remarks
This method will establish a socket connection to the SMPPServer and attempt to bind as a transceiver. Once the bind operation has been completed, a Connected event will be fired containing the status of the connection.
ConnectTo Method (SMPP Component)
This method will bind as a transceiver to the SMPP service.
Syntax
Remarks
This method will establish a socket connection to the SMPPServer and attempt to bind as a transceiver. Once the bind operation has completed, a Connected event will be fired containing the status of the connection.
Disconnect Method (SMPP Component)
This method will disconnect from the SMPP service.
Syntax
public void Disconnect(); Async Version public async Task Disconnect(); public async Task Disconnect(CancellationToken cancellationToken);
Public Sub Disconnect() Async Version Public Sub Disconnect() As Task Public Sub Disconnect(cancellationToken As CancellationToken) As Task
Remarks
This method will send an unbind command and close the socket connection to the SMPPServer. After an unbind operation and socket closing, a Disconnected event will be fired containing the status of the unbind operation.
DoEvents Method (SMPP Component)
This method processes events from the internal message queue.
Syntax
public void DoEvents(); Async Version public async Task DoEvents(); public async Task DoEvents(CancellationToken cancellationToken);
Public Sub DoEvents() Async Version Public Sub DoEvents() As Task Public Sub DoEvents(cancellationToken As CancellationToken) As Task
Remarks
When this method is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Interrupt Method (SMPP Component)
This method interrupts the current method.
Syntax
public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt() Async Version Public Sub Interrupt() As Task Public Sub Interrupt(cancellationToken As CancellationToken) As Task
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ReplaceMessage Method (SMPP Component)
This method replaces a previously sent message with a new one.
Syntax
public void ReplaceMessage(string messageId, string newMessage); Async Version public async Task ReplaceMessage(string messageId, string newMessage); public async Task ReplaceMessage(string messageId, string newMessage, CancellationToken cancellationToken);
Public Sub ReplaceMessage(ByVal MessageId As String, ByVal NewMessage As String) Async Version Public Sub ReplaceMessage(ByVal MessageId As String, ByVal NewMessage As String) As Task Public Sub ReplaceMessage(ByVal MessageId As String, ByVal NewMessage As String, cancellationToken As CancellationToken) As Task
Remarks
Assuming that a message on the SMPPServer is being stored under the value in MessageId, this method will replace that message with the value in NewMessage.
If no message corresponds to MessageId, the SMS service will respond with an error message.
Reset Method (SMPP Component)
This method will reset the component.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
This method will reset the component's properties to their default values.
SendCommand Method (SMPP Component)
This method will format and send a protocol data unit (PDU) using the specified command identifier and payload.
Syntax
public byte[] SendCommand(int commandId, byte[] payload); Async Version public async Task<byte[]> SendCommand(int commandId, byte[] payload); public async Task<byte[]> SendCommand(int commandId, byte[] payload, CancellationToken cancellationToken);
Public Function SendCommand(ByVal CommandId As Integer, ByVal Payload As String) As String Async Version Public Function SendCommand(ByVal CommandId As Integer, ByVal Payload As String) As Task(Of String) Public Function SendCommand(ByVal CommandId As Integer, ByVal Payload As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method offers a way to do more with the component than is directly supported. This method takes a command identifier and a payload, which includes every required and optional field after the header, and creates the 16-byte header for it before sending it to the server. The response PDU is returned both in the PITrail and by this method.
SendData Method (SMPP Component)
This method sends raw data to Recipients .
Syntax
Remarks
This method sends raw data to Recipients. Up to 64 KB of additional data can be supplied at a time for transmission to the SMPPServer. Unlike the SendMessage method, this method can send to only one destination at a time. The target is whatever value is in the Recipients collection.
SendMessage Method (SMPP Component)
This method sends a message to all recipients in the recipient list.
Syntax
Remarks
This method sends a message to all recipients in the recipient list. The return value of this method is the server-assigned identifier of the message. The maximum size of the message sent is 256 bytes.
Connected Event (SMPP Component)
This event is fired after a successful bind operation.
Syntax
public event OnConnectedHandler OnConnected; public delegate void OnConnectedHandler(object sender, SMPPConnectedEventArgs e); public class SMPPConnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnConnected As OnConnectedHandler Public Delegate Sub OnConnectedHandler(sender As Object, e As SMPPConnectedEventArgs) Public Class SMPPConnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
After establishing a socket connection to the SMPPServer, the component will attempt to send a bind as a transmitter command. Upon completion of this operation, the server will respond with either a success or failure state, which will be reflected in the Connected event's parameters.
StatusCode will contain the command status (error code) returned by the server. For a StatusCode of 0, Description will be OK. Otherwise, it will contain a standard interpretation of the error.
ConnectionStatus Event (SMPP Component)
This event is fired to indicate changes in the connection state.
Syntax
public event OnConnectionStatusHandler OnConnectionStatus; public delegate void OnConnectionStatusHandler(object sender, SMPPConnectionStatusEventArgs e); public class SMPPConnectionStatusEventArgs : EventArgs { public string ConnectionEvent { get; } public int StatusCode { get; } public string Description { get; } }
Public Event OnConnectionStatus As OnConnectionStatusHandler Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As SMPPConnectionStatusEventArgs) Public Class SMPPConnectionStatusEventArgs Inherits EventArgs Public ReadOnly Property ConnectionEvent As String Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
Disconnected Event (SMPP Component)
This event is fired when connection to the SMS service is lost.
Syntax
public event OnDisconnectedHandler OnDisconnected; public delegate void OnDisconnectedHandler(object sender, SMPPDisconnectedEventArgs e); public class SMPPDisconnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnDisconnected As OnDisconnectedHandler Public Delegate Sub OnDisconnectedHandler(sender As Object, e As SMPPDisconnectedEventArgs) Public Class SMPPDisconnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
After sending an unbind operation to the server, this event will be fired containing the results of that operation. This event may also be fired if the socket connection to the service is lost.
If the event was fired because of an unbind operation, StatusCode will contain the command status set by the server. Otherwise, it will contain the socket code for the type of disconnection. For a status code value of 0, Description will contain OK. Otherwise, it will contain a standard interpretation of the value in StatusCode.
Error Event (SMPP Component)
This event is fired when the server detects an error.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, SMPPErrorEventArgs e); public class SMPPErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As SMPPErrorEventArgs) Public Class SMPPErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the server sends an error not related to a command sent from the component, the component will fire an Error event containing information related to the error.
ErrorCode will contain the code sent by the server, and Description will contain a standard interpretation of that code.
MessageIn Event (SMPP Component)
This event is fired upon receipt of a message.
Syntax
public event OnMessageInHandler OnMessageIn; public delegate void OnMessageInHandler(object sender, SMPPMessageInEventArgs e); public class SMPPMessageInEventArgs : EventArgs { public string SourceAddress { get; } public string ScheduleDeliveryTime { get; } public string ValidityPeriod { get; } public string Message { get; } public int MessagePart { get; } public int MessagePartCount { get; } public int MessagePartReference { get; } public string DestinationAddress { get; } public int ResponseErrorCode { get; set; } }
Public Event OnMessageIn As OnMessageInHandler Public Delegate Sub OnMessageInHandler(sender As Object, e As SMPPMessageInEventArgs) Public Class SMPPMessageInEventArgs Inherits EventArgs Public ReadOnly Property SourceAddress As String Public ReadOnly Property ScheduleDeliveryTime As String Public ReadOnly Property ValidityPeriod As String Public ReadOnly Property Message As String Public ReadOnly Property MessagePart As Integer Public ReadOnly Property MessagePartCount As Integer Public ReadOnly Property MessagePartReference As Integer Public ReadOnly Property DestinationAddress As String Public Property ResponseErrorCode As Integer End Class
Remarks
When a message is received, the SMPP component will parse the sender's message into the SourceAddress, ScheduleDeliveryTime, ValidityPeriod, and Message fields.
The SourceAddress parameter is the address of the originator of the message.
The DestinationAddress parameter holds the address of the recipient.
The ScheduleDeliveryTime parameter is the delivery time at which the short message is scheduled to be forwarded to another Message Center (MC). This will be an empty string if it is not scheduled.
The ValidityPeriod parameter is applicable only if this short message is being forwarded to another MC. When this occurs, it specifies how long the receiving MC should retain the Short Message (SM) and continue trying to deliver it. This will be an empty string if the current validity period is unavailable.
The Message parameter is the plaintext portion of the message body.
If the incoming message is a part of a larger message (the message was split up into several parts), the MessagePartCount, MessagePart, and MessagePartReference parameters will be set. MessagePartCount will hold the total number of parts for the message. MessagePart will indicate the current part's location in the message to determine the order when reassembling the message. This will be a value from 1 to MessagePartCount. MessagePartReference holds a reference value that will be the same across all parts for the message.
The ResponseErrorCode parameter may be set to return an error condition to the server. This corresponds to the command_status protocol-level field of the response.
MessageStatus Event (SMPP Component)
This event is fired upon receipt of a message.
Syntax
public event OnMessageStatusHandler OnMessageStatus; public delegate void OnMessageStatusHandler(object sender, SMPPMessageStatusEventArgs e); public class SMPPMessageStatusEventArgs : EventArgs { public string MessageId { get; } public int MessageState { get; } public int MessageError { get; } public string FinalDate { get; } }
Public Event OnMessageStatus As OnMessageStatusHandler Public Delegate Sub OnMessageStatusHandler(sender As Object, e As SMPPMessageStatusEventArgs) Public Class SMPPMessageStatusEventArgs Inherits EventArgs Public ReadOnly Property MessageId As String Public ReadOnly Property MessageState As Integer Public ReadOnly Property MessageError As Integer Public ReadOnly Property FinalDate As String End Class
Remarks
When a CheckMessageStatus is called, the SMPP component will retrieve the status of the message represented by MessageId from the server, parse the response, and fire MessageStatus.
MessageState represents the last known state the message was left in on the SMPPServer. This code is version specific. For v3.4:
1 | ENROUTE, the message is en route. |
2 | DELIVERED, the message is delivered. |
3 | EXPIRED, the message validity period expired. |
4 | DELETED, the message has been deleted. |
5 | UNDELIVERABLE, the message is undeliverable. |
6 | ACCEPTED, the message has been read on behalf of subscriber by customer service. |
7 | UNKNOWN, the message is in an invalid state. |
8 | REJECTED, the message is in a rejected state. |
0 | SCHEDULED, the message is scheduled for delivery, but it has not yet been delivered. |
1 | ENROUTE, the message is en route. |
2 | DELIVERED, the message is delivered. |
3 | EXPIRED, the message validity period expired. |
4 | DELETED, the message has been deleted. |
5 | UNDELIVERABLE, the message is undeliverable. |
6 | ACCEPTED, the message has been read on behalf of subscriber by customer service. |
7 | UNKNOWN, the message is in an invalid state. |
8 | REJECTED, the message is in a rejected state. |
9 | SKIPPED, the message was accepted but not delivered. |
MessageError will contain an error code representing any failure encountered during message delivery. This code may be vendor-specific.
FinalDate contains a human-readable string representing the date on which the message was delivered. If the message was not delivered, this parameter will be empty.
PITrail Event (SMPP Component)
This event is fired once for each protocol data unit (PDU) sent between the client and server.
Syntax
public event OnPITrailHandler OnPITrail; public delegate void OnPITrailHandler(object sender, SMPPPITrailEventArgs e); public class SMPPPITrailEventArgs : EventArgs { public int Direction { get; } public string PDU { get; }
public byte[] PDUB { get; } public int CommandLength { get; } public int CommandId { get; } public string CommandDescription { get; } public string CommandStatus { get; } public int SequenceNumber { get; } }
Public Event OnPITrail As OnPITrailHandler Public Delegate Sub OnPITrailHandler(sender As Object, e As SMPPPITrailEventArgs) Public Class SMPPPITrailEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property PDU As String
Public ReadOnly Property PDUB As Byte() Public ReadOnly Property CommandLength As Integer Public ReadOnly Property CommandId As Integer Public ReadOnly Property CommandDescription As String Public ReadOnly Property CommandStatus As String Public ReadOnly Property SequenceNumber As Integer End Class
Remarks
Whenever either the component or the SMPPServer sends any data across the connection, the component will fire a PITrail event containing that data. It will usually be in SMPP-PDU format.
A PDU will contain at least the SMPP header, which is always 16 bytes long. The first four bytes represent the total length of the PDU, including the 16-byte header. The next four bytes are the command Id associated with the PDU. The command Id of a response PDU is always the command Id to which it is responding plus 0x80000000.
The component parses the values contained in the PDU header into the appropriate fields. The CommandLength, CommandId, CommandStatus, and SequenceNumber parameters contain these parsed values.
The third set of four bytes are the command status (status code) of the command. All originating commands will have a status code of 0x00000000, which will be ignored by the receiver. The field is only set in response PDUs to indicate the status of the originating command. The final four bytes represent the sequence number of the command. All response PDUs will contain the same sequence number as the originating command.
ReadyToSend Event (SMPP Component)
This event is fired when the component is ready to send data.
Syntax
public event OnReadyToSendHandler OnReadyToSend; public delegate void OnReadyToSendHandler(object sender, SMPPReadyToSendEventArgs e); public class SMPPReadyToSendEventArgs : EventArgs { }
Public Event OnReadyToSend As OnReadyToSendHandler Public Delegate Sub OnReadyToSendHandler(sender As Object, e As SMPPReadyToSendEventArgs) Public Class SMPPReadyToSendEventArgs Inherits EventArgs End Class
Remarks
The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed SendBytes. This event also is fired immediately after a connection to the remote host is established.
SSLServerAuthentication Event (SMPP Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, SMPPSSLServerAuthenticationEventArgs e); public class SMPPSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As SMPPSSLServerAuthenticationEventArgs) Public Class SMPPSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (SMPP Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, SMPPSSLStatusEventArgs e); public class SMPPSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As SMPPSSLStatusEventArgs) Public Class SMPPSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte []
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
string (read-only)
Default: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string (read-only)
Default: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
string
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
string
Default: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.
Password
string
Default: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.
Port
int
Default: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
SMPPRecipient Type
This type describes a recipient of the SMPP message.
Remarks
This type describes a recipient of the SMPP message that is being sent. The fields describe the RecipientType of recipient and the Address of the recipient of the message.
Fields
Address
string
Default: ""
This field contains the email address of a particular recipient. This can be used to set single or multiple recipients. The RecipientType contains the corresponding type.
For a recipient type of normal, the value in the Address should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.
RecipientType
SMPPRecipientTypes
Default: 0
This field contains the type of a particular recipient. This field is used only for multiple recipient messages. The Address contains the corresponding recipient's address.
For a recipient type of normal, the value in Address should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.
Valid values for RecipientType are as follows:
0 (smppRecipientTypeNormal) | Normal SME (Short Message Entity) Address |
1 (smppRecipientTypeList) | Distribution List |
Constructors
public SMPPRecipient();
Public SMPPRecipient()
public SMPPRecipient(string address);
Public SMPPRecipient(ByVal Address As String)
public SMPPRecipient(string address, int recipientType);
Public SMPPRecipient(ByVal Address As String, ByVal RecipientType As Integer)
Config Settings (SMPP Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.SMPP Config Settings
Note 1: For IP addresses, it is only possible to specify a single IP address. A range of IP addresses is not allowed. IP version 6.0 is not currently supported in this version of the protocol.
Note 2: It is likely that the addr_range field is not supported or deliberately ignored on most Message Centers (MCs). Most carriers will not allow an ESME to control the message routing because this can carry the risk of incorrectly routing messages. In such circumstances, the ESME will be requested to set the field to NULL.
- One two-byte integer containing the parameter type (tag).
- One two-byte integer indicating the length of the data contained in this parameter.
- The variable-length parameter data itself.
For instance, to add a gn_lookup_userdata parameter, the type/tag is decimal 5633 (that's 0x1601 in hex), and the data in this example is "Hello World", which is 11 characters in length. So the TLV is as follows: 5633 + 11 + "Hello World", or 0x16 0x01 0x00 0x0b and then the ASCII text "Hello World". When hex-encoded, this yields the string "1601000b48656c6c6f20576f726c64". This is the value you would then use to set the CustomTLV configuration setting. You are not restricted to only one optional parameter. Multiple TLV parameters may be concatenated together.
Note: This is advanced functionality, and the component does not verify the data in this configuration setting before transmission. After the component internally decodes the string back into binary, it is passed on inside the protocol data unit (PDU) as-is without validation or modification.
This configuration setting is applicable only when using the SendMessage or SendData methods.
0 | MC Specific encoding |
1 | IA5 (CCITT T.50)/ASCII (ANSI X3.4) |
2 | Octet unspecified (8-bit binary) |
3 | Latin 1 (ISO-8859-1) |
4 | Octet unspecified (8-bit binary) |
5 | JIS (X 0208-1990) |
6 | Cyrillic (ISO-8859-5) |
7 | Latin/Hebrew (ISO-8859-8) |
8 | UCS2 (ISO/IEC-10646) |
9 | Pictogram Encoding |
10 | ISO-2022-JP (Music Codes) |
11 | Reserved |
12 | Reserved 2 |
13 | Extended Kanji JIS (X 0212-1990) |
14 | KS C 5601 |
[UDH1],[MessagePart1];[UDH2],[MessagePart2];[UDH3],[MessagePart3]
Note: When using HexString, DataCoding must be set to 8, and the value provided to this configuration setting should be the UTF-16 hex-encoded message.
0 | No MC Delivery Receipt requested (default). |
1 | MC Delivery Receipt is requested after final delivery (success or failure). |
2 | MC Delivery Receipt is requested after a failed delivery. |
3 | MC Delivery Receipt is requested after a successful delivery. |
Note: This is applicable only within the MessageIn event.
0 | Default SMSC Mode (e.g., Store and Forward). |
1 | Datagram mode. |
2 | Forward (i.e., Transaction) mode. |
3 | Store and Forward mode. |
0 | Default message Type (i.e., normal message). |
1 | Short Message contains MC Delivery Receipt. |
2 | Short Message contains Intermediate Delivery Notification. |
0 | Raw (Default) |
1 | Hex string |
2 | Verbose |
0 | No SME acknowledgment requested (default). |
1 | SME delivery acknowledgment is requested. |
2 | SME manual/user acknowledgment is requested. |
3 | Both delivery and manual/user acknowledgment is requested. |
Unknown (0) | |
ISDN (1) | |
Data (3) | |
Telex (4) | |
LandMobile (6) | |
National (8) | |
Private (9) | |
ERMES (10) | |
Internet (14) | |
WAP (18) |
Unknown (0) | The number type is unknown |
International (1) | The number includes the international trunk prefix |
National (2) | The number includes the national trunk prefix |
NetworkSpecific (3) | The number exists on a network that uses a specific delivery protocol |
SubscriberNumber (4) | The number is just the subscriber number, without prefixes |
Alphanumeric (5) | The address is human-readable (contains letters and digits) |
Abbreviated (6) | The number is abbreviated |
Note: This is valid only for GSM networks.
When receiving a message that has been split, the MessageIn event provides parameters to reassemble the message.
0 | UDH (Default) |
1 | SAR |
1 | Temporary Error |
2 | Validity Period Expired |
4 | Delivery Failed |
8 | Delivery Successful |
16 | Message Canceled |
32 | Message Deleted By The Operator |
This configuration setting is applicable only when Protocol is set to smppCIMD2.
This configuration setting applies only when UseGSM7BitEncoding is True.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (SMPP Component)
SMPP Errors
620 | SMPP protocol error |
621 | You cannot change this property while connected |
622 | Server disconnected before responding |
623 | Field value out of range |
624 | Unsupported SMPP version |
625 | Message parameter too long |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the component is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
303 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |