ICMPPort Class

Properties   Methods   Events   Configuration Settings   Errors  

The ICMPPort component is used to facilitate ICMP communications. It can act both as a client and a server and communicate with any number of hosts simultaneously, as well as generate and receive broadcast packets.

Class Name

IPWorks_ICMPPort

Procedural Interface

 ipworks_icmpport_open();
 ipworks_icmpport_close($res);
 ipworks_icmpport_register_callback($res, $id, $function);
 ipworks_icmpport_get_last_error($res);
 ipworks_icmpport_get_last_error_code($res);
 ipworks_icmpport_set($res, $id, $index, $value);
 ipworks_icmpport_get($res, $id, $index);
 ipworks_icmpport_do_config($res, $configurationstring);
 ipworks_icmpport_do_doevents($res);
 ipworks_icmpport_do_send($res, $text);

Remarks

The interface of the class is similar to the interface of IPPort, only much simpler. The class is activated/deactivated by using the Active property. This property enables or disables sends or receives. Data can be sent in the same way as IPPort, using the Send method and Text parameter or the DataToSend property. 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 config 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 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 to using blocking calls.