ICMP Class
Properties Methods Events Config Settings Errors
The ICMP class is used to facilitate ICMP communications. It can act both as a client and a server and can communicate with any number of hosts simultaneously. It also can generate and receive broadcast packets.
Syntax
ICMP
Remarks
The interface of the class is similar to the interface of TCPClient, only it is much simpler. The class is activated/deactivated by using the Active property. This property enables or disables the sending or receiving of data. Data can be sent in the same way as TCPClient, using the Send method and Text parameter. The destination is specified using the RemoteHost property. The class automatically creates an ICMP header containing MessageType, MessageSubType, and a checksum for the message.
If the UseConnection configuration setting is set to True, then a local association is created with the remote host. Otherwise, the class can receive datagrams (packets) from any host and can send datagrams to any host. Packets can be broadcast on the local net by setting the destination to 255.255.255.255.
Inbound data is received through the DataIn event.
The operation of the class is almost completely asynchronous. All the calls, except the ones that deal with domain name resolution, operate through Windows messages (no blocking calls). The gain in performance is considerable when compared with using blocking calls.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AcceptData | This property indicates whether data reception is currently enabled. |
Active | This property indicates whether the class is active. |
DontRoute | If this property is set to True, it forces the socket to send data directly to the interface (no routing). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MessageSubType | This property is the subtype of the ICMP message (part of the ICMP header). |
MessageType | This property includes the type of the ICMP message (part of the ICMP header). |
RemoteHost | This property includes the address of the RemoteHost. Domain names are resolved to IP addresses. |
Timeout | This property specifies the timeout for the class. |
TimeToLive | This property includes the time-to-live (TTL) value for the ICMP packets sent by the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Activate | This method enables sending and receiving of data. |
Config | Sets or retrieves a configuration setting. |
Deactivate | This method disables sending and receiving of data. |
DoEvents | This method processes events from the internal message queue. |
PauseData | This method pauses data reception. |
ProcessData | This method reenables data reception after a call to PauseData . |
Reset | This method will reset the class. |
ResolveRemoteHost | This method resolves the hostname in RemoteHost to an IP address. |
Send | This method sends data to the remote host. |
SendBytes | This method sends data to the remote host. |
SendText | This method sends data to the remote host. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
DataIn | This event is fired when a new ICMP messages come in. |
Error | Fired when information is available about errors during data delivery. |
ReadyToSend | This event is fired when the class is ready to send data. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DontFragment | Whether the DontFragment control flag is set. |
IcmpDllTimeout | The timeout for the class when using the icmp.dll. |
MaxMessageSize | The maximum length of the messages that can be received. |
MulticastTTL | The time to live (TTL) value for multicast ICMP packets sent by the class. |
ReceiveAllMode | Enables a socket to receive all IPv4 or IPv6 packets on the network. |
TimeoutInMilliseconds | The timeout is treated as milliseconds. |
UseConnection | Determines whether to use a connected socket. |
UseICMPDLL | Use the icmp.dll included on Windows Systems. |
UseIPHLPDLL | Use the iphlpapi.dll included on Windows Systems. |
UseIPv6 | Whether to use IPv6. |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (ICMP Class)
This property indicates whether data reception is currently enabled.
Syntax
ANSI (Cross Platform) int GetAcceptData(); Unicode (Windows) BOOL GetAcceptData();
int ipworks_icmp_getacceptdata(void* lpObj);
bool GetAcceptData();
Default Value
TRUE
Remarks
This property indicates whether data reception is currently enabled. When false, data reception is disabled and the DataIn event will not fire. Use the PauseData and ProcessData methods to pause and resume data reception.
This property is read-only and not available at design time.
Data Type
Boolean
Active Property (ICMP Class)
This property indicates whether the class is active.
Syntax
ANSI (Cross Platform) int GetActive(); Unicode (Windows) BOOL GetActive();
int ipworks_icmp_getactive(void* lpObj);
bool GetActive();
Default Value
FALSE
Remarks
This property indicates whether the class is currently active and can send or receive data.
If the UseConnection configuration setting is set to true, then a local association (connection) to the remote host also is created. Use the Activate and Deactivate methods to control whether the class is active.
This property is read-only and not available at design time.
Data Type
Boolean
DontRoute Property (ICMP Class)
If this property is set to True, it forces the socket to send data directly to the interface (no routing).
Syntax
ANSI (Cross Platform) int GetDontRoute();
int SetDontRoute(int bDontRoute); Unicode (Windows) BOOL GetDontRoute();
INT SetDontRoute(BOOL bDontRoute);
int ipworks_icmp_getdontroute(void* lpObj);
int ipworks_icmp_setdontroute(void* lpObj, int bDontRoute);
bool GetDontRoute();
int SetDontRoute(bool bDontRoute);
Default Value
FALSE
Remarks
If this property is set to True, it forces the socket to send data directly to the interface (no routing). Normally, IP sockets send packets of data through routers and gateways until they reach the final destination. If this property is set to True, then data will be delivered on the local subnet only.
This property is not available at design time.
Data Type
Boolean
LocalHost Property (ICMP Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworks_icmp_getlocalhost(void* lpObj);
int ipworks_icmp_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
This 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 class initiate connections (or accept in the case of server classs) 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 class 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.
Data Type
String
MessageSubType Property (ICMP Class)
This property is the subtype of the ICMP message (part of the ICMP header).
Syntax
ANSI (Cross Platform) int GetMessageSubType();
int SetMessageSubType(int iMessageSubType); Unicode (Windows) INT GetMessageSubType();
INT SetMessageSubType(INT iMessageSubType);
int ipworks_icmp_getmessagesubtype(void* lpObj);
int ipworks_icmp_setmessagesubtype(void* lpObj, int iMessageSubType);
int GetMessageSubType();
int SetMessageSubType(int iMessageSubType);
Default Value
0
Remarks
This property contains the subtype of the ICMP message (part of the ICMP header). The ICMP message subtype (also referred to as "code") is a byte value representing the message subclass. Its meaning is associated with the MessageType.
Types and subtypes of ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP)/IP.
Data Type
Integer
MessageType Property (ICMP Class)
This property includes the type of the ICMP message (part of the ICMP header).
Syntax
ANSI (Cross Platform) int GetMessageType();
int SetMessageType(int iMessageType); Unicode (Windows) INT GetMessageType();
INT SetMessageType(INT iMessageType);
int ipworks_icmp_getmessagetype(void* lpObj);
int ipworks_icmp_setmessagetype(void* lpObj, int iMessageType);
int GetMessageType();
int SetMessageType(int iMessageType);
Default Value
0
Remarks
This property contains the type of the ICMP message (part of the ICMP header). The ICMP message type is a byte value representing the message class. The message type defines the structure and meaning of the message data assigned to Text parameter of the Send method.
Types for ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP/IP). The following are a few examples of ICMP message types:
0 | Echo reply ("ping" reply). |
3 | Destination unreachable. |
4 | Source quench. |
5 | Redirect (change a route). |
8 | Echo request ("ping" request). |
11 | Time exceeded for datagram. |
12 | Parameter problem on datagram. |
13 | Timestamp request. |
14 | Timestamp reply. |
17 | Address mask request. |
18 | Address mask reply. |
Data Type
Integer
RemoteHost Property (ICMP Class)
This property includes the address of the RemoteHost. Domain names are resolved to IP addresses.
Syntax
ANSI (Cross Platform) char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost); Unicode (Windows) LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);
char* ipworks_icmp_getremotehost(void* lpObj);
int ipworks_icmp_setremotehost(void* lpObj, const char* lpszRemoteHost);
QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host.
If this property is set to 255.255.255.255, the class broadcasts data on the local subnet.
If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, the class fails with an error.
If UseConnection is True, this property must be set before the class is activated (Active is set to True).
Data Type
String
Timeout Property (ICMP Class)
This property specifies the timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworks_icmp_gettimeout(void* lpObj);
int ipworks_icmp_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
0
Remarks
If the Timeout property is set to 0, all operations return immediately, potentially failing with an WOULDBLOCK error if data cannot be sent or received immediately.
If Timeout is set to a positive value, the class will automatically retry each operation that otherwise would result in a WOULDBLOCK error for a maximum of Timeout seconds.
The class 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 class fails with an error.
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 0 (asynchronous operation).
Data Type
Integer
TimeToLive Property (ICMP Class)
This property includes the time-to-live (TTL) value for the ICMP packets sent by the class.
Syntax
ANSI (Cross Platform) int GetTimeToLive();
int SetTimeToLive(int iTimeToLive); Unicode (Windows) INT GetTimeToLive();
INT SetTimeToLive(INT iTimeToLive);
int ipworks_icmp_gettimetolive(void* lpObj);
int ipworks_icmp_settimetolive(void* lpObj, int iTimeToLive);
int GetTimeToLive();
int SetTimeToLive(int iTimeToLive);
Default Value
0
Remarks
This method contains the time-to-live (TTL) value for the ICMP packets sent by the class. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.
Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL value is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL value is reduced to zero (or less), the packet is discarded.
If the value of the property is set to zero, then the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.
This property is not available at design time.
Data Type
Integer
Activate Method (ICMP Class)
This method enables sending and receiving of data.
Syntax
ANSI (Cross Platform) int Activate(); Unicode (Windows) INT Activate();
int ipworks_icmp_activate(void* lpObj);
int Activate();
Remarks
This method enables sending and receiving of data. When called, the class will create a communication endpoint (socket) that can be used for sending and receiving ICMP messages. This method must be called before using the class to send and receive data.
If the UseConnection configuration setting is set to true, then a local association (connection) to the remote host also is created.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (ICMP Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworks_icmp_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Deactivate Method (ICMP Class)
This method disables sending and receiving of data.
Syntax
ANSI (Cross Platform) int Deactivate(); Unicode (Windows) INT Deactivate();
int ipworks_icmp_deactivate(void* lpObj);
int Deactivate();
Remarks
This method disables sending and receiving of data. When called, the class will destroy the existing socket and disable data communications.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (ICMP Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworks_icmp_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PauseData Method (ICMP Class)
This method pauses data reception.
Syntax
ANSI (Cross Platform) int PauseData(); Unicode (Windows) INT PauseData();
int ipworks_icmp_pausedata(void* lpObj);
int PauseData();
Remarks
This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. Call ProcessData to reenable data reception.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ProcessData Method (ICMP Class)
This method reenables data reception after a call to PauseData .
Syntax
ANSI (Cross Platform) int ProcessData(); Unicode (Windows) INT ProcessData();
int ipworks_icmp_processdata(void* lpObj);
int ProcessData();
Remarks
This method reenables data reception after a previous call to PauseData. When PauseData is called, the DataIn event will not fire. To reenable data reception and allow DataIn to fire, call this method.
Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (ICMP Class)
This method will reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworks_icmp_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ResolveRemoteHost Method (ICMP Class)
This method resolves the hostname in RemoteHost to an IP address.
Syntax
ANSI (Cross Platform) int ResolveRemoteHost(); Unicode (Windows) INT ResolveRemoteHost();
int ipworks_icmp_resolveremotehost(void* lpObj);
int ResolveRemoteHost();
Remarks
This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.
In most cases, calling this method is not necessary; the class will resolve the hostname automatically when needed. If DelayHostResolution is true, this method may be called to manually resolve RemoteHost, if desired.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Send Method (ICMP Class)
This method sends data to the remote host.
Syntax
ANSI (Cross Platform) int Send(const char* lpText, int lenText); Unicode (Windows) INT Send(LPCSTR lpText, INT lenText);
int ipworks_icmp_send(void* lpObj, const char* lpText, int lenText);
int Send(QByteArray qbaText);
Remarks
This method sends data to the remote host.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendBytes Method (ICMP Class)
This method sends data to the remote host.
Syntax
ANSI (Cross Platform) int SendBytes(const char* lpData, int lenData); Unicode (Windows) INT SendBytes(LPCSTR lpData, INT lenData);
int ipworks_icmp_sendbytes(void* lpObj, const char* lpData, int lenData);
int SendBytes(QByteArray qbaData);
Remarks
This method sends data to the remote host. Calling this method is equivalent to calling the SendBytes/SendText method.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendText Method (ICMP Class)
This method sends data to the remote host.
Syntax
ANSI (Cross Platform) int SendText(const char* lpszText); Unicode (Windows) INT SendText(LPCWSTR lpszText);
int ipworks_icmp_sendtext(void* lpObj, const char* lpszText);
int SendText(const QString& qsText);
Remarks
This method sends data to the remote host. Calling this method is equivalent to calling the SendBytes/SendText method.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DataIn Event (ICMP Class)
This event is fired when a new ICMP messages come in.
Syntax
ANSI (Cross Platform) virtual int FireDataIn(ICMPDataInEventParams *e);
typedef struct {
int MessageType;
int MessageSubType;
const char *MessageData; int lenMessageData;
int Checksum;
const char *SourceAddress; int reserved; } ICMPDataInEventParams;
Unicode (Windows) virtual INT FireDataIn(ICMPDataInEventParams *e);
typedef struct {
INT MessageType;
INT MessageSubType;
LPCSTR MessageData; INT lenMessageData;
INT Checksum;
LPCWSTR SourceAddress; INT reserved; } ICMPDataInEventParams;
#define EID_ICMP_DATAIN 1 virtual INT IPWORKS_CALL FireDataIn(INT &iMessageType, INT &iMessageSubType, LPSTR &lpMessageData, INT &lenMessageData, INT &iChecksum, LPSTR &lpszSourceAddress);
class ICMPDataInEventParams { public: int MessageType(); int MessageSubType(); const QByteArray &MessageData(); int Checksum(); const QString &SourceAddress(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DataIn(ICMPDataInEventParams *e);
// Or, subclass ICMP and override this emitter function. virtual int FireDataIn(ICMPDataInEventParams *e) {...}
Remarks
The MessageType parameter shows the type of the ICMP messages and the MessageSubType parameter shows its subtype.
The MessageData parameter contains the message data.
The Checksum parameter is True or False depending on the ICMP checksum validation on the message.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Error Event (ICMP Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(ICMPErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } ICMPErrorEventParams;
Unicode (Windows) virtual INT FireError(ICMPErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } ICMPErrorEventParams;
#define EID_ICMP_ERROR 2 virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class ICMPErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(ICMPErrorEventParams *e);
// Or, subclass ICMP and override this emitter function. virtual int FireError(ICMPErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
ReadyToSend Event (ICMP Class)
This event is fired when the class is ready to send data.
Syntax
ANSI (Cross Platform) virtual int FireReadyToSend(ICMPReadyToSendEventParams *e);
typedef struct { int reserved; } ICMPReadyToSendEventParams;
Unicode (Windows) virtual INT FireReadyToSend(ICMPReadyToSendEventParams *e);
typedef struct { INT reserved; } ICMPReadyToSendEventParams;
#define EID_ICMP_READYTOSEND 3 virtual INT IPWORKS_CALL FireReadyToSend();
class ICMPReadyToSendEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadyToSend(ICMPReadyToSendEventParams *e);
// Or, subclass ICMP and override this emitter function. virtual int FireReadyToSend(ICMPReadyToSendEventParams *e) {...}
Remarks
The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed Send.
Config Settings (ICMP Class)
The class 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 class, access to these internal properties is provided through the Config method.ICMP Config Settings
The default value is false.
The default value is False.
The default value for IcmpDllTimeout is 60 seconds.
Note: This configuration setting is valid only when UseICMPDLL is set to True.
Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL is reduced to zero (or less), the packet is discarded.
By default, the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.
Value | Description |
-1 (default) | The socket option is left unspecified. |
0 | Do not receive all network traffic. |
1 | Receive all network traffic. This enables the promiscuous mode on the network interface card (NIC). On a LAN segment with a network hub, a NIC that supports the promiscuous mode will capture all IPv4 or IPv6 traffic on the LAN, including traffic between other computers on the same LAN segment. |
2 | Receive only socket-level network traffic (this feature may not be implemented by your Windows installation). |
3 | Receive only IP-level network traffic. This option does not enable the promiscuous mode on the NIC. This option affects packet processing only at the IP level. The NIC still receives only those packets directed to its configured unicast and multicast addresses. A socket with this option enabled, however, not only will receive packets directed to specific IP addresses, but also will receive all the IPv4 or IPv6 packets the NIC receives. |
Note: This setting is valid only when UseICMPDLL is set to True.
The default value for this setting is False.
Note: If both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
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 class 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 class 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
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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 classes: 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 class 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.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (ICMP Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ICMP Errors
104 | The class is already Active. |
107 | Cannot change the LocalHost at this time. A connection is in progress. |
109 | The class must be Active for this operation. |
112 | Cannot change MaxMessageSize while ICMP is Active. |
114 | Cannot change RemoteHost when UseConnection is set and the class is Active. |
117 | Cannot change UseConnection while the class is Active. |
118 | The message cannot be longer than MaxMessageSize. |
119 | The message is too short. |
120 | Cannot create ICMP handle. |
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). |