source: trunk/Packages/synapse/docs/help/pingsend.TPINGSend.html

Last change on this file was 2, checked in by chronos, 13 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 9.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2<html>
3<head>
4<meta name="GENERATOR" content="PasDoc 0.9.0">
5<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
6<title>pingsend: Class TPINGSend</title>
7<link rel="StyleSheet" type="text/css" href="pasdoc.css">
8</head>
9<body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
10<a name="TPINGSend"></a><h1 class="cio">Class TPINGSend</h1>
11<table class="sections">
12<tr>
13<td><a class="section" href="#@Description">Description</a></td><td><a class="section" href="#@Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#@Methods">Methods</a></td><td><a class="section" href="#@Properties">Properties</a></td></tr></table>
14<a name="@Description"></a><h2 class="unit">Unit</h2>
15<p class="unitlink">
16<a href="pingsend.html">pingsend</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TPINGSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of ICMP PING and ICMPv6 PING.</p>
23<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
24<ul class="hierarchy"><li class="ancestor">TObject</li>
25<li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
26<li class="thisitem">TPINGSend</li></ul><h2 class="overview">Overview</h2>
27<a name="@Methods"></a><h3 class="summary">Methods</h3>
28<table class="summary">
29<tr class="list">
30<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
31<td class="itemcode"><code>function <b><a href="pingsend.TPINGSend.html#Ping">Ping</a></b>(const Host: string): Boolean;</code></td>
32</tr>
33<tr class="list2">
34<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
35<td class="itemcode"><code>constructor <b><a href="pingsend.TPINGSend.html#Create">Create</a></b>;</code></td>
36</tr>
37<tr class="list">
38<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
39<td class="itemcode"><code>destructor <b><a href="pingsend.TPINGSend.html#Destroy">Destroy</a></b>; override;</code></td>
40</tr>
41</table>
42<a name="@Properties"></a><h3 class="summary">Properties</h3>
43<table class="summary">
44<tr class="list">
45<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
46<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#PacketSize">PacketSize</a></b>: Integer read FPacketSize Write FPacketSize;</code></td>
47</tr>
48<tr class="list2">
49<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
50<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#PingTime">PingTime</a></b>: Integer read FPingTime;</code></td>
51</tr>
52<tr class="list">
53<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
54<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#ReplyFrom">ReplyFrom</a></b>: string read FReplyFrom;</code></td>
55</tr>
56<tr class="list2">
57<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
58<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#ReplyType">ReplyType</a></b>: byte read FReplyType;</code></td>
59</tr>
60<tr class="list">
61<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
62<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#ReplyCode">ReplyCode</a></b>: byte read FReplyCode;</code></td>
63</tr>
64<tr class="list2">
65<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
66<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#ReplyError">ReplyError</a></b>: <a href="pingsend.html#TICMPError">TICMPError</a> read FReplyError;</code></td>
67</tr>
68<tr class="list">
69<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
70<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#ReplyErrorDesc">ReplyErrorDesc</a></b>: string read FReplyErrorDesc;</code></td>
71</tr>
72<tr class="list2">
73<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
74<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#Sock">Sock</a></b>: <a href="blcksock.TICMPBlockSocket.html">TICMPBlockSocket</a> read FSock;</code></td>
75</tr>
76<tr class="list">
77<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
78<td class="itemcode"><code>property <b><a href="pingsend.TPINGSend.html#TTL">TTL</a></b>: byte read FTTL write FTTL;</code></td>
79</tr>
80</table>
81<h2 class="description">Description</h2>
82<h3 class="detail">Methods</h3>
83<table class="detail">
84<tr class="list">
85<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
86<td class="itemcode"><a name="Ping"></a><code>function <b>Ping</b>(const Host: string): Boolean;</code></td>
87</tr>
88</table>
89<p>
90Send ICMP ping to host and count <a class="normal" href="pingsend.TPINGSend.html#PingTime">PingTime</a>. If ping OK, result is <code>True</code>.</p>
91<table class="detail">
92<tr class="list">
93<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
94<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
95</tr>
96</table>
97&nbsp;<table class="detail">
98<tr class="list">
99<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
100<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
101</tr>
102</table>
103&nbsp;<h3 class="detail">Properties</h3>
104<table class="detail">
105<tr class="list">
106<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
107<td class="itemcode"><a name="PacketSize"></a><code>property <b>PacketSize</b>: Integer read FPacketSize Write FPacketSize;</code></td>
108</tr>
109</table>
110<p>
111Size of PING packet. Default size is 32 bytes.</p>
112<table class="detail">
113<tr class="list">
114<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
115<td class="itemcode"><a name="PingTime"></a><code>property <b>PingTime</b>: Integer read FPingTime;</code></td>
116</tr>
117</table>
118<p>
119Time between request and reply.</p>
120<table class="detail">
121<tr class="list">
122<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
123<td class="itemcode"><a name="ReplyFrom"></a><code>property <b>ReplyFrom</b>: string read FReplyFrom;</code></td>
124</tr>
125</table>
126<p>
127From this address is sended reply for your PING request. It maybe not your requested destination, when some error occured!</p>
128<table class="detail">
129<tr class="list">
130<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
131<td class="itemcode"><a name="ReplyType"></a><code>property <b>ReplyType</b>: byte read FReplyType;</code></td>
132</tr>
133</table>
134<p>
135ICMP type of PING reply. Each protocol using another values! For IPv4 and IPv6 are used different values!</p>
136<table class="detail">
137<tr class="list">
138<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
139<td class="itemcode"><a name="ReplyCode"></a><code>property <b>ReplyCode</b>: byte read FReplyCode;</code></td>
140</tr>
141</table>
142<p>
143ICMP code of PING reply. Each protocol using another values! For IPv4 and IPv6 are used different values! For protocol independent value look to <a class="normal" href="pingsend.TPINGSend.html#ReplyError">ReplyError</a></p>
144<table class="detail">
145<tr class="list">
146<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
147<td class="itemcode"><a name="ReplyError"></a><code>property <b>ReplyError</b>: <a href="pingsend.html#TICMPError">TICMPError</a> read FReplyError;</code></td>
148</tr>
149</table>
150<p>
151Return type of returned ICMP message. This value is independent on used protocol!</p>
152<table class="detail">
153<tr class="list">
154<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
155<td class="itemcode"><a name="ReplyErrorDesc"></a><code>property <b>ReplyErrorDesc</b>: string read FReplyErrorDesc;</code></td>
156</tr>
157</table>
158<p>
159Return human readable description of returned packet type.</p>
160<table class="detail">
161<tr class="list">
162<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
163<td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TICMPBlockSocket.html">TICMPBlockSocket</a> read FSock;</code></td>
164</tr>
165</table>
166<p>
167Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.</p>
168<table class="detail">
169<tr class="list">
170<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
171<td class="itemcode"><a name="TTL"></a><code>property <b>TTL</b>: byte read FTTL write FTTL;</code></td>
172</tr>
173</table>
174<p>
175TTL value for ICMP query</p>
176<hr noshade size="1"><span class="appinfo"><em>Generated by <a target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.9.0</a> on 2012-04-23 21:38:51</em>
177</span>
178</body></html>
Note: See TracBrowser for help on using the repository browser.