IP*Works! ICMP Component : ICMP OCX, ICMP .NET Component, ICMP Class, ICMP Bean, ICMP Object

Available in: IP*WORKS!

Icmpport Class

ICMPPort Component [IP*Works! V8]

Properties Methods Events Configuration Settings

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.

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

The interface of the component is similar to the interface of IPPort, only much simpler. The component 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 component 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 component 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 component 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.

Property List

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


AcceptData	Enables or disables data reception (the DataIn event).
Active	Enables or disables sending and receiving of data.
DataToSend	A string of data to be sent to the remote host. Write-only property.
DontRoute	If set to True, forces the socket to send data directly to interface (no routing).
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageSubType	The subtype of the ICMP message (part of the ICMP header).
MessageType	The type of the ICMP message (part of the ICMP header).
RemoteHost	The address of the RemoteHost. Domain names are resolved to IP addresses.
TimeToLive	The time to live (TTL) value for the ICMP packets sent by the component.

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.
Send	Send data to the remote host.

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.


DataIn	Fired when new ICMP messages come in.
Error	Information about errors during data delivery.
ReadyToSend	Fired when the component is ready to send data.

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