Ping Class
Properties Methods Events Configuration Settings Errors
The Ping component encapsulates ICMP ECHO functionality, used to check whether there is a communications link between two computers.
Syntax
ipworks.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 | Enables or disables receiving of data. |
| Idle | The current status of the component. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| 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. |
| ResponseTime | Time elapsed between sending the original packet and the remote host reply. |
| Timeout | A timeout for the component. |
| TimeToLive | The time to live (TTL) value for the ICMP packets sent by the component. |
| 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.
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| Interrupt | Interrupt the current method. |
| PingHost | Pings a host. |
| 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.
| TimeoutInMilliseconds | The timeout is treated as milliseconds. |
| IcmpDllTimeout | The timeout for the component 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 component. |
| UseConnection | Determines whether to use a connected socket. |
| TimeoutInMilliseconds | The timeout is treated as milliseconds. |
| UseICMPDLL | Use the icmp.dll included on Windows Systems. |
| UseIPHLPDLL | Use the iphlpapi.dll included on Windows Systems. |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |