-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookURLEntryPoints.TBrookURLEntryPoints.html
305 lines (304 loc) · 17 KB
/
BrookURLEntryPoints.TBrookURLEntryPoints.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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookURLEntryPoints: Class TBrookURLEntryPoints</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="TBrookURLEntryPoints"></span><h1 class="cio">Class TBrookURLEntryPoints</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="BrookURLEntryPoints.html">BrookURLEntryPoints</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookURLEntryPoints = class(<a class="normal" href="BrookHandledClasses.TBrookHandledComponent.html">TBrookHandledComponent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
URL entry-points component.</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">TComponent</li>
<li class="ancestor"><a class="normal" href="BrookHandledClasses.TBrookHandledComponent.html">TBrookHandledComponent</a></li>
<li class="thisitem">TBrookURLEntryPoints</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Create">Create</a></strong>(AOwner: TComponent); override;</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="BrookURLEntryPoints.TBrookURLEntryPoints.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>function <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#GetEnumerator">GetEnumerator</a></strong>: <a href="BrookURLEntryPoints.TBrookURLEntryPointListEnumerator.html">TBrookURLEntryPointListEnumerator</a>;</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>function <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#Add">Add</a></strong>: <a href="BrookURLEntryPoints.TBrookURLEntryPoint.html">TBrookURLEntryPoint</a>; inline;</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Remove">Remove</a></strong>(const AName: string); inline;</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Clear">Clear</a></strong>; inline;</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Open">Open</a></strong>;</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Close">Close</a></strong>;</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Enter">Enter</a></strong>(ASender: TObject; const APath: string; ARequest: <a href="BrookHTTPRequest.TBrookHTTPRequest.html">TBrookHTTPRequest</a>; AResponse: <a href="BrookHTTPResponse.TBrookHTTPResponse.html">TBrookHTTPResponse</a>); 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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Enter">Enter</a></strong>(ASender: TObject; ARequest: <a href="BrookHTTPRequest.TBrookHTTPRequest.html">TBrookHTTPRequest</a>; AResponse: <a href="BrookHTTPResponse.TBrookHTTPResponse.html">TBrookHTTPResponse</a>); overload; virtual;</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="BrookURLEntryPoints.TBrookURLEntryPoints.html#Items">Items</a></strong>[AIndex:Integer]: <a href="BrookURLEntryPoints.TBrookURLEntryPoint.html">TBrookURLEntryPoint</a> read GetItem
write SetItem;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#Active">Active</a></strong>: Boolean read FActive write SetActive stored IsActiveStored;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#List">List</a></strong>: <a href="BrookURLEntryPoints.TBrookURLEntryPointList.html">TBrookURLEntryPointList</a> read FList write SetList;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#OnNotFound">OnNotFound</a></strong>: <a href="BrookURLEntryPoints.html#TBrookURLEntryPointsNotFoundEvent">TBrookURLEntryPointsNotFoundEvent</a> read FOnNotFound
write FOnNotFound;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#OnActivate">OnActivate</a></strong>: TNotifyEvent read FOnActivate write FOnActivate;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLEntryPoints.TBrookURLEntryPoints.html#OnDeactivate">OnDeactivate</a></strong>: TNotifyEvent read FOnDeactivate write FOnDeactivate;</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>(AOwner: TComponent); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookURLEntryPoints.TBrookURLEntryPoints.html">TBrookURLEntryPoints</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AOwner[in]</dt>
<dd>Owner component.</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>
Destroys an instance of <code><a class="normal" href="BrookURLEntryPoints.TBrookURLEntryPoints.html">TBrookURLEntryPoints</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="GetEnumerator"></span><code>function <strong>GetEnumerator</strong>: <a href="BrookURLEntryPoints.TBrookURLEntryPointListEnumerator.html">TBrookURLEntryPointListEnumerator</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an enumerator to iterate the entry-points though <code>for..in</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="Add"></span><code>function <strong>Add</strong>: <a href="BrookURLEntryPoints.TBrookURLEntryPoint.html">TBrookURLEntryPoint</a>; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Adds a new item to the entry-point <a class="normal" href="BrookURLEntryPoints.TBrookURLEntryPoints.html#List">list</a>. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Entry-point item.</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="Remove"></span><code>procedure <strong>Remove</strong>(const AName: string); inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Removes an item from the entry-point <a class="normal" href="BrookURLEntryPoints.TBrookURLEntryPoints.html#List">list</a> by its name. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AName[in]</dt>
<dd>Entry-point name.</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="Clear"></span><code>procedure <strong>Clear</strong>; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears the entry-point <a class="normal" href="BrookURLEntryPoints.TBrookURLEntryPoints.html#List">list</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="Open"></span><code>procedure <strong>Open</strong>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Enabled the entry-point component.</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="Close"></span><code>procedure <strong>Close</strong>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Disables the entry-point component.</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="Enter"></span><code>procedure <strong>Enter</strong>(ASender: TObject; const APath: string; ARequest: <a href="BrookHTTPRequest.TBrookHTTPRequest.html">TBrookHTTPRequest</a>; AResponse: <a href="BrookHTTPResponse.TBrookHTTPResponse.html">TBrookHTTPResponse</a>); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Enters into entry-points routing them. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASender[in]</dt>
<dd>Sender object.</dd>
<dt>APath[in]</dt>
<dd>Entry-point path.</dd>
<dt>ARequest[in]</dt>
<dd>Request object to pass to the entry-point found.</dd>
<dt>AResponse:</dt>
<dd>Response object to pass to the entry-point found.</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="Enter"></span><code>procedure <strong>Enter</strong>(ASender: TObject; ARequest: <a href="BrookHTTPRequest.TBrookHTTPRequest.html">TBrookHTTPRequest</a>; AResponse: <a href="BrookHTTPResponse.TBrookHTTPResponse.html">TBrookHTTPResponse</a>); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Enters into entry-points routing them. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASender[in]</dt>
<dd>Sender object.</dd>
<dt>ARequest[in]</dt>
<dd>Request object to pass to the entry-point found.</dd>
<dt>AResponse:</dt>
<dd>Response object to pass to the entry-point found.</dd>
</dl>
</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="Items"></span><code>property <strong>Items</strong>[AIndex:Integer]: <a href="BrookURLEntryPoints.TBrookURLEntryPoint.html">TBrookURLEntryPoint</a> read GetItem
write SetItem;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets/sets an entry-point from/to the entry-point <a class="normal" href="BrookURLEntryPoints.TBrookURLEntryPoints.html#List">list</a> by its index.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Active"></span><code>property <strong>Active</strong>: Boolean read FActive write SetActive stored IsActiveStored;</code></td>
</tr>
<tr><td colspan="2">
<p>
Enabled/disables the entry-point component.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="List"></span><code>property <strong>List</strong>: <a href="BrookURLEntryPoints.TBrookURLEntryPointList.html">TBrookURLEntryPointList</a> read FList write SetList;</code></td>
</tr>
<tr><td colspan="2">
<p>
Available entry-point <code>list</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnNotFound"></span><code>property <strong>OnNotFound</strong>: <a href="BrookURLEntryPoints.html#TBrookURLEntryPointsNotFoundEvent">TBrookURLEntryPointsNotFoundEvent</a> read FOnNotFound
write FOnNotFound;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when an entry-point is not found.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnActivate"></span><code>property <strong>OnActivate</strong>: TNotifyEvent read FOnActivate write FOnActivate;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when the component is enabled.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnDeactivate"></span><code>property <strong>OnDeactivate</strong>: TNotifyEvent read FOnDeactivate write FOnDeactivate;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when the component is disabled.</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>