Products
Support
Downloads
Purchase
Company
Subscriptions
Search: 
Available in: IP*WORKS!
Ping Class
Ping Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The Ping component encapsulates ICMP ECHO functionality, used to check whether there is a communications link between two computers.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

When the PingHost method is called with the Host parameter, or RemoteHost is assigned an IP address or domain name, the component 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 component operates synchronously by default (waits for a response before returning control to the caller), however, the component 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 component with short descriptions. Click on the links for complete descriptions.

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.
TimeToLive The time to live (TTL) value for the ICMP packets sent by the component.
Timeout A timeout for 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 component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component configuration setting.
DoEvents Processes events from the internal message queue.
Interrupt Interrupt the current method.
PingHost Ping a host.
WakeOnLAN Sends a Wake-On-LAN packet.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

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 component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
IcmpDllTimeout The timeout for the component when using the icmp.dll.
InBufferSize The size in bytes of the incoming queue of the socket.
MaxMessageSize The maximum length of the messages that can be received.
OutBufferSize The size in bytes of the outgoing queue of the socket.
TimeoutInMilliseconds The timeout is treated as milliseconds.
UseConnection Determines whether to use a connected socket.
UseICMPDLL Use the icmp.dll included on Windows Systems

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