-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookHTTPResponse.TBrookHTTPResponse.html
529 lines (528 loc) · 26.6 KB
/
BrookHTTPResponse.TBrookHTTPResponse.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookHTTPResponse: Class TBrookHTTPResponse</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="TBrookHTTPResponse"></span><h1 class="cio">Class TBrookHTTPResponse</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookHTTPResponse.html">BrookHTTPResponse</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookHTTPResponse = class(<a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html">TBrookHandledPersistent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Class which dispatches <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Headers">headers</a>, contents, binaries, files and other data to the client.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html">TBrookHandledPersistent</a></li>
<li class="thisitem">TBrookHTTPResponse</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Create">Create</a></strong>(AHandle: Pointer); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Destroy">Destroy</a></strong>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SetCookie">SetCookie</a></strong>(const AName, AValue: string); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Send">Send</a></strong>(const AValue, AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendFmt">SendFmt</a></strong>(const AFormat: string; const AArgs: array of const; const AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendBinary">SendBinary</a></strong>(ABuffer: Pointer; ASize: NativeUInt; const AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendBytes">SendBytes</a></strong>(const ABytes: TBytes; ASize: NativeUInt; const AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendFile">SendFile</a></strong>(ASize: NativeUInt; AMaxSize, AOffset: UInt64; const AFileName: TFileName; ADownloaded: Boolean; AStatus: Word); virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendStream">SendStream</a></strong>(AStream: TStream; AFreed: Boolean; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendStream">SendStream</a></strong>(AStream: TStream; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendEmpty">SendEmpty</a></strong>(const AContentType: string); overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendEmpty">SendEmpty</a></strong>; overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendAndRedirect">SendAndRedirect</a></strong>(const AValue, ADestination, AContentType: string; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#SendAndRedirect">SendAndRedirect</a></strong>(const AValue, ADestination, AContentType: string); overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Download">Download</a></strong>(const AFileName: TFileName; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Render">Render</a></strong>(const AFileName: TFileName; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Download">Download</a></strong>(const AFileName: TFileName); overload; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Render">Render</a></strong>(const AFileName: TFileName); overload; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Reset">Reset</a></strong>; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Clear">Clear</a></strong>; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#IsEmpty">IsEmpty</a></strong>: Boolean;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Compressed">Compressed</a></strong>: Boolean read FCompressed write FCompressed;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Headers">Headers</a></strong>: <a href="BrookStringMap.TBrookStringMap.html">TBrookStringMap</a> read FHeaders;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Cookies">Cookies</a></strong>: <a href="BrookHTTPCookies.TBrookHTTPCookies.html">TBrookHTTPCookies</a> read FCookies write SetCookies;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPResponse.TBrookHTTPResponse.html#Empty">Empty</a></strong>: Boolean read <a href="BrookHTTPResponse.TBrookHTTPResponse.html#IsEmpty">IsEmpty</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create"></span><code>constructor <strong>Create</strong>(AHandle: Pointer); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html">TBrookHTTPResponse</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AHandle[in]</dt>
<dd>Request <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Frees an instance of <code><a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html">TBrookHTTPResponse</a></code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SetCookie"></span><code>procedure <strong>SetCookie</strong>(const AName, AValue: string); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sets server cookie to the response <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Cookie name.</dd>
<dt>AValue[in]</dt>
<dd>Cookie value.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Send"></span><code>procedure <strong>Send</strong>(const AValue, AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a string content to the client. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AValue[in]</dt>
<dd>String to be sent.</dd>
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendFmt"></span><code>procedure <strong>SendFmt</strong>(const AFormat: string; const AArgs: array of const; const AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a formatted string content to the client. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AFmt[in]</dt>
<dd>Format string.</dd>
<dt>AArgs[in]</dt>
<dd>Arguments to compose the formatted string.</dd>
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendBinary"></span><code>procedure <strong>SendBinary</strong>(ABuffer: Pointer; ASize: NativeUInt; const AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a binary content to the client. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ABinary[in]</dt>
<dd>Binary content to be sent.</dd>
<dt>ASize[in]</dt>
<dd>Content size.</dd>
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendBytes"></span><code>procedure <strong>SendBytes</strong>(const ABytes: TBytes; ASize: NativeUInt; const AContentType: string; AStatus: Word); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends an array of Bytes content to the client. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ABytes[in]</dt>
<dd>Array of Bytes to be sent.</dd>
<dt>ASize[in]</dt>
<dd>Content size.</dd>
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendFile"></span><code>procedure <strong>SendFile</strong>(ASize: NativeUInt; AMaxSize, AOffset: UInt64; const AFileName: TFileName; ADownloaded: Boolean; AStatus: Word); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a file to the client. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASize[in]</dt>
<dd>Size of the file to be sent. Use zero to calculate automatically.</dd>
<dt>AMaxSize[in]</dt>
<dd>Maximum allowed file size. Use zero for no limit.</dd>
<dt>AOffset[in]</dt>
<dd>Offset to start reading from in the file to be sent.</dd>
<dt>AFileName[in]</dt>
<dd>Path of the file to be sent.</dd>
<dt>ADownloaded[in]</dt>
<dd>If <code>True</code> it offers the file as <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Download">download</a>.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendStream"></span><code>procedure <strong>SendStream</strong>(AStream: TStream; AFreed: Boolean; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a stream to the client. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AStream[in]</dt>
<dd>Stream to be sent.</dd>
<dt>AFreed[in]</dt>
<dd><code>True</code> frees the stream automatically as soon as it is sent.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendStream"></span><code>procedure <strong>SendStream</strong>(AStream: TStream; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a stream to the client. The stream is freed automatically as soon as it is sent. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AStream[in]</dt>
<dd>Stream to be sent.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendEmpty"></span><code>procedure <strong>SendEmpty</strong>(const AContentType: string); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends an HTTP status 204 to the client indicating the server has fulfilled the request, but does not need to return a content. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendEmpty"></span><code>procedure <strong>SendEmpty</strong>; overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends an HTTP status 204 to the client indicating the server has fulfilled the request, but does not need to return a content.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendAndRedirect"></span><code>procedure <strong>SendAndRedirect</strong>(const AValue, ADestination, AContentType: string; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a string content to the client and redirects it to a new location. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AValue[in]</dt>
<dd>String to be sent.</dd>
<dt>ADestination[in]</dt>
<dd>Destination to which it will be redirected as soon as the content is sent.</dd>
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code (must be >=300 and <=307).</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SendAndRedirect"></span><code>procedure <strong>SendAndRedirect</strong>(const AValue, ADestination, AContentType: string); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a string content to the client with HTTP status 302 and redirects it to a new location. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AValue[in]</dt>
<dd>String to be sent.</dd>
<dt>ADestination[in]</dt>
<dd>Destination to which it will be redirected as soon as the content is sent.</dd>
<dt>AContentType[in]</dt>
<dd>Content type.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Download"></span><code>procedure <strong>Download</strong>(const AFileName: TFileName; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Offers a file as <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Download">download</a>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AFileName[in]</dt>
<dd>Path of the file to be sent.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Render"></span><code>procedure <strong>Render</strong>(const AFileName: TFileName; AStatus: Word); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a file to be rendered. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AFileName[in]</dt>
<dd>Path of the file to be sent.</dd>
<dt>AStatus[in]</dt>
<dd>HTTP status code.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Download"></span><code>procedure <strong>Download</strong>(const AFileName: TFileName); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Offers a file as <code>download</code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AFileName[in]</dt>
<dd>Path of the file to be sent.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Render"></span><code>procedure <strong>Render</strong>(const AFileName: TFileName); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sends a file to be rendered. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AFileName[in]</dt>
<dd>Path of the file to be sent.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Reset"></span><code>procedure <strong>Reset</strong>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Resets status and internal buffers of the response <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a> preserving all <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Headers">headers</a> and <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Cookies">cookies</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Clear"></span><code>procedure <strong>Clear</strong>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears all <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Headers">headers</a>, <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Cookies">cookies</a>, status and internal buffers of the response object.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="IsEmpty"></span><code>function <strong>IsEmpty</strong>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Checks if the response is <a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#Empty">empty</a>.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Compressed"></span><code>property <strong>Compressed</strong>: Boolean read FCompressed write FCompressed;</code></td>
</tr>
<tr><td colspan="2">
<p>
Determines if the content must be <code>compressed</code> while sending. The compression is done by the ZLib library using the DEFLATE compression algorithm. It uses the Gzip format when the content is a file.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Headers"></span><code>property <strong>Headers</strong>: <a href="BrookStringMap.TBrookStringMap.html">TBrookStringMap</a> read FHeaders;</code></td>
</tr>
<tr><td colspan="2">
<p>
Hash table containing the <code>headers</code> to be sent to the client.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Cookies"></span><code>property <strong>Cookies</strong>: <a href="BrookHTTPCookies.TBrookHTTPCookies.html">TBrookHTTPCookies</a> read FCookies write SetCookies;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Cookies</code> to be sent to the client.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Empty"></span><code>property <strong>Empty</strong>: Boolean read <a href="BrookHTTPResponse.TBrookHTTPResponse.html#IsEmpty">IsEmpty</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Determines if the response is <code>empty</code>.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>