source: trunk/Packages/synapse/docs/help/ftptsend.TTFTPSend.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: 10.7 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>ftptsend: Class TTFTPSend</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="TTFTPSend"></a><h1 class="cio">Class TTFTPSend</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="ftptsend.html">ftptsend</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TTFTPSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of TFTP client and server</p>
23<p>
24 Note: Are you missing properties for specify server address and port? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> too!</p>
25<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
26<ul class="hierarchy"><li class="ancestor">TObject</li>
27<li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
28<li class="thisitem">TTFTPSend</li></ul><h2 class="overview">Overview</h2>
29<a name="@Methods"></a><h3 class="summary">Methods</h3>
30<table class="summary">
31<tr class="list">
32<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
33<td class="itemcode"><code>constructor <b><a href="ftptsend.TTFTPSend.html#Create">Create</a></b>;</code></td>
34</tr>
35<tr class="list2">
36<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
37<td class="itemcode"><code>destructor <b><a href="ftptsend.TTFTPSend.html#Destroy">Destroy</a></b>; override;</code></td>
38</tr>
39<tr class="list">
40<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
41<td class="itemcode"><code>function <b><a href="ftptsend.TTFTPSend.html#SendFile">SendFile</a></b>(const Filename: string): Boolean;</code></td>
42</tr>
43<tr class="list2">
44<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
45<td class="itemcode"><code>function <b><a href="ftptsend.TTFTPSend.html#RecvFile">RecvFile</a></b>(const Filename: string): Boolean;</code></td>
46</tr>
47<tr class="list">
48<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
49<td class="itemcode"><code>function <b><a href="ftptsend.TTFTPSend.html#WaitForRequest">WaitForRequest</a></b>(var Req: word; var filename: string): Boolean;</code></td>
50</tr>
51<tr class="list2">
52<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
53<td class="itemcode"><code>procedure <b><a href="ftptsend.TTFTPSend.html#ReplyError">ReplyError</a></b>(Error: word; Description: string);</code></td>
54</tr>
55<tr class="list">
56<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
57<td class="itemcode"><code>function <b><a href="ftptsend.TTFTPSend.html#ReplyRecv">ReplyRecv</a></b>: Boolean;</code></td>
58</tr>
59<tr class="list2">
60<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
61<td class="itemcode"><code>function <b><a href="ftptsend.TTFTPSend.html#ReplySend">ReplySend</a></b>: Boolean;</code></td>
62</tr>
63</table>
64<a name="@Properties"></a><h3 class="summary">Properties</h3>
65<table class="summary">
66<tr class="list">
67<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
68<td class="itemcode"><code>property <b><a href="ftptsend.TTFTPSend.html#ErrorCode">ErrorCode</a></b>: integer read FErrorCode;</code></td>
69</tr>
70<tr class="list2">
71<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
72<td class="itemcode"><code>property <b><a href="ftptsend.TTFTPSend.html#ErrorString">ErrorString</a></b>: string read FErrorString;</code></td>
73</tr>
74<tr class="list">
75<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
76<td class="itemcode"><code>property <b><a href="ftptsend.TTFTPSend.html#Data">Data</a></b>: TMemoryStream read FData;</code></td>
77</tr>
78<tr class="list2">
79<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
80<td class="itemcode"><code>property <b><a href="ftptsend.TTFTPSend.html#RequestIP">RequestIP</a></b>: string read FRequestIP write FRequestIP;</code></td>
81</tr>
82<tr class="list">
83<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
84<td class="itemcode"><code>property <b><a href="ftptsend.TTFTPSend.html#RequestPort">RequestPort</a></b>: string read FRequestPort write FRequestPort;</code></td>
85</tr>
86</table>
87<h2 class="description">Description</h2>
88<h3 class="detail">Methods</h3>
89<table class="detail">
90<tr class="list">
91<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
92<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
93</tr>
94</table>
95&nbsp;<table class="detail">
96<tr class="list">
97<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
98<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
99</tr>
100</table>
101&nbsp;<table class="detail">
102<tr class="list">
103<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
104<td class="itemcode"><a name="SendFile"></a><code>function <b>SendFile</b>(const Filename: string): Boolean;</code></td>
105</tr>
106</table>
107<p>
108Upload <a class="normal" href="ftptsend.TTFTPSend.html#Data">Data</a> as file to TFTP server.</p>
109<table class="detail">
110<tr class="list">
111<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
112<td class="itemcode"><a name="RecvFile"></a><code>function <b>RecvFile</b>(const Filename: string): Boolean;</code></td>
113</tr>
114</table>
115<p>
116Download file from TFTP server to <a class="normal" href="ftptsend.TTFTPSend.html#Data">Data</a>.</p>
117<table class="detail">
118<tr class="list">
119<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
120<td class="itemcode"><a name="WaitForRequest"></a><code>function <b>WaitForRequest</b>(var Req: word; var filename: string): Boolean;</code></td>
121</tr>
122</table>
123<p>
124Acts as TFTP server and wait for client request. When some request incoming within Timeout, result is <code>True</code> and parametres is filled with information from request. You must handle this request, validate it, and call <a class="normal" href="ftptsend.TTFTPSend.html#ReplyError">ReplyError</a>, <a class="normal" href="ftptsend.TTFTPSend.html#ReplyRecv">ReplyRecv</a> or <a class="normal" href="ftptsend.TTFTPSend.html#ReplySend">ReplySend</a> for send reply to TFTP Client.</p>
125<table class="detail">
126<tr class="list">
127<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
128<td class="itemcode"><a name="ReplyError"></a><code>procedure <b>ReplyError</b>(Error: word; Description: string);</code></td>
129</tr>
130</table>
131<p>
132send error to TFTP client, when you acts as TFTP server.</p>
133<table class="detail">
134<tr class="list">
135<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
136<td class="itemcode"><a name="ReplyRecv"></a><code>function <b>ReplyRecv</b>: Boolean;</code></td>
137</tr>
138</table>
139<p>
140Accept uploaded file from TFTP client to <a class="normal" href="ftptsend.TTFTPSend.html#Data">Data</a>, when you acts as TFTP server.</p>
141<table class="detail">
142<tr class="list">
143<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
144<td class="itemcode"><a name="ReplySend"></a><code>function <b>ReplySend</b>: Boolean;</code></td>
145</tr>
146</table>
147<p>
148Accept download request file from TFTP client and send content of <a class="normal" href="ftptsend.TTFTPSend.html#Data">Data</a>, when you acts as TFTP server.</p>
149<h3 class="detail">Properties</h3>
150<table class="detail">
151<tr class="list">
152<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
153<td class="itemcode"><a name="ErrorCode"></a><code>property <b>ErrorCode</b>: integer read FErrorCode;</code></td>
154</tr>
155</table>
156<p>
157Code of TFTP error.</p>
158<table class="detail">
159<tr class="list">
160<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
161<td class="itemcode"><a name="ErrorString"></a><code>property <b>ErrorString</b>: string read FErrorString;</code></td>
162</tr>
163</table>
164<p>
165Human readable decription of TFTP error. (if is sended by remote side)</p>
166<table class="detail">
167<tr class="list">
168<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
169<td class="itemcode"><a name="Data"></a><code>property <b>Data</b>: TMemoryStream read FData;</code></td>
170</tr>
171</table>
172<p>
173MemoryStream with datas for sending or receiving</p>
174<table class="detail">
175<tr class="list">
176<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
177<td class="itemcode"><a name="RequestIP"></a><code>property <b>RequestIP</b>: string read FRequestIP write FRequestIP;</code></td>
178</tr>
179</table>
180<p>
181Address of TFTP remote side.</p>
182<table class="detail">
183<tr class="list">
184<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
185<td class="itemcode"><a name="RequestPort"></a><code>property <b>RequestPort</b>: string read FRequestPort write FRequestPort;</code></td>
186</tr>
187</table>
188<p>
189Port of TFTP remote side.</p>
190<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:50</em>
191</span>
192</body></html>
Note: See TracBrowser for help on using the repository browser.