source: trunk/Packages/synapse/docs/help/httpsend.THTTPSend.html

Last change on this file was 2, checked in by chronos, 12 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 21.4 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>httpsend: Class THTTPSend</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="THTTPSend"></a><h1 class="cio">Class THTTPSend</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="httpsend.html">httpsend</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type THTTPSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22abstract(Implementation of HTTP protocol.)</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">THTTPSend</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>constructor <b><a href="httpsend.THTTPSend.html#Create">Create</a></b>;</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>destructor <b><a href="httpsend.THTTPSend.html#Destroy">Destroy</a></b>; override;</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>procedure <b><a href="httpsend.THTTPSend.html#Clear">Clear</a></b>;</code></td>
40</tr>
41<tr class="list2">
42<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
43<td class="itemcode"><code>procedure <b><a href="httpsend.THTTPSend.html#DecodeStatus">DecodeStatus</a></b>(const Value: string);</code></td>
44</tr>
45<tr class="list">
46<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
47<td class="itemcode"><code>function <b><a href="httpsend.THTTPSend.html#HTTPMethod">HTTPMethod</a></b>(const Method, URL: string): Boolean;</code></td>
48</tr>
49<tr class="list2">
50<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
51<td class="itemcode"><code>procedure <b><a href="httpsend.THTTPSend.html#Abort">Abort</a></b>;</code></td>
52</tr>
53</table>
54<a name="@Properties"></a><h3 class="summary">Properties</h3>
55<table class="summary">
56<tr class="list">
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="httpsend.THTTPSend.html#Headers">Headers</a></b>: TStringList read FHeaders;</code></td>
59</tr>
60<tr class="list2">
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="httpsend.THTTPSend.html#Cookies">Cookies</a></b>: TStringList read FCookies;</code></td>
63</tr>
64<tr class="list">
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="httpsend.THTTPSend.html#Document">Document</a></b>: TMemoryStream read FDocument;</code></td>
67</tr>
68<tr class="list2">
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="httpsend.THTTPSend.html#RangeStart">RangeStart</a></b>: integer read FRangeStart Write FRangeStart;</code></td>
71</tr>
72<tr class="list">
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="httpsend.THTTPSend.html#RangeEnd">RangeEnd</a></b>: integer read FRangeEnd Write FRangeEnd;</code></td>
75</tr>
76<tr class="list2">
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="httpsend.THTTPSend.html#MimeType">MimeType</a></b>: string read FMimeType Write FMimeType;</code></td>
79</tr>
80<tr class="list">
81<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
82<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#Protocol">Protocol</a></b>: string read FProtocol Write FProtocol;</code></td>
83</tr>
84<tr class="list2">
85<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
86<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#KeepAlive">KeepAlive</a></b>: Boolean read FKeepAlive Write FKeepAlive;</code></td>
87</tr>
88<tr class="list">
89<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
90<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#KeepAliveTimeout">KeepAliveTimeout</a></b>: integer read FKeepAliveTimeout Write FKeepAliveTimeout;</code></td>
91</tr>
92<tr class="list2">
93<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
94<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#Status100">Status100</a></b>: Boolean read FStatus100 Write FStatus100;</code></td>
95</tr>
96<tr class="list">
97<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
98<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#ProxyHost">ProxyHost</a></b>: string read FProxyHost Write FProxyHost;</code></td>
99</tr>
100<tr class="list2">
101<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
102<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#ProxyPort">ProxyPort</a></b>: string read FProxyPort Write FProxyPort;</code></td>
103</tr>
104<tr class="list">
105<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
106<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#ProxyUser">ProxyUser</a></b>: string read FProxyUser Write FProxyUser;</code></td>
107</tr>
108<tr class="list2">
109<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
110<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#ProxyPass">ProxyPass</a></b>: string read FProxyPass Write FProxyPass;</code></td>
111</tr>
112<tr class="list">
113<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
114<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#UserAgent">UserAgent</a></b>: string read FUserAgent Write FUserAgent;</code></td>
115</tr>
116<tr class="list2">
117<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
118<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#ResultCode">ResultCode</a></b>: Integer read FResultCode;</code></td>
119</tr>
120<tr class="list">
121<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
122<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#ResultString">ResultString</a></b>: string read FResultString;</code></td>
123</tr>
124<tr class="list2">
125<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
126<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#DownloadSize">DownloadSize</a></b>: integer read FDownloadSize;</code></td>
127</tr>
128<tr class="list">
129<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
130<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#UploadSize">UploadSize</a></b>: integer read FUploadSize;</code></td>
131</tr>
132<tr class="list2">
133<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
134<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#Sock">Sock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
135</tr>
136<tr class="list">
137<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
138<td class="itemcode"><code>property <b><a href="httpsend.THTTPSend.html#AddPortNumberToHost">AddPortNumberToHost</a></b>: Boolean read FAddPortNumberToHost write FAddPortNumberToHost;</code></td>
139</tr>
140</table>
141<h2 class="description">Description</h2>
142<h3 class="detail">Methods</h3>
143<table class="detail">
144<tr class="list">
145<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
146<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
147</tr>
148</table>
149&nbsp;<table class="detail">
150<tr class="list">
151<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
152<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
153</tr>
154</table>
155&nbsp;<table class="detail">
156<tr class="list">
157<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
158<td class="itemcode"><a name="Clear"></a><code>procedure <b>Clear</b>;</code></td>
159</tr>
160</table>
161<p>
162Reset headers and document and Mimetype.</p>
163<table class="detail">
164<tr class="list">
165<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
166<td class="itemcode"><a name="DecodeStatus"></a><code>procedure <b>DecodeStatus</b>(const Value: string);</code></td>
167</tr>
168</table>
169<p>
170Decode ResultCode and ResultString from Value.</p>
171<table class="detail">
172<tr class="list">
173<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
174<td class="itemcode"><a name="HTTPMethod"></a><code>function <b>HTTPMethod</b>(const Method, URL: string): Boolean;</code></td>
175</tr>
176</table>
177<p>
178Connects to host define in URL and access to resource defined in URL by method. If Document is not empty, send it to server as part of HTTP request. Server response is in Document and headers. Connection may be authorised by username and password in URL. If you define proxy properties, connection is made by this proxy. If all OK, result is <code>True</code>, else result is <code>False</code>.
179
180<p>If you use in URL 'https:' instead only 'http:', then your request is made by SSL/TLS connection (if you not specify port, then port 443 is used instead standard port 80). If you use SSL/TLS request and you have defined HTTP proxy, then HTTP-tunnel mode is automaticly used .</p>
181<table class="detail">
182<tr class="list">
183<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
184<td class="itemcode"><a name="Abort"></a><code>procedure <b>Abort</b>;</code></td>
185</tr>
186</table>
187<p>
188You can call this method from OnStatus event for break current data transfer. (or from another thread.)</p>
189<h3 class="detail">Properties</h3>
190<table class="detail">
191<tr class="list">
192<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
193<td class="itemcode"><a name="Headers"></a><code>property <b>Headers</b>: TStringList read FHeaders;</code></td>
194</tr>
195</table>
196<p>
197Before HTTP operation you may define any non-standard headers for HTTP request, except of: 'Expect: 100-continue', 'Content-Length', 'Content-Type', 'Connection', 'Authorization', 'Proxy-Authorization' and 'Host' headers. After HTTP operation contains full headers of returned document.</p>
198<table class="detail">
199<tr class="list">
200<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
201<td class="itemcode"><a name="Cookies"></a><code>property <b>Cookies</b>: TStringList read FCookies;</code></td>
202</tr>
203</table>
204<p>
205This is stringlist with name-value stringlist pairs. Each this pair is one cookie. After HTTP request is returned cookies parsed to this stringlist. You can leave this cookies untouched for next HTTP request. You can also save this stringlist for later use.</p>
206<table class="detail">
207<tr class="list">
208<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
209<td class="itemcode"><a name="Document"></a><code>property <b>Document</b>: TMemoryStream read FDocument;</code></td>
210</tr>
211</table>
212<p>
213Stream with document to send (before request, or with document received from HTTP server (after request).</p>
214<table class="detail">
215<tr class="list">
216<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
217<td class="itemcode"><a name="RangeStart"></a><code>property <b>RangeStart</b>: integer read FRangeStart Write FRangeStart;</code></td>
218</tr>
219</table>
220<p>
221If you need download only part of requested document, here specify possition of subpart begin. If here 0, then is requested full document.</p>
222<table class="detail">
223<tr class="list">
224<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
225<td class="itemcode"><a name="RangeEnd"></a><code>property <b>RangeEnd</b>: integer read FRangeEnd Write FRangeEnd;</code></td>
226</tr>
227</table>
228<p>
229If you need download only part of requested document, here specify possition of subpart end. If here 0, then is requested document from rangeStart to end of document. (for broken download restoration, for example.)</p>
230<table class="detail">
231<tr class="list">
232<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
233<td class="itemcode"><a name="MimeType"></a><code>property <b>MimeType</b>: string read FMimeType Write FMimeType;</code></td>
234</tr>
235</table>
236<p>
237Mime type of sending data. Default is: 'text/html'.</p>
238<table class="detail">
239<tr class="list">
240<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
241<td class="itemcode"><a name="Protocol"></a><code>property <b>Protocol</b>: string read FProtocol Write FProtocol;</code></td>
242</tr>
243</table>
244<p>
245Define protocol version. Possible values are: '1.1', '1.0' (default) and '0.9'.</p>
246<table class="detail">
247<tr class="list">
248<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
249<td class="itemcode"><a name="KeepAlive"></a><code>property <b>KeepAlive</b>: Boolean read FKeepAlive Write FKeepAlive;</code></td>
250</tr>
251</table>
252<p>
253If <code>True</code> (default value), keepalives in HTTP protocol 1.1 is enabled.</p>
254<table class="detail">
255<tr class="list">
256<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
257<td class="itemcode"><a name="KeepAliveTimeout"></a><code>property <b>KeepAliveTimeout</b>: integer read FKeepAliveTimeout Write FKeepAliveTimeout;</code></td>
258</tr>
259</table>
260<p>
261Define timeout for keepalives in seconds!</p>
262<table class="detail">
263<tr class="list">
264<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
265<td class="itemcode"><a name="Status100"></a><code>property <b>Status100</b>: Boolean read FStatus100 Write FStatus100;</code></td>
266</tr>
267</table>
268<p>
269if <code>True</code>, then server is requested for 100status capability when uploading data. Default is <code>False</code> (off).</p>
270<table class="detail">
271<tr class="list">
272<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
273<td class="itemcode"><a name="ProxyHost"></a><code>property <b>ProxyHost</b>: string read FProxyHost Write FProxyHost;</code></td>
274</tr>
275</table>
276<p>
277Address of proxy server (IP address or domain name) where you want to connect in <a class="normal" href="httpsend.THTTPSend.html#HTTPMethod">HTTPMethod</a> method.</p>
278<table class="detail">
279<tr class="list">
280<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
281<td class="itemcode"><a name="ProxyPort"></a><code>property <b>ProxyPort</b>: string read FProxyPort Write FProxyPort;</code></td>
282</tr>
283</table>
284<p>
285Port number for proxy connection. Default value is 8080.</p>
286<table class="detail">
287<tr class="list">
288<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
289<td class="itemcode"><a name="ProxyUser"></a><code>property <b>ProxyUser</b>: string read FProxyUser Write FProxyUser;</code></td>
290</tr>
291</table>
292<p>
293Username for connect to proxy server where you want to connect in HTTPMethod method.</p>
294<table class="detail">
295<tr class="list">
296<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
297<td class="itemcode"><a name="ProxyPass"></a><code>property <b>ProxyPass</b>: string read FProxyPass Write FProxyPass;</code></td>
298</tr>
299</table>
300<p>
301Password for connect to proxy server where you want to connect in HTTPMethod method.</p>
302<table class="detail">
303<tr class="list">
304<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
305<td class="itemcode"><a name="UserAgent"></a><code>property <b>UserAgent</b>: string read FUserAgent Write FUserAgent;</code></td>
306</tr>
307</table>
308<p>
309Here you can specify custom User-Agent indentification. By default is used: 'Mozilla/4.0 (compatible; Synapse)'</p>
310<table class="detail">
311<tr class="list">
312<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
313<td class="itemcode"><a name="ResultCode"></a><code>property <b>ResultCode</b>: Integer read FResultCode;</code></td>
314</tr>
315</table>
316<p>
317After successful <a class="normal" href="httpsend.THTTPSend.html#HTTPMethod">HTTPMethod</a> method contains result code of operation.</p>
318<table class="detail">
319<tr class="list">
320<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
321<td class="itemcode"><a name="ResultString"></a><code>property <b>ResultString</b>: string read FResultString;</code></td>
322</tr>
323</table>
324<p>
325After successful <a class="normal" href="httpsend.THTTPSend.html#HTTPMethod">HTTPMethod</a> method contains string after result code.</p>
326<table class="detail">
327<tr class="list">
328<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
329<td class="itemcode"><a name="DownloadSize"></a><code>property <b>DownloadSize</b>: integer read FDownloadSize;</code></td>
330</tr>
331</table>
332<p>
333if this value is not 0, then data download pending. In this case you have here total sice of downloaded data. It is good for draw download progressbar from OnStatus event.</p>
334<table class="detail">
335<tr class="list">
336<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
337<td class="itemcode"><a name="UploadSize"></a><code>property <b>UploadSize</b>: integer read FUploadSize;</code></td>
338</tr>
339</table>
340<p>
341if this value is not 0, then data upload pending. In this case you have here total sice of uploaded data. It is good for draw upload progressbar from OnStatus event.</p>
342<table class="detail">
343<tr class="list">
344<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
345<td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
346</tr>
347</table>
348<p>
349Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.</p>
350<table class="detail">
351<tr class="list">
352<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
353<td class="itemcode"><a name="AddPortNumberToHost"></a><code>property <b>AddPortNumberToHost</b>: Boolean read FAddPortNumberToHost write FAddPortNumberToHost;</code></td>
354</tr>
355</table>
356<p>
357To have possibility to switch off port number in 'Host:' HTTP header, by default <code>True</code>. Some buggy servers not like port informations in this header.</p>
358<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>
359</span>
360</body></html>
Note: See TracBrowser for help on using the repository browser.