Search: 
Available in: IP*WORKS!
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 further details.

ActiveEnables or disables receiving of data.
IdleThe current status of the component.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
PacketSizeThe size of the packet to send as the ping request.
RemoteHostThe address of the RemoteHost. Domain names are resolved to IP addresses.
RequestIdA unique identifier for outgoing packets.
ResponseSourceThe source of the last PING response.
ResponseTimeTime elapsed between sending the original packet and the remote host reply.
TimeoutA timeout for the component.
TimeToLiveThe time to live (TTL) value for the ICMP packets sent by the component.
TypeOfServiceThe 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 further details.

ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
PingHostPing a host.
WakeOnLANSends 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 further details.

ErrorInformation about errors during data delivery.
ResponseFired 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 further details.

TimeoutInMillisecondsThe timeout is treated as milliseconds
IcmpDllTimeoutThe timeout for the component when using the icmp.dll
MaxMessageSizeThe maximum length of the messages that can be received
UseConnectionDetermines whether to use a connected socket
TimeoutInMillisecondsThe timeout is treated as milliseconds
UseICMPDLLUse the icmp.dll included on Windows Systems
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts
FirewallDataUsed to send extra data to the firewall
InBufferSizeThe size in bytes of the incoming queue of the socket
OutBufferSizeThe size in bytes of the outgoing queue of the socket
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only)

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