Ping Class
Properties Methods Events Configuration Settings Errors
The Ping class encapsulates ICMP ECHO functionality, used to check whether there is a communications link between two computers.
Syntax
Ping
Remarks
When the PingHost method is called with the Host parameter, or RemoteHost is assigned an IP address or domain name, the class sends an ICMP ECHO packet to the remote host. The ResponseTime and ResponseSource properties are updated with the time of the roundtrip to the remote host, and the address of the host actually sending the response.
The class operates synchronously by default (waits for a response before returning control to the caller), however, the class may also operate asynchronously (return control immediately), by setting Timeout to 0. Please refer to the Timeout property for more information.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Active | Indicates whether the class is active. |
Idle | The current status of the class. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
PacketSize | The size of the packet to send as the ping request. |
RemoteHost | The address of the RemoteHost. Domain names are resolved to IP addresses. |
RequestId | A unique identifier for outgoing packets. |
ResponseSource | The source of the last PING response. |
ResponseStatus | The status of the last PING response. |
ResponseTime | Time elapsed between sending the original packet and the remote host reply. |
Timeout | A timeout for the class. |
TimeToLive | The time to live (TTL) value for the ICMP packets sent by the class. |
TypeOfService | The type of the ICMP message sent as a ping request. |
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 | Enables sending and receiving data. |
Config | Sets or retrieves a configuration setting. |
Deactivate | Disables sending and receiving data. |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
PingHost | Pings a host. |
Reset | Reset the class. |
ResolveRemoteHost | Resolves the hostname in RemoteHost to an IP address. |
WakeOnLAN | Sends a Wake-On-LAN packet. |
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.
Error | Information about errors during data delivery. |
Response | Fired when a response packet is received. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
TimeoutInMilliseconds | The timeout is treated as milliseconds. |
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. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
Active Property (Ping Class)
Indicates whether the class is active.
Syntax
bool GetActive();
int SetActive(bool bActive);
Default Value
false
Remarks
This property indicates whether the class is currently active and can send or receive data.
The PingHost method will automatically change the value of this property to True.
Note: Use the Activate or Deactivate method to control whether the class is active.
This property is not available at design time.
Data Type
Boolean
Idle Property (Ping Class)
The current status of the class.
Syntax
bool GetIdle();
Default Value
true
Remarks
Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
LocalHost Property (Ping Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
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 multi-homed 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
PacketSize Property (Ping Class)
The size of the packet to send as the ping request.
Syntax
int GetPacketSize();
int SetPacketSize(int iPacketSize);
Default Value
64
Remarks
This property allows you to control the size of the data packet sent in the PingHost method. The default packet size is 64 bytes, with a minimum of 8 bytes (4 bytes of the ICMP header + ECHO identifier). The maximum value is 65520.
Data Type
Integer
RemoteHost Property (Ping Class)
The address of the RemoteHost. Domain names are resolved to IP addresses.
Syntax
QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or 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 and 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
RequestId Property (Ping Class)
A unique identifier for outgoing packets.
Syntax
int GetRequestId();
Default Value
0
Remarks
This property contains a unique identifier for outgoing packets. This property is useful during asynchronous ping operations. The RequestId parameter of the Response event is used to match requests with responses.
The identifier of the outgoing ping packet is provided in this property after the PingHost method returns.
This property is read-only and not available at design time.
Data Type
Integer
ResponseSource Property (Ping Class)
The source of the last PING response.
Syntax
QString GetResponseSource();
Default Value
""
Remarks
This property contains the address of the host responding to the PING (ICMP ECHO) request. This may or may not be the host used in PingHost.
This property is read-only.
Data Type
String
ResponseStatus Property (Ping Class)
The status of the last PING response.
Syntax
QString GetResponseStatus();
Default Value
""
Remarks
This property contains the status of the last response. After PingHost has returned this property will be populated with the stauts of the response. For responses without error the value will be OK. In the case of an error the value will hold a description of the error such as Network Unreachable or Host Unreachable.
This property is read-only.
Data Type
String
ResponseTime Property (Ping Class)
Time elapsed between sending the original packet and the remote host reply.
Syntax
int GetResponseTime();
Default Value
0
Remarks
This property contains the time elapsed between sending the original packet and the remote host reply. The time value is expressed in milliseconds. The lowest resolution available depends on the resolution of the clock on the host system (normally between 10ms and 20ms)..
This property is read-only.
Data Type
Integer
Timeout Property (Ping Class)
A timeout for the class.
Syntax
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation 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.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
Data Type
Integer
TimeToLive Property (Ping Class)
The time to live (TTL) value for the ICMP packets sent by the class.
Syntax
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 Time-to-Live (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 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.
If the value of the property is set to 0, then the default TTL value of the underlying TCP/IP subsystem will be used.
This property is not available at design time.
Data Type
Integer
TypeOfService Property (Ping Class)
The type of the ICMP message sent as a ping request.
Syntax
int GetTypeOfService();
int SetTypeOfService(int iTypeOfService);
Default Value
8
Remarks
This property contains the type of the ICMP message sent as a ping request. The default value is 8 (ECHO REQUEST).
This property is not available at design time.
Data Type
Integer
Activate Method (Ping Class)
Enables sending and receiving data.
Syntax
int Activate();
Remarks
This method enables sending and receiving of data.
Note: Calling the PingHost method will automatically activate the class.
Error Handling
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 (Ping Class)
Sets or retrieves a configuration setting.
Syntax
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
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 (Ping Class)
Disables sending and receiving data.
Syntax
int Deactivate();
Remarks
This method disables sending and receiving of data.
Error Handling
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 (Ping Class)
Processes events from the internal message queue.
Syntax
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
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.)
Interrupt Method (Ping Class)
Interrupt the current method.
Syntax
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling
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.)
PingHost Method (Ping Class)
Pings a host.
Syntax
int PingHost(const QString& qsHost);
Remarks
This method will ping a host. A valid internet domain name or address must be specified in Host, or an error will be returned.
PING request (ICMP ECHO) is sent to Host.
Example (Ping a Host)
PingControl.PingHost("MyHostName")
ResponseTime = PingControl.ResponseTime
Error Handling
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 (Ping Class)
Reset the class.
Syntax
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling
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 (Ping Class)
Resolves the hostname in RemoteHost to an IP address.
Syntax
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 necessary. If DelayHostResolution is true this method may be called to manually resolve RemoteHost if desired.
Error Handling
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.)
WakeOnLAN Method (Ping Class)
Sends a Wake-On-LAN packet.
Syntax
int WakeOnLAN(const QString& qsRemoteHost, const QString& qsMACAddress);
Remarks
When this method is called, a "Wake-On-LAN" packet is sent to RemoteHost (which may also be a broadcast address). This has the effect of powering on the machine (if such functionality is supported by the network card on the remote machine).
The physical address of the remote host must be supplied in the MACAddress parameter.
Error Handling
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.)
Error Event (Ping Class)
Information about errors during data delivery.
Syntax
class PingErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PingErrorEventParams *e);
// Or, subclass Ping and override this emitter function. virtual int FireError(PingErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Response Event (Ping Class)
Fired when a response packet is received.
Syntax
class PingResponseEventParams { public: int RequestId(); const QString &ResponseSource(); const QString &ResponseStatus(); int ResponseTime(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Response(PingResponseEventParams *e);
// Or, subclass Ping and override this emitter function. virtual int FireResponse(PingResponseEventParams *e) {...}
Remarks
The RequestId parameter is used together with the RequestId property to match requests with responses.
ResponseStatus is set to "OK" for normal operation, or it contains an error string such as "Network unreachable", "Host unreachable", etc.
Configuration Settings (Ping 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.Ping Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost property.
If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.
The default value is false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TimeoutInMilliseconds: The timeout is treated as milliseconds. Setting TimeoutInMilliseconds to true causes the class to use the value in the Timeout property as milliseconds instead of seconds, which is the default. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ICMPPort Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost property.
If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.
The default value is false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DontFragment:
Whether the DontFragment control flag is set.When set to true the DontFragment control flag in the IP header will be set.
The default value is false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IcmpDllTimeout:
The timeout for the class when using the icmp.dll.The class will wait for the operation to complete before returning control.
If IcmpDllTimeout expires, and the operation is not yet
complete, the class fails with an error. IcmpDllTimeout must be set to a positive value.
The default value for IcmpDllTimeout is 60 seconds. NOTE: This setting is only valid when UseICMPDLL is set to true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxMessageSize: The maximum length of the messages that can be received.This setting specifies the maximum size of the datagrams that the class will accept without truncation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MulticastTTL:
The time to live (TTL) value for multicast ICMP packets sent by the component.When sending multicast packets, the setting specifies the Time-To-Live (TTL) field. The Time-to-live (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 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 TCP/IP subsystem will be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceiveAllMode:
Enables a socket to receive all IPv4 or IPv6 packets on the network.This setting specifies the ReceiveAll mode for the socket. Available modes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TimeoutInMilliseconds:
The timeout is treated as milliseconds.
Setting TimeoutInMilliseconds to true causes the class
to use the value in the IcmpDllTimeout config
as milliseconds instead of seconds, which is the default.
NOTE: This setting is only valid when UseICMPDLL is set to true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseConnection:
Determines whether to use a connected socket.UseConnection specifies whether the class
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the class will send and receive data
only to and from the specified destination.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseICMPDLL: Use the icmp.dll included on Windows Systems. Setting UseICMPDLL to true causes the class to use the icmp.dll on Windows 9x or later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPHLPDLL: Use the iphlpapi.dll included on Windows Systems. Setting UseIPHLPDLL to true causes the class to use the iphlpapi.dll on Windows XP or later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited. Note that if both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
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 Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API. |
Trappable Errors (Ping Class)
Ping Errors
102 The RemoteHost address is invalid (0.0.0.0). | |
127 Destination unreachable |
The class may also return one of the following error codes, which are inherited from other classes.
ICMPPort Errors
104 The class is already Active. | |
107 You 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 ICMPPort 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 Message cannot be longer than MaxMessageSize. | |
119 Message too short. | |
120 Can't 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 non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't 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] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory 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 not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |