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.

Class Name

IPWorks_Ping

Procedural Interface

 ipworks_ping_open();
 ipworks_ping_close($res);
 ipworks_ping_register_callback($res, $id, $function);
 ipworks_ping_get_last_error($res);
 ipworks_ping_get_last_error_code($res);
 ipworks_ping_set($res, $id, $index, $value);
 ipworks_ping_get($res, $id, $index);
 ipworks_ping_do_config($res, $configurationstring);
 ipworks_ping_do_doevents($res);
 ipworks_ping_do_interrupt($res);
 ipworks_ping_do_pinghost($res, $host);
 ipworks_ping_do_wakeonlan($res, $remotehost, $macaddress);

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.