Difference between revisions of "TPing"

From Overbyte
Jump to navigation Jump to search
(broken links fixed)
 
(15 intermediate revisions by the same user not shown)
Line 16: Line 16:
 
{|  
 
{|  
 
| width="140" valign="top" | [[TPing.Address | Address]] |||| The host's IP or DNS address which will be pinged.
 
| width="140" valign="top" | [[TPing.Address | Address]] |||| The host's IP or DNS address which will be pinged.
 +
|-
 +
| valign="top" | [[TPing.DNSResult | DNSResult]] |||| The IP address of the remote host if it was specified as DNS address in address property
 +
|-
 +
| valign="top" | [[TPing.ErrorCode | ErrorCode]] |||| Numerical error code of the ping operation.
 +
|-
 +
| valign="top" | [[TPing.ErrorString | ErrorString]] |||| Textual error message.
 
|-
 
|-
 
| valign="top" | [[TPing.Flags | Flags]] |||| Integer?
 
| valign="top" | [[TPing.Flags | Flags]] |||| Integer?
 +
|-
 +
| valign="top" | [[TPing.Handle | Handle]] |||| Handle for the underlying hidden window
 +
|-
 +
| valign="top" | [[TPing.HostIP | HostIP]] |||| ???
 +
|-
 +
| valign="top" | [[TPing.HostName | HostName]] |||| ???
 +
|-
 +
| valign="top" | [[TPing.ICMPDLLHandle | ICMPDLLHandle]] |||| ???
 +
|-
 +
| valign="top" | [[TPing.LastErrStr | LastErrStr]] |||| ???
 +
|-
 +
| valign="top" | [[TPing.Multithreaded | Multithreaded]] |||| Set when component must use its own message pump.
 
|-
 
|-
 
| valign="top" | [[TPing.Name | Name]] |||| Name of the instance.
 
| valign="top" | [[TPing.Name | Name]] |||| Name of the instance.
 +
|-
 +
| valign="top" | [[TPing.PingMsg | PingMsg]] |||| Text to be sent as content of the ICMP packet sent via [[Ping.Ping|Ping]].
 +
|-
 +
| valign="top" | [[TPing.ReplyIP | ReplyIP]] |||| ?.
 +
|-
 +
| valign="top" | [[TPing.ReplyIPv6 | ReplyIPv6]] |||| ?.
 +
|-
 +
| valign="top" | [[TPing.ReplyRTT | ReplyRTT]] |||| ?.
 +
|-
 +
| valign="top" | [[TPing.ReplySize | ReplySize]] |||| ?.
 +
|-
 +
| valign="top" | [[TPing.ReplyStatus | ReplyStatus]] |||| ?.
 
|-
 
|-
 
| valign="top" | [[TPing.Size | Size]] |||| Size of the ICMP packet sent in bytes.
 
| valign="top" | [[TPing.Size | Size]] |||| Size of the ICMP packet sent in bytes.
 +
|-
 +
| valign="top" | [[TPing.SocketFamily | SocketFamily]] |||| Kind of the socket to be used: IPv4, IPv6....
 +
|-
 +
| valign="top" | [[TPing.SrcAddress | ScrAddress]] |||| Source address of the host starting the ping?
 +
|-
 +
| valign="top" | [[TPing.SrcAddress6 | ScrAddress6]] |||| The same as SrcAddress but for IPv6
 
|-
 
|-
 
| valign="top" | [[TPing.Tag | Tag]] |||| Integer value which can be used for your own purposes, e.g. when iterating through all controls of a form.
 
| valign="top" | [[TPing.Tag | Tag]] |||| Integer value which can be used for your own purposes, e.g. when iterating through all controls of a form.
 +
|-
 +
| valign="top" | [[TPing.Terminated | Terminated]] |||| ???
 +
|-
 +
| valign="top" | [[TPing.ThreadID | ThreadID]] |||| ???
 
|-
 
|-
 
| valign="top" | [[TPing.Timeout | Timeout]] |||| Time in miliseconds which may elapse between sending and receiving the ICMP packet.
 
| valign="top" | [[TPing.Timeout | Timeout]] |||| Time in miliseconds which may elapse between sending and receiving the ICMP packet.
 
|-
 
|-
 
| valign="top" | [[TPing.TTL | TTL]] |||| Sets the [[Glossary#TTL|Time To Live]] value within the packet being sent.
 
| valign="top" | [[TPing.TTL | TTL]] |||| Sets the [[Glossary#TTL|Time To Live]] value within the packet being sent.
 +
|-
 +
| valign="top" | [[TPing.WndHandler | WndHandler]] |||| ???
 
|}
 
|}
  
 
== Methods ==
 
== Methods ==
  
−
{|  
+
{|
−
| width="140" valign="top" | [[Ping.Ping | Ping]] |||| Sends the ICMP packet.
+
| width="140" valign="top" | [[Ping.CancelDNSLookup | CancelDNSLookup]] |||| Cancel a running DNS lookup.
 +
|-
 +
| width="140" valign="top" | [[Ping.Create | Create]] |||| Create the instance.
 +
|-
 +
| width="140" valign="top" | [[Ping.DNSLookup | DNSLoopup]] |||| Look up the IP to a given DNS address.
 +
|-
 +
| width="140" valign="top" | [[Ping.MessageLoop | MessageLoop]] |||| ???
 +
|-
 +
| width="140" valign="top" | [[Ping.MessagePump | MessagePump]] |||| ???
 +
|-
 +
| width="140" valign="top" | [[Ping.Ping | Ping]] |||| Synchronously sends the ICMP packet.
 +
|-
 +
| width="140" valign="top" | [[Ping.PingAsync | PingAsync]] |||| Asynchronously sends the ICMP packet.
 +
|-
 +
| width="140" valign="top" | [[Ping.PostQuitMessage| PostQuitMessage]] |||| ???
 +
|-
 +
| width="140" valign="top" | [[Ping.ProcessMessage | ProcessMessage]] |||| ???
 +
|-
 +
| width="140" valign="top" | [[Ping.ProcessMessages | ProcessMessages]] |||| ???
 +
|-
 +
| width="140" valign="top" | [[Ping.TThreadAttach | ThreadAttach]] |||| Attach to the current thread.
 +
|-
 +
| width="140" valign="top" | [[Ping.ThreadDetach | ThreadDetach]] |||| Detach from the current thread.
 
|}
 
|}
  
Line 39: Line 103:
  
 
{|
 
{|
−
| width="140" valign="top" | [[TPing.OnDisplay | OnDisplay]] |||| ?.
+
| width="140" valign="top" | [[TPing.BgException | BgException]] |||| ?.
 +
|-
 +
| valign="top" | [[TPing.OnDisplay | OnDisplay]] |||| ?.
 +
|-
 +
| valign="top" | [[TPing.OnDNSLookupDone | OnDNSLookupDone]] |||| Called when the [[TPing.DNSLookuop|DNSLookup]] has been finished.
 
|-
 
|-
 
| valign="top" | [[TPing.OnEchoReply | OnEchoReply]] |||| Called when the answer to the ping arrive.
 
| valign="top" | [[TPing.OnEchoReply | OnEchoReply]] |||| Called when the answer to the ping arrive.
 +
|-
 +
| valign="top" | [[TPing.OnEchoRequest | OnEchoRequest]] |||| Called when the request is being sent.
 
|}
 
|}
  
 
== How to ==
 
== How to ==
  
−
* [[TPing.HowTo.Ping | Ping a single host]]
+
* [[Ping.Ping | Ping a single host]]
−
* [[TPing.HowTo.PingThread | Ping a host in the background]]
+
* [[Ping.PingAsync | Ping a host in the background]]
  
 
{{Components_Footer}}
 
{{Components_Footer}}

Latest revision as of 10:46, 2 February 2019

Main page -> ICS component reference -> TPing

Overview

unit Ping.pas
inheritance

The TPing component implements at least parts of the ICMP protocoll.

It can be used to check whether some other host is reachable or not.

Properties

Address The host's IP or DNS address which will be pinged.
DNSResult The IP address of the remote host if it was specified as DNS address in address property
ErrorCode Numerical error code of the ping operation.
ErrorString Textual error message.
Flags Integer?
Handle Handle for the underlying hidden window
HostIP ???
HostName ???
ICMPDLLHandle ???
LastErrStr ???
Multithreaded Set when component must use its own message pump.
Name Name of the instance.
PingMsg Text to be sent as content of the ICMP packet sent via Ping.
ReplyIP ?.
ReplyIPv6 ?.
ReplyRTT ?.
ReplySize ?.
ReplyStatus ?.
Size Size of the ICMP packet sent in bytes.
SocketFamily Kind of the socket to be used: IPv4, IPv6....
ScrAddress Source address of the host starting the ping?
ScrAddress6 The same as SrcAddress but for IPv6
Tag Integer value which can be used for your own purposes, e.g. when iterating through all controls of a form.
Terminated ???
ThreadID ???
Timeout Time in miliseconds which may elapse between sending and receiving the ICMP packet.
TTL Sets the Time To Live value within the packet being sent.
WndHandler ???

Methods

CancelDNSLookup Cancel a running DNS lookup.
Create Create the instance.
DNSLoopup Look up the IP to a given DNS address.
MessageLoop ???
MessagePump ???
Ping Synchronously sends the ICMP packet.
PingAsync Asynchronously sends the ICMP packet.
PostQuitMessage ???
ProcessMessage ???
ProcessMessages ???
ThreadAttach Attach to the current thread.
ThreadDetach Detach from the current thread.

Events

BgException ?.
OnDisplay ?.
OnDNSLookupDone Called when the DNSLookup has been finished.
OnEchoReply Called when the answer to the ping arrive.
OnEchoRequest Called when the request is being sent.

How to


ICS Components Reference

Retrieved from "http://wiki.overbyte.eu/wiki/index.php?title=TPing&oldid=3500"