Mercurial > hg > nginx-site
annotate xml/en/docs/dev/development_guide.xml @ 1996:40467656998b
Added closing bracket to proxy_bind transparent.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Fri, 09 Jun 2017 17:29:52 +0300 |
parents | 80f53da7280c |
children | eeb9cb8f8a54 |
rev | line source |
---|---|
1899 | 1 <?xml version="1.0"?> |
2 | |
3 <!-- | |
4 Copyright (C) Nginx, Inc. | |
5 --> | |
6 | |
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> | |
8 | |
9 <article name="Development guide" | |
10 link="/en/docs/dev/development_guide.html" | |
11 lang="en" | |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
12 rev="2"> |
1899 | 13 |
14 <section name="Introduction" id="introduction"> | |
15 | |
16 | |
17 <section name="Code layout" id="code_layout"> | |
18 | |
19 <list type="bullet"> | |
20 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
21 <literal>auto</literal> — Build scripts |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
22 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
23 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
24 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
25 <literal>src</literal> |
1899 | 26 |
27 <list type="bullet"> | |
28 | |
29 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
30 <literal>core</literal> — Basic types and functions — string, array, log, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
31 pool, etc. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
32 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
33 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
34 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
35 <literal>event</literal> — Event core |
1899 | 36 |
37 <list type="bullet"> | |
38 | |
39 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
40 <literal>modules</literal> — Event notification modules: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
41 <literal>epoll</literal>, <literal>kqueue</literal>, <literal>select</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
42 etc. |
1899 | 43 </listitem> |
44 | |
45 </list> | |
46 | |
47 </listitem> | |
48 | |
49 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
50 <literal>http</literal> — Core HTTP module and common code |
1899 | 51 |
52 <list type="bullet"> | |
53 | |
54 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
55 <literal>modules</literal> — Other HTTP modules |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
56 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
57 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
58 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
59 <literal>v2</literal> — HTTP/2 |
1899 | 60 </listitem> |
61 | |
62 </list> | |
63 | |
64 </listitem> | |
65 | |
66 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
67 <literal>mail</literal> — Mail modules |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
68 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
69 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
70 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
71 <literal>os</literal> — Platform-specific code |
1899 | 72 |
73 <list type="bullet"> | |
74 | |
75 <listitem> | |
76 <literal>unix</literal> | |
77 </listitem> | |
78 | |
79 <listitem> | |
80 <literal>win32</literal> | |
81 </listitem> | |
82 | |
83 </list> | |
84 | |
85 </listitem> | |
86 | |
87 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
88 <literal>stream</literal> — Stream modules |
1899 | 89 </listitem> |
90 | |
91 </list> | |
92 | |
93 </listitem> | |
94 | |
95 </list> | |
96 | |
97 </section> | |
98 | |
99 | |
100 <section name="Include files" id="include_files"> | |
101 | |
102 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
103 The following two <literal>#include</literal> statements must appear at the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
104 beginning of every nginx file: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
105 </para> |
1899 | 106 |
107 <programlisting> | |
108 #include <ngx_config.h> | |
109 #include <ngx_core.h> | |
110 </programlisting> | |
111 | |
112 <para> | |
113 In addition to that, HTTP code should include | |
114 </para> | |
115 | |
116 | |
117 <programlisting> | |
118 #include <ngx_http.h> | |
119 </programlisting> | |
120 | |
121 <para> | |
122 Mail code should include | |
123 </para> | |
124 | |
125 | |
126 <programlisting> | |
127 #include <ngx_mail.h> | |
128 </programlisting> | |
129 | |
130 <para> | |
131 Stream code should include | |
132 </para> | |
133 | |
134 | |
135 <programlisting> | |
136 #include <ngx_stream.h> | |
137 </programlisting> | |
138 | |
139 </section> | |
140 | |
141 | |
142 <section name="Integers" id="integers"> | |
143 | |
144 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
145 For general purposes, nginx code uses two integer types, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
146 <literal>ngx_int_t</literal> and <literal>ngx_uint_t</literal>, which are |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
147 typedefs for <literal>intptr_t</literal> and <literal>uintptr_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
148 respectively. |
1899 | 149 </para> |
150 | |
151 </section> | |
152 | |
153 | |
154 <section name="Common return codes" id="common_return_codes"> | |
155 | |
156 <para> | |
157 Most functions in nginx return the following codes: | |
158 </para> | |
159 | |
160 <list type="bullet"> | |
161 | |
162 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
163 <literal>NGX_OK</literal> — Operation succeeded. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
164 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
165 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
166 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
167 <literal>NGX_ERROR</literal> — Operation failed. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
168 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
169 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
170 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
171 <literal>NGX_AGAIN</literal> — Operation incomplete; call the function again. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
172 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
173 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
174 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
175 <literal>NGX_DECLINED</literal> — Operation rejected, for example, because it is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
176 disabled in the configuration. This is never an error. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
177 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
178 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
179 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
180 <literal>NGX_BUSY</literal> — Resource is not available. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
181 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
182 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
183 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
184 <literal>NGX_DONE</literal> — Operation complete or continued elsewhere. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
185 Also used as an alternative success code. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
186 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
187 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
188 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
189 <literal>NGX_ABORT</literal> — Function was aborted. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
190 Also used as an alternative error code. |
1899 | 191 </listitem> |
192 | |
193 </list> | |
194 | |
195 </section> | |
196 | |
197 | |
198 <section name="Error handling" id="error_handling"> | |
199 | |
200 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
201 The <literal>ngx_errno</literal> macro returns the last system error code. |
1899 | 202 It's mapped to <literal>errno</literal> on POSIX platforms and to |
203 <literal>GetLastError()</literal> call in Windows. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
204 The <literal>ngx_socket_errno</literal> macro returns the last socket error |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
205 number. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
206 Like the <literal>ngx_errno</literal> macro, it's mapped to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
207 <literal>errno</literal> on POSIX platforms. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
208 It's mapped to the <literal>WSAGetLastError()</literal> call on Windows. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
209 Accessing the values of <literal>ngx_errno</literal> or |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
210 <literal>ngx_socket_errno</literal> more than once in a row can cause |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
211 performance issues. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
212 If the error value might be used multiple times, store it in a local variable |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
213 of type <literal>ngx_err_t</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
214 To set errors, use the <literal>ngx_set_errno(errno)</literal> and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
215 <literal>ngx_set_socket_errno(errno)</literal> macros. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
216 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
217 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
218 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
219 The values of <literal>ngx_errno</literal> and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
220 <literal>ngx_socket_errno</literal> can be passed to the logging functions |
1899 | 221 <literal>ngx_log_error()</literal> and <literal>ngx_log_debugX()</literal>, in |
222 which case system error text is added to the log message. | |
223 </para> | |
224 | |
225 <para> | |
226 Example using <literal>ngx_errno</literal>: | |
227 </para> | |
228 | |
229 | |
230 <programlisting> | |
231 void | |
232 ngx_my_kill(ngx_pid_t pid, ngx_log_t *log, int signo) | |
233 { | |
234 ngx_err_t err; | |
235 | |
236 if (kill(pid, signo) == -1) { | |
237 err = ngx_errno; | |
238 | |
239 ngx_log_error(NGX_LOG_ALERT, log, err, "kill(%P, %d) failed", pid, signo); | |
240 | |
241 if (err == NGX_ESRCH) { | |
242 return 2; | |
243 } | |
244 | |
245 return 1; | |
246 } | |
247 | |
248 return 0; | |
249 } | |
250 </programlisting> | |
251 | |
252 </section> | |
253 | |
254 | |
255 </section> | |
256 | |
257 | |
258 <section name="Strings" id="strings"> | |
259 | |
260 | |
261 <section name="Overview" id="overview"> | |
262 | |
263 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
264 For C strings, nginx uses the unsigned character type pointer |
1899 | 265 <literal>u_char *</literal>. |
266 </para> | |
267 | |
268 <para> | |
269 The nginx string type <literal>ngx_str_t</literal> is defined as follows: | |
270 </para> | |
271 | |
272 | |
273 <programlisting> | |
274 typedef struct { | |
275 size_t len; | |
276 u_char *data; | |
277 } ngx_str_t; | |
278 </programlisting> | |
279 | |
280 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
281 The <literal>len</literal> field holds the string length and |
1899 | 282 <literal>data</literal> holds the string data. |
283 The string, held in <literal>ngx_str_t</literal>, may or may not be | |
284 null-terminated after the <literal>len</literal> bytes. | |
285 In most cases it’s not. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
286 However, in certain parts of the code (for example, when parsing configuration), |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
287 <literal>ngx_str_t</literal> objects are known to be null-terminated, which |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
288 simplifies string comparison and makes it easier to pass the strings to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
289 syscalls. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
290 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
291 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
292 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
293 The string operations in nginx are declared in |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
294 <path>src/core/ngx_string.h</path> |
1899 | 295 Some of them are wrappers around standard C functions: |
296 </para> | |
297 | |
298 <para> | |
299 <list type="bullet"> | |
300 | |
301 <listitem> | |
302 <literal>ngx_strcmp()</literal> | |
303 </listitem> | |
304 | |
305 <listitem> | |
306 <literal>ngx_strncmp()</literal> | |
307 </listitem> | |
308 | |
309 <listitem> | |
310 <literal>ngx_strstr()</literal> | |
311 </listitem> | |
312 | |
313 <listitem> | |
314 <literal>ngx_strlen()</literal> | |
315 </listitem> | |
316 | |
317 <listitem> | |
318 <literal>ngx_strchr()</literal> | |
319 </listitem> | |
320 | |
321 <listitem> | |
322 <literal>ngx_memcmp()</literal> | |
323 </listitem> | |
324 | |
325 <listitem> | |
326 <literal>ngx_memset()</literal> | |
327 </listitem> | |
328 | |
329 <listitem> | |
330 <literal>ngx_memcpy()</literal> | |
331 </listitem> | |
332 | |
333 <listitem> | |
334 <literal>ngx_memmove()</literal> | |
335 </listitem> | |
336 | |
337 </list> | |
338 | |
339 </para> | |
340 | |
341 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
342 Other string functions are nginx-specific |
1899 | 343 </para> |
344 | |
345 <para> | |
346 <list type="bullet"> | |
347 | |
348 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
349 <literal>ngx_memzero()</literal> — Fills memory with zeroes. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
350 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
351 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
352 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
353 <literal>ngx_cpymem()</literal> — Does the same as |
1899 | 354 <literal>ngx_memcpy()</literal>, but returns the final destination address |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
355 This one is handy for appending multiple strings in a row. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
356 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
357 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
358 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
359 <literal>ngx_movemem()</literal> — Does the same as |
1899 | 360 <literal>ngx_memmove()</literal>, but returns the final destination address. |
361 </listitem> | |
362 | |
363 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
364 <literal>ngx_strlchr()</literal> — Searches for a character in a string, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
365 delimited by two pointers. |
1899 | 366 </listitem> |
367 </list> | |
368 </para> | |
369 | |
370 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
371 The following functions perform case conversion and comparison: |
1899 | 372 </para> |
373 | |
374 <para> | |
375 <list type="bullet"> | |
376 | |
377 <listitem> | |
378 <literal>ngx_tolower()</literal> | |
379 </listitem> | |
380 | |
381 <listitem> | |
382 <literal>ngx_toupper()</literal> | |
383 </listitem> | |
384 | |
385 <listitem> | |
386 <literal>ngx_strlow()</literal> | |
387 </listitem> | |
388 | |
389 <listitem> | |
390 <literal>ngx_strcasecmp()</literal> | |
391 </listitem> | |
392 | |
393 <listitem> | |
394 <literal>ngx_strncasecmp()</literal> | |
395 </listitem> | |
396 | |
397 </list> | |
398 </para> | |
399 | |
400 </section> | |
401 | |
402 | |
403 <section name="Formatting" id="formatting"> | |
404 | |
405 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
406 The following formatting functions support nginx-specific types: |
1899 | 407 </para> |
408 | |
409 | |
410 <para> | |
411 <list type="bullet"> | |
412 | |
413 <listitem> | |
414 <literal>ngx_sprintf(buf, fmt, ...)</literal> | |
415 </listitem> | |
416 | |
417 <listitem> | |
418 <literal>ngx_snprintf(buf, max, fmt, ...)</literal> | |
419 </listitem> | |
420 | |
421 <listitem> | |
1975 | 422 <literal>ngx_slprintf(buf, last, fmt, ...)</literal> |
1899 | 423 </listitem> |
424 | |
425 <listitem> | |
426 <literal>ngx_vslprint(buf, last, fmt, args)</literal> | |
427 </listitem> | |
428 | |
429 <listitem> | |
430 <literal>ngx_vsnprint(buf, max, fmt, args)</literal> | |
431 </listitem> | |
432 | |
433 </list> | |
434 </para> | |
435 | |
436 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
437 The full list of formatting options, supported by these functions is |
1915
8b7c3b0ef1a4
Semantically marked paths.
Vladimir Homutov <vl@nginx.com>
parents:
1914
diff
changeset
|
438 in <path>src/core/ngx_string.c</path>. Some of them are: |
1899 | 439 </para> |
440 | |
441 | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
442 <list type="bullet"> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
443 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
444 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
445 <literal>%O</literal> — <literal>off_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
446 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
447 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
448 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
449 <literal>%T</literal> — <literal>time_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
450 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
451 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
452 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
453 <literal>%z</literal> — <literal>size_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
454 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
455 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
456 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
457 <literal>%i</literal> — <literal>ngx_int_t_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
458 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
459 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
460 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
461 <literal>%p</literal> — <literal>void *</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
462 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
463 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
464 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
465 <literal>%V</literal> — <literal>ngx_str_t *</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
466 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
467 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
468 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
469 <literal>%s</literal> — <literal>u_char *</literal> (null-terminated) |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
470 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
471 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
472 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
473 <literal>%*s</literal> — <literal>size_t + u_char *</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
474 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
475 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
476 </list> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
477 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
478 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
479 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
480 You can prepend <literal>u</literal> on most types to make them unsigned. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
481 To convert output to hex, use <literal>X</literal> or <literal>x</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
482 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
483 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
484 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
485 For example: |
1899 | 486 |
487 <programlisting> | |
488 u_char buf[NGX_INT_T_LEN]; | |
489 size_t len; | |
490 ngx_int_t n; | |
491 | |
492 /* set n here */ | |
493 | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
494 len = ngx_sprintf(buf, "%ui", n) — buf; |
1899 | 495 </programlisting> |
496 | |
497 </para> | |
498 | |
499 </section> | |
500 | |
501 | |
502 <section name="Numeric conversion" id="numeric_conversion"> | |
503 | |
504 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
505 Several functions for numeric conversion are implemented in nginx. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
506 The first four each convert a string of given length to a positive integer of |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
507 the indicated type. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
508 They return <literal>NGX_ERROR</literal> on error. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
509 |
1899 | 510 <list type="bullet"> |
511 | |
512 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
513 <literal>ngx_atoi(line, n)</literal> — <literal>ngx_int_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
514 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
515 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
516 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
517 <literal>ngx_atosz(line, n)</literal> — <literal>ssize_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
518 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
519 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
520 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
521 <literal>ngx_atoof(line, n)</literal> — <literal>off_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
522 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
523 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
524 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
525 <literal>ngx_atotm(line, n)</literal> — <literal>time_t</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
526 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
527 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
528 </list> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
529 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
530 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
531 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
532 There are two additional numeric conversion functions. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
533 Like the first four, they return <literal>NGX_ERROR</literal> on error. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
534 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
535 <list type="bullet"> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
536 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
537 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
538 <literal>ngx_atofp(line, n, point)</literal> — Converts a fixed point floating |
1899 | 539 number of given length to a positive integer of type |
540 <literal>ngx_int_t</literal>. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
541 The result is shifted left by <literal>point</literal> decimal |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
542 positions. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
543 The string representation of the number is expected to have no more |
1899 | 544 than <literal>points</literal> fractional digits. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
545 For example, <literal>ngx_atofp("10.5", 4, 2)</literal> returns |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
546 <literal>1050</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
547 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
548 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
549 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
550 <literal>ngx_hextoi(line, n)</literal> — Converts a hexadecimal representation |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
551 of a positive integer to <literal>ngx_int_t</literal>. |
1899 | 552 </listitem> |
553 | |
554 </list> | |
555 </para> | |
556 | |
557 </section> | |
558 | |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
559 <section name="Regular expressions" id="regex"> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
560 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
561 <para> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
562 The regular expressions interface in nginx is a wrapper around |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
563 the <link url="http://www.pcre.org">PCRE</link> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
564 library. |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
565 The corresponding header file is <path>src/core/ngx_regex.h</path>. |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
566 </para> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
567 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
568 <para> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
569 To use a regular expression for string matching, it first needs to be |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
570 compiled, which is usually done at the configuration phase. |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
571 Note that since PCRE support is optional, all code using the interface must |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
572 be protected by the surrounding <literal>NGX_PCRE</literal> macro: |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
573 |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
574 <programlisting> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
575 #if (NGX_PCRE) |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
576 ngx_regex_t *re; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
577 ngx_regex_compile_t rc; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
578 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
579 u_char errstr[NGX_MAX_CONF_ERRSTR]; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
580 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
581 ngx_str_t value = ngx_string("message (\\d\\d\\d).*Codeword is '(?<cw>\\w+)'"); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
582 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
583 ngx_memzero(&rc, sizeof(ngx_regex_compile_t)); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
584 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
585 rc.pattern = value; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
586 rc.pool = cf->pool; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
587 rc.err.len = NGX_MAX_CONF_ERRSTR; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
588 rc.err.data = errstr; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
589 /* rc.options are passed as is to pcre_compile() */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
590 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
591 if (ngx_regex_compile(&rc) != NGX_OK) { |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
592 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "%V", &rc.err); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
593 return NGX_CONF_ERROR; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
594 } |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
595 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
596 re = rc.regex; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
597 #endif |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
598 </programlisting> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
599 After successful compilation, the <literal>captures</literal> and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
600 <literal>named_captures</literal> fields in the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
601 <literal>ngx_regex_compile_t</literal> structure contain the count of all |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
602 captures and named captures, respectively, found in the regular expression. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
603 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
604 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
605 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
606 The compiled regular expression can then be used for matching against strings: |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
607 <programlisting> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
608 ngx_int_t n; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
609 int captures[(1 + rc.captures) * 3]; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
610 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
611 ngx_str_t input = ngx_string("This is message 123. Codeword is 'foobar'."); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
612 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
613 n = ngx_regex_exec(re, &input, captures, (1 + rc.captures) * 3); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
614 if (n >= 0) { |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
615 /* string matches expression */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
616 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
617 } else if (n == NGX_REGEX_NO_MATCHED) { |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
618 /* no match was found */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
619 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
620 } else { |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
621 /* some error */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
622 ngx_log_error(NGX_LOG_ALERT, log, 0, ngx_regex_exec_n " failed: %i", n); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
623 } |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
624 </programlisting> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
625 The arguments to <literal>ngx_regex_exec()</literal> are the compiled regular |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
626 expression <literal>re</literal>, the string to match <literal>s</literal>, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
627 an optional array of integers to hold any <literal>captures</literal> that are |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
628 found, and the array's <literal>size</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
629 The size of the <literal>captures</literal> array must be a multiple of three, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
630 as required by the |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
631 <link url="http://www.pcre.org/original/doc/html/pcreapi.html">PCRE API</link>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
632 In the example, the size is calculated from the total number of captures plus |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
633 <literal>1</literal>one for the matched string itself. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
634 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
635 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
636 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
637 If there are matches, captures can be accessed as follows: |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
638 <programlisting> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
639 u_char *p; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
640 size_t size; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
641 ngx_str_t name, value; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
642 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
643 /* all captures */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
644 for (i = 0; i < n * 2; i += 2) { |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
645 value.data = input.data + captures[i]; |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
646 value.len = captures[i + 1] — captures[i]; |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
647 } |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
648 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
649 /* accessing named captures */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
650 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
651 size = rc.name_size; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
652 p = rc.names; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
653 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
654 for (i = 0; i < rc.named_captures; i++, p += size) { |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
655 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
656 /* capture name */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
657 name.data = &p[2]; |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
658 name.len = ngx_strlen(name.data); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
659 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
660 n = 2 * ((p[0] << 8) + p[1]); |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
661 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
662 /* captured value */ |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
663 value.data = &input.data[captures[n]]; |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
664 value.len = captures[n + 1] — captures[n]; |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
665 } |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
666 </programlisting> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
667 </para> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
668 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
669 <para> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
670 The <literal>ngx_regex_exec_array()</literal> function accepts the array of |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
671 <literal>ngx_regex_elt_t</literal> elements (which are just compiled regular |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
672 expressions with associated names), a string to match, and a log. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
673 The function applies expressions from the array to the string until |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
674 either a match is found or no more expressions are left. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
675 The return value is <literal>NGX_OK</literal> when there is a match and |
1919
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
676 <literal>NGX_DECLINED</literal> otherwise, or <literal>NGX_ERROR</literal> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
677 in case of error. |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
678 </para> |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
679 |
dcfb4f3ac8a7
Added the "Regular expressions" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1915
diff
changeset
|
680 </section> |
1899 | 681 |
682 </section> | |
683 | |
684 | |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
685 <section name="Time" id="time"> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
686 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
687 <para> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
688 The <literal>ngx_time_t</literal> structure represents time with three separate |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
689 types for seconds, milliseconds, and the GMT offset: |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
690 <programlisting> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
691 typedef struct { |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
692 time_t sec; |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
693 ngx_uint_t msec; |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
694 ngx_int_t gmtoff; |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
695 } ngx_time_t; |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
696 </programlisting> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
697 The <literal>ngx_tm_t</literal> structure is an alias for |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
698 <literal>struct tm</literal> on UNIX platforms and <literal>SYSTEMTIME</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
699 on Windows. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
700 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
701 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
702 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
703 To obtain the current time, it is usually sufficient to access one of the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
704 available global variables, representing the cached time value in the desired |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
705 format. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
706 For example, the <literal>ngx_current_msec</literal> variable holds the number |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
707 of milliseconds elapsed since Epoch and truncated to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
708 <literal>ngx_msec_t</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
709 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
710 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
711 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
712 The available string representations are: |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
713 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
714 <list type="bullet"> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
715 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
716 <listitem> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
717 <literal>ngx_cached_err_log_time</literal> — Used in error log entries: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
718 <literal>"1970/09/28 12:00:00"</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
719 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
720 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
721 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
722 <literal>ngx_cached_http_log_time</literal> — Used in HTTP access log entries: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
723 <literal>"28/Sep/1970:12:00:00 +0600"</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
724 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
725 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
726 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
727 <literal>ngx_cached_syslog_time</literal> — Used in syslog entries: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
728 <literal>"Sep 28 12:00:00"</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
729 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
730 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
731 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
732 <literal>ngx_cached_http_time</literal> — Used in HTTP headers: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
733 <literal>"Mon, 28 Sep 1970 06:00:00 GMT"</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
734 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
735 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
736 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
737 <literal>ngx_cached_http_log_iso8601</literal> — The ISO 8601 |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
738 standard format: |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
739 <literal>"1970-09-28T12:00:00+06:00"</literal> |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
740 </listitem> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
741 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
742 </list> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
743 </para> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
744 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
745 <para> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
746 The <literal>ngx_time()</literal> and <literal>ngx_timeofday()</literal> macros |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
747 return the current time value in seconds and are the preferred way to access |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
748 the cached time value. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
749 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
750 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
751 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
752 To obtain the time explicitly, use <literal>ngx_gettimeofday()</literal>, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
753 which updates its argument (pointer to |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
754 <literal>struct timeval</literal>). |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
755 The time is always updated when nginx returns to the event loop from system |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
756 calls. |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
757 To update the time immediately, call <literal>ngx_time_update()</literal>, |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
758 or <literal>ngx_time_sigsafe_update()</literal> if updating the time in the |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
759 signal handler context. |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
760 </para> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
761 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
762 <para> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
763 The following functions convert <literal>time_t</literal> into the indicated |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
764 broken-down time representation. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
765 The first function in each pair converts <literal>time_t</literal> to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
766 <literal>ngx_tm_t</literal> and the second (with the <literal>_libc_</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
767 infix) to <literal>struct tm</literal>: |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
768 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
769 <list type="bullet"> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
770 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
771 <listitem> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
772 <literal>ngx_gmtime(), ngx_libc_gmtime()</literal> — Time expressed as UTC |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
773 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
774 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
775 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
776 <literal>ngx_localtime(), ngx_libc_localtime()</literal> — Time expressed |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
777 relative to the local time zone |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
778 </listitem> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
779 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
780 </list> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
781 |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
782 The <literal>ngx_http_time(buf, time)</literal> function returns a string |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
783 representation suitable for use in HTTP headers (for example, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
784 <literal>"Mon, 28 Sep 1970 06:00:00 GMT"</literal>). |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
785 The <literal>ngx_http_cookie_time(buf, time)</literal> returns a string |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
786 representation function returns a string representation suitable |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
787 for HTTP cookies (<literal>"Thu, 31-Dec-37 23:55:55 GMT"</literal>). |
1982
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
788 </para> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
789 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
790 </section> |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
791 |
28ee7ab54a90
Added the "Time" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1981
diff
changeset
|
792 |
1899 | 793 <section name="Containers" id="containers"> |
794 | |
795 | |
796 <section name="Array" id="array"> | |
797 | |
798 <para> | |
799 The nginx array type <literal>ngx_array_t</literal> is defined as follows | |
800 </para> | |
801 | |
802 | |
803 <programlisting> | |
804 typedef struct { | |
805 void *elts; | |
806 ngx_uint_t nelts; | |
807 size_t size; | |
808 ngx_uint_t nalloc; | |
809 ngx_pool_t *pool; | |
810 } ngx_array_t; | |
811 </programlisting> | |
812 | |
813 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
814 The elements of the array are available in the <literal>elts</literal> field. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
815 The <literal>nelts</literal> field holds the number of elements. |
1899 | 816 The <literal>size</literal> field holds the size of a single element and is set |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
817 when the array is initialized. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
818 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
819 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
820 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
821 Use the <literal>ngx_array_create(pool, n, size)</literal> call to create an |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
822 array in a pool, and the <literal>ngx_array_init(array, pool, n, size)</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
823 call to initialize an array object that has already been allocated. |
1899 | 824 </para> |
825 | |
826 | |
827 <programlisting> | |
828 ngx_array_t *a, b; | |
829 | |
830 /* create an array of strings with preallocated memory for 10 elements */ | |
831 a = ngx_array_create(pool, 10, sizeof(ngx_str_t)); | |
832 | |
833 /* initialize string array for 10 elements */ | |
834 ngx_array_init(&b, pool, 10, sizeof(ngx_str_t)); | |
835 </programlisting> | |
836 | |
837 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
838 Use the following functions to add elements to an array: |
1899 | 839 </para> |
840 | |
841 <para> | |
842 <list type="bullet"> | |
843 | |
844 <listitem> | |
845 <literal>ngx_array_push(a)</literal> adds one tail element and returns pointer | |
846 to it | |
847 </listitem> | |
848 | |
849 <listitem> | |
850 <literal>ngx_array_push_n(a, n)</literal> adds <literal>n</literal> tail elements | |
851 and returns pointer to the first one | |
852 </listitem> | |
853 | |
854 </list> | |
855 </para> | |
856 | |
857 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
858 If the currently allocated amount of memory is not large enough to accommodate |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
859 the new elements, a new block of memory is allocated and the existing elements |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
860 are copied to it. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
861 The new memory block is normally twice as large as the existing one. |
1899 | 862 </para> |
863 | |
864 | |
865 <programlisting> | |
866 s = ngx_array_push(a); | |
867 ss = ngx_array_push_n(&b, 3); | |
868 </programlisting> | |
869 | |
870 </section> | |
871 | |
872 | |
873 <section name="List" id="list"> | |
874 | |
875 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
876 In nginx a list is a sequence of arrays, optimized for inserting a potentially |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
877 large number of items. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
878 The <literal>ngx_list_t</literal> list type is defined as follows: |
1899 | 879 </para> |
880 | |
881 | |
882 <programlisting> | |
883 typedef struct { | |
884 ngx_list_part_t *last; | |
885 ngx_list_part_t part; | |
886 size_t size; | |
887 ngx_uint_t nalloc; | |
888 ngx_pool_t *pool; | |
889 } ngx_list_t; | |
890 </programlisting> | |
891 | |
892 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
893 The actual items are stored in list parts, which are defined as follows: |
1899 | 894 </para> |
895 | |
896 | |
897 <programlisting> | |
898 typedef struct ngx_list_part_s ngx_list_part_t; | |
899 | |
900 struct ngx_list_part_s { | |
901 void *elts; | |
902 ngx_uint_t nelts; | |
903 ngx_list_part_t *next; | |
904 }; | |
905 </programlisting> | |
906 | |
907 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
908 Before use, a list must be initialized by calling |
1899 | 909 <literal>ngx_list_init(list, pool, n, size)</literal> or created by calling |
910 <literal>ngx_list_create(pool, n, size)</literal>. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
911 Both functions take as arguments the size of a single item and a number of |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
912 items per list part. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
913 To add an item to a list, use the <literal>ngx_list_push(list)</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
914 function. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
915 To iterate over the items, directly access the list fields as shown in the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
916 example: |
1899 | 917 </para> |
918 | |
919 | |
920 <programlisting> | |
921 ngx_str_t *v; | |
922 ngx_uint_t i; | |
923 ngx_list_t *list; | |
924 ngx_list_part_t *part; | |
925 | |
926 list = ngx_list_create(pool, 100, sizeof(ngx_str_t)); | |
927 if (list == NULL) { /* error */ } | |
928 | |
929 /* add items to the list */ | |
930 | |
931 v = ngx_list_push(list); | |
932 if (v == NULL) { /* error */ } | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
933 ngx_str_set(v, "foo"); |
1899 | 934 |
935 v = ngx_list_push(list); | |
936 if (v == NULL) { /* error */ } | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
937 ngx_str_set(v, "bar"); |
1899 | 938 |
939 /* iterate over the list */ | |
940 | |
941 part = &list->part; | |
942 v = part->elts; | |
943 | |
944 for (i = 0; /* void */; i++) { | |
945 | |
946 if (i >= part->nelts) { | |
947 if (part->next == NULL) { | |
948 break; | |
949 } | |
950 | |
951 part = part->next; | |
952 v = part->elts; | |
953 i = 0; | |
954 } | |
955 | |
956 ngx_do_smth(&v[i]); | |
957 } | |
958 </programlisting> | |
959 | |
960 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
961 Lists are primarily used for HTTP input and output headers. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
962 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
963 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
964 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
965 Lists do not support item removal. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
966 However, when needed, items can internally be marked as missing without actually |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
967 being removed from the list. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
968 For example, to mark HTTP output headers (which are stored as |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
969 <literal>ngx_table_elt_t</literal> objects) as missing, set the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
970 <literal>hash</literal> field in <literal>ngx_table_elt_t</literal> to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
971 zero. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
972 Items marked in this way are explicitly skipped when the headers are iterated |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
973 over. |
1899 | 974 </para> |
975 | |
976 </section> | |
977 | |
978 | |
979 <section name="Queue" id="queue"> | |
980 | |
981 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
982 In nginx a queue is an intrusive doubly linked list, with each node defined as |
1899 | 983 follows: |
984 </para> | |
985 | |
986 | |
987 <programlisting> | |
988 typedef struct ngx_queue_s ngx_queue_t; | |
989 | |
990 struct ngx_queue_s { | |
991 ngx_queue_t *prev; | |
992 ngx_queue_t *next; | |
993 }; | |
994 </programlisting> | |
995 | |
996 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
997 The head queue node is not linked with any data. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
998 Use the <literal>ngx_queue_init(q)</literal> call to initialize the list head |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
999 before use. |
1899 | 1000 Queues support the following operations: |
1001 </para> | |
1002 | |
1003 <para> | |
1004 <list type="bullet"> | |
1005 | |
1006 <listitem> | |
1007 <literal>ngx_queue_insert_head(h, x)</literal>, | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1008 <literal>ngx_queue_insert_tail(h, x)</literal> — Insert a new node |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1009 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1010 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1011 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1012 <literal>ngx_queue_remove(x)</literal> — Remove a queue node |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1013 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1014 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1015 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1016 <literal>ngx_queue_split(h, q, n)</literal> — Split a queue at a node, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1017 returning the queue tail in a separate queue |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1018 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1019 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1020 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1021 <literal>ngx_queue_add(h, n)</literal> — Add a second queue to the first queue |
1899 | 1022 </listitem> |
1023 | |
1024 <listitem> | |
1025 <literal>ngx_queue_head(h)</literal>, | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1026 <literal>ngx_queue_last(h)</literal> — Get first or last queue node |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1027 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1028 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1029 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1030 <literal>ngx_queue_sentinel(h)</literal> - Get a queue sentinel object to end |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1031 iteration at |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1032 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1033 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1034 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1035 <literal>ngx_queue_data(q, type, link)</literal> — Get a reference to the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1036 beginning of a queue node data structure, considering the queue field offset in |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1037 it |
1899 | 1038 </listitem> |
1039 | |
1040 </list> | |
1041 </para> | |
1042 | |
1043 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1044 An example: |
1899 | 1045 </para> |
1046 | |
1047 | |
1048 <programlisting> | |
1049 typedef struct { | |
1050 ngx_str_t value; | |
1051 ngx_queue_t queue; | |
1052 } ngx_foo_t; | |
1053 | |
1054 ngx_foo_t *f; | |
1055 ngx_queue_t values; | |
1056 | |
1057 ngx_queue_init(&values); | |
1058 | |
1059 f = ngx_palloc(pool, sizeof(ngx_foo_t)); | |
1060 if (f == NULL) { /* error */ } | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
1061 ngx_str_set(&f->value, "foo"); |
1899 | 1062 |
1063 ngx_queue_insert_tail(&values, f); | |
1064 | |
1065 /* insert more nodes here */ | |
1066 | |
1067 for (q = ngx_queue_head(&values); | |
1068 q != ngx_queue_sentinel(&values); | |
1069 q = ngx_queue_next(q)) | |
1070 { | |
1071 f = ngx_queue_data(q, ngx_foo_t, queue); | |
1072 | |
1073 ngx_do_smth(&f->value); | |
1074 } | |
1075 </programlisting> | |
1076 | |
1077 </section> | |
1078 | |
1079 | |
1080 <section name="Red-Black tree" id="red_black_tree"> | |
1081 | |
1082 <para> | |
1915
8b7c3b0ef1a4
Semantically marked paths.
Vladimir Homutov <vl@nginx.com>
parents:
1914
diff
changeset
|
1083 The <path>src/core/ngx_rbtree.h</path> header file provides access to the |
1899 | 1084 effective implementation of red-black trees. |
1085 </para> | |
1086 | |
1087 | |
1088 <programlisting> | |
1089 typedef struct { | |
1090 ngx_rbtree_t rbtree; | |
1091 ngx_rbtree_node_t sentinel; | |
1092 | |
1093 /* custom per-tree data here */ | |
1094 } my_tree_t; | |
1095 | |
1096 typedef struct { | |
1097 ngx_rbtree_node_t rbnode; | |
1098 | |
1099 /* custom per-node data */ | |
1100 foo_t val; | |
1101 } my_node_t; | |
1102 </programlisting> | |
1103 | |
1104 <para> | |
1105 To deal with a tree as a whole, you need two nodes: root and sentinel. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1106 Typically, they are added to a custom structure, allowing you to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1107 organize your data into a tree in which the leaves contain a link to or embed |
1899 | 1108 your data. |
1109 </para> | |
1110 | |
1111 <para> | |
1112 To initialize a tree: | |
1113 </para> | |
1114 | |
1115 | |
1116 <programlisting> | |
1117 my_tree_t root; | |
1118 | |
1119 ngx_rbtree_init(&root.rbtree, &root.sentinel, insert_value_function); | |
1120 </programlisting> | |
1121 | |
1122 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1123 To traverse a tree and insert new values, use the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1124 "<literal>insert_value</literal>" functions. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1125 For example, the <literal>ngx_str_rbtree_insert_value</literal> function deals |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1126 with the <literal>ngx_str_t</literal> type. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1127 Its arguments are pointers to a root node of an insertion, the newly created |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1128 node to be added, and a tree sentinel. |
1899 | 1129 </para> |
1130 | |
1131 | |
1132 <programlisting> | |
1133 void ngx_str_rbtree_insert_value(ngx_rbtree_node_t *temp, | |
1134 ngx_rbtree_node_t *node, | |
1135 ngx_rbtree_node_t *sentinel) | |
1136 </programlisting> | |
1137 | |
1138 | |
1139 <para> | |
1140 The traversal is pretty straightforward and can be demonstrated with the | |
1141 following lookup function pattern: | |
1142 </para> | |
1143 | |
1144 | |
1145 <programlisting> | |
1146 my_node_t * | |
1147 my_rbtree_lookup(ngx_rbtree_t *rbtree, foo_t *val, uint32_t hash) | |
1148 { | |
1149 ngx_int_t rc; | |
1150 my_node_t *n; | |
1151 ngx_rbtree_node_t *node, *sentinel; | |
1152 | |
1153 node = rbtree->root; | |
1154 sentinel = rbtree->sentinel; | |
1155 | |
1156 while (node != sentinel) { | |
1157 | |
1158 n = (my_node_t *) node; | |
1159 | |
1160 if (hash != node->key) { | |
1161 node = (hash < node->key) ? node->left : node->right; | |
1162 continue; | |
1163 } | |
1164 | |
1165 rc = compare(val, node->val); | |
1166 | |
1167 if (rc < 0) { | |
1168 node = node->left; | |
1169 continue; | |
1170 } | |
1171 | |
1172 if (rc > 0) { | |
1173 node = node->right; | |
1174 continue; | |
1175 } | |
1176 | |
1177 return n; | |
1178 } | |
1179 | |
1180 return NULL; | |
1181 } | |
1182 </programlisting> | |
1183 | |
1184 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1185 The <literal>compare()</literal> function is a classic comparator function that |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1186 returns a value less than, equal to, or greater than zero. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1187 To speed up lookups and avoid comparing user objects that can be big, an integer |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1188 hash field is used. |
1899 | 1189 </para> |
1190 | |
1191 <para> | |
1192 To add a node to a tree, allocate a new node, initialize it and call | |
1193 <literal>ngx_rbtree_insert()</literal>: | |
1194 </para> | |
1195 | |
1196 | |
1197 <programlisting> | |
1198 my_node_t *my_node; | |
1199 ngx_rbtree_node_t *node; | |
1200 | |
1201 my_node = ngx_palloc(...); | |
1202 init_custom_data(&my_node->val); | |
1203 | |
1204 node = &my_node->rbnode; | |
1205 node->key = create_key(my_node->val); | |
1206 | |
1207 ngx_rbtree_insert(&root->rbtree, node); | |
1208 </programlisting> | |
1209 | |
1210 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1211 To remove a node, call the <literal>ngx_rbtree_delete()</literal> function: |
1899 | 1212 </para> |
1213 | |
1214 | |
1215 <programlisting> | |
1216 ngx_rbtree_delete(&root->rbtree, node); | |
1217 </programlisting> | |
1218 | |
1219 </section> | |
1220 | |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1221 <section name="Hash" id="hash"> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1222 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1223 <para> |
1920 | 1224 Hash table functions are declared in <path>src/core/ngx_hash.h</path>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1225 Both exact and wildcard matching are supported. |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1226 The latter requires extra setup and is described in a separate section below. |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1227 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1228 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1229 <para> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1230 Before initializing a hash, you need to know the number of elements it will |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1231 hold so that nginx can build it optimally. |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1232 Two parameters that need to be configured are <literal>max_size</literal> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1233 and <literal>bucket_size</literal>, as detailed in a separate |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1234 <link doc="../hash.xml">document</link>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1235 They are usually configurable by the user. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1236 Hash initialization settings are stored with the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1237 <literal>ngx_hash_init_t</literal> type, and the hash itself is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1238 <literal>ngx_hash_t</literal>: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1239 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1240 ngx_hash_t foo_hash; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1241 ngx_hash_init_t hash; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1242 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1243 hash.hash = &foo_hash; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1244 hash.key = ngx_hash_key; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1245 hash.max_size = 512; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1246 hash.bucket_size = ngx_align(64, ngx_cacheline_size); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1247 hash.name = "foo_hash"; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1248 hash.pool = cf->pool; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1249 hash.temp_pool = cf->temp_pool; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1250 </programlisting> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1251 The <literal>key</literal> is a pointer to a function that creates the hash |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1252 integer key from a string. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1253 There are two generic key-creation functions: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1254 <literal>ngx_hash_key(data, len)</literal> and |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1255 <literal>ngx_hash_key_lc(data, len)</literal>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1256 The latter converts a string to all lowercase characters, so the passed string |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1257 must be writeable. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1258 If that is not true, pass the <literal>NGX_HASH_READONLY_KEY</literal> flag |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1259 to the function, initializing the key array (see below). |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1260 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1261 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1262 <para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1263 The hash keys are stored in <literal>ngx_hash_keys_arrays_t</literal> and |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1264 are initialized with <literal>ngx_hash_keys_array_init(arr, type)</literal>: |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1265 The second parameter (<literal>type</literal>) controls the amount of resources |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1266 preallocated for the hash and can be either <literal>NGX_HASH_SMALL</literal> or |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1267 <literal>NGX_HASH_LARGE</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1268 The latter is appropriate if you expect the hash to contain thousands of |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1269 elements. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1270 |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1271 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1272 ngx_hash_keys_arrays_t foo_keys; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1273 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1274 foo_keys.pool = cf->pool; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1275 foo_keys.temp_pool = cf->temp_pool; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1276 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1277 ngx_hash_keys_array_init(&foo_keys, NGX_HASH_SMALL); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1278 </programlisting> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1279 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1280 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1281 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1282 To insert keys into a hash keys array, use the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1283 <literal>ngx_hash_add_key(keys_array, key, value, flags)</literal> function: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1284 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1285 ngx_str_t k1 = ngx_string("key1"); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1286 ngx_str_t k2 = ngx_string("key2"); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1287 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1288 ngx_hash_add_key(&foo_keys, &k1, &my_data_ptr_1, NGX_HASH_READONLY_KEY); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1289 ngx_hash_add_key(&foo_keys, &k2, &my_data_ptr_2, NGX_HASH_READONLY_KEY); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1290 </programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1291 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1292 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1293 <para> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1294 To build the hash table, call the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1295 <literal>ngx_hash_init(hinit, key_names, nelts)</literal> function: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1296 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1297 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1298 ngx_hash_init(&hash, foo_keys.keys.elts, foo_keys.keys.nelts); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1299 </programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1300 |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1301 The function fails if <literal>max_size</literal> or |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1302 <literal>bucket_size</literal> parameters are not big enough. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1303 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1304 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1305 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1306 When the hash is built, use the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1307 <literal>ngx_hash_find(hash, key, name, len)</literal> function to look up |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1308 elements: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1309 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1310 my_data_t *data; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1311 ngx_uint_t key; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1312 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1313 key = ngx_hash_key(k1.data, k1.len); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1314 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1315 data = ngx_hash_find(&foo_hash, key, k1.data, k1.len); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1316 if (data == NULL) { |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1317 /* key not found */ |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1318 } |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1319 </programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1320 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1321 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1322 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1323 <section name="Wildcard matching" id="wildcard_matching"> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1324 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1325 <para> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1326 To create a hash that works with wildcards, use the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1327 <literal>ngx_hash_combined_t</literal> type. |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1328 It includes the hash type described above and has two additional keys arrays: |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1329 <literal>dns_wc_head</literal> and <literal>dns_wc_tail</literal>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1330 The initialization of basic properties is similar to a regular hash: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1331 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1332 ngx_hash_init_t hash |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1333 ngx_hash_combined_t foo_hash; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1334 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1335 hash.hash = &foo_hash.hash; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1336 hash.key = ...; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1337 </programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1338 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1339 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1340 <para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1341 It is possible to add wildcard keys using the |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1342 <literal>NGX_HASH_WILDCARD_KEY</literal> flag: |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1343 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1344 /* k1 = ".example.org"; */ |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1345 /* k2 = "foo.*"; */ |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1346 ngx_hash_add_key(&foo_keys, &k1, &data1, NGX_HASH_WILDCARD_KEY); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1347 ngx_hash_add_key(&foo_keys, &k2, &data2, NGX_HASH_WILDCARD_KEY); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1348 </programlisting> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1349 The function recognizes wildcards and adds keys into the corresponding arrays. |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1350 Please refer to the |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1351 <link doc="../http/ngx_http_map_module.xml" id="map"/> module |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1352 documentation for the description of the wildcard syntax and the |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1353 matching algorithm. |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1354 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1355 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1356 <para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1357 Depending on the contents of added keys, you may need to initialize up to three |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1358 key arrays: one for exact matching (described above), and two more to enable |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1359 matching starting from the head or tail of a string: |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1360 <programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1361 if (foo_keys.dns_wc_head.nelts) { |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1362 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1363 ngx_qsort(foo_keys.dns_wc_head.elts, |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1364 (size_t) foo_keys.dns_wc_head.nelts, |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1365 sizeof(ngx_hash_key_t), |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1366 cmp_dns_wildcards); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1367 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1368 hash.hash = NULL; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1369 hash.temp_pool = pool; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1370 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1371 if (ngx_hash_wildcard_init(&hash, foo_keys.dns_wc_head.elts, |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1372 foo_keys.dns_wc_head.nelts) |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1373 != NGX_OK) |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1374 { |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1375 return NGX_ERROR; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1376 } |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1377 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1378 foo_hash.wc_head = (ngx_hash_wildcard_t *) hash.hash; |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1379 } |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1380 </programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1381 The keys array needs to be sorted, and initialization results must be added |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1382 to the combined hash. |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1383 The initialization of <literal>dns_wc_tail</literal> array is done similarly. |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1384 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1385 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1386 <para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1387 The lookup in a combined hash is handled by the |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1388 <literal>ngx_hash_find_combined(chash, key, name, len)</literal>: |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1389 <programlisting> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
1390 /* key = "bar.example.org"; — will match ".example.org" */ |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
1391 /* key = "foo.example.com"; — will match "foo.*" */ |
1914
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1392 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1393 hkey = ngx_hash_key(key.data, key.len); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1394 res = ngx_hash_find_combined(&foo_hash, hkey, key.data, key.len); |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1395 </programlisting> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1396 </para> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1397 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1398 </section> |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1399 |
f8659301a260
Added hash API description.
Vladimir Homutov <vl@nginx.com>
parents:
1907
diff
changeset
|
1400 </section> |
1899 | 1401 |
1402 </section> | |
1403 | |
1404 | |
1405 <section name="Memory management" id="memory_management"> | |
1406 | |
1407 | |
1408 <section name="Heap" id="heap"> | |
1409 | |
1410 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1411 To allocate memory from system heap, use the following functions: |
1899 | 1412 </para> |
1413 | |
1414 <para> | |
1415 <list type="bullet"> | |
1416 | |
1417 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1418 <literal>ngx_alloc(size, log)</literal> — Allocate memory from system heap. |
1899 | 1419 This is a wrapper around <literal>malloc()</literal> with logging support. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1420 Allocation error and debugging information is logged to <literal>log</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1421 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1422 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1423 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1424 <literal>ngx_calloc(size, log)</literal> — Allocate memory from system heap |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1425 like <literal>ngx_alloc()</literal>, but fill memory with zeros after |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1426 allocation. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1427 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1428 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1429 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1430 <literal>ngx_memalign(alignment, size, log)</literal> — Allocate aligned memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1431 from system heap. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1432 This is a wrapper around <literal>posix_memalign()</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1433 on those platforms that provide that function. |
1899 | 1434 Otherwise implementation falls back to <literal>ngx_alloc()</literal> which |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1435 provides maximum alignment. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1436 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1437 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1438 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1439 <literal>ngx_free(p)</literal> — Free allocated memory. |
1899 | 1440 This is a wrapper around <literal>free()</literal> |
1441 </listitem> | |
1442 | |
1443 </list> | |
1444 </para> | |
1445 | |
1446 </section> | |
1447 | |
1448 | |
1449 <section name="Pool" id="pool"> | |
1450 | |
1451 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1452 Most nginx allocations are done in pools. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1453 Memory allocated in an nginx pool is freed automatically when the pool is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1454 destroyed. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1455 This provides good allocation performance and makes memory control easy. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1456 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1457 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1458 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1459 A pool internally allocates objects in continuous blocks of memory. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1460 Once a block is full, a new one is allocated and added to the pool memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1461 block list. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1462 When the requested allocation is too large to fit into a block, the request |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1463 is forwarded to the system allocator and the |
1899 | 1464 returned pointer is stored in the pool for further deallocation. |
1465 </para> | |
1466 | |
1467 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1468 The type for nginx pools is <literal>ngx_pool_t</literal>. |
1899 | 1469 The following operations are supported: |
1470 </para> | |
1471 | |
1472 <para> | |
1473 <list type="bullet"> | |
1474 | |
1475 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1476 <literal>ngx_create_pool(size, log)</literal> — Create a pool with specified |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1477 block size. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1478 The pool object returned is allocated in the pool as well. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1479 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1480 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1481 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1482 <literal>ngx_destroy_pool(pool)</literal> — Free all pool memory, including |
1899 | 1483 the pool object itself. |
1484 </listitem> | |
1485 | |
1486 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1487 <literal>ngx_palloc(pool, size)</literal> — Allocate aligned memory from the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1488 specified pool. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1489 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1490 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1491 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1492 <literal>ngx_pcalloc(pool, size)</literal> — Allocate aligned memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1493 from the specified pool and fill it with zeroes. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1494 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1495 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1496 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1497 <literal>ngx_pnalloc(pool, size)</literal> — Allocate unaligned memory from the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1498 specified pool. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1499 Mostly used for allocating strings. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1500 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1501 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1502 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1503 <literal>ngx_pfree(pool, p)</literal> — Free memory that was previously |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1504 allocated in the specified pool. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1505 Only allocations that result from requests forwarded to the system allocator |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1506 can be freed. |
1899 | 1507 </listitem> |
1508 | |
1509 </list> | |
1510 </para> | |
1511 | |
1512 <programlisting> | |
1513 u_char *p; | |
1514 ngx_str_t *s; | |
1515 ngx_pool_t *pool; | |
1516 | |
1517 pool = ngx_create_pool(1024, log); | |
1518 if (pool == NULL) { /* error */ } | |
1519 | |
1520 s = ngx_palloc(pool, sizeof(ngx_str_t)); | |
1521 if (s == NULL) { /* error */ } | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
1522 ngx_str_set(s, "foo"); |
1899 | 1523 |
1524 p = ngx_pnalloc(pool, 3); | |
1525 if (p == NULL) { /* error */ } | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
1526 ngx_memcpy(p, "foo", 3); |
1899 | 1527 </programlisting> |
1528 | |
1529 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1530 Chain links (<literal>ngx_chain_t</literal>) are actively used in nginx, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1531 so the nginx pool implementation provides a way to reuse them. |
1899 | 1532 The <literal>chain</literal> field of <literal>ngx_pool_t</literal> keeps a |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1533 list of previously allocated links ready for reuse. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1534 For efficient allocation of a chain link in a pool, use the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1535 <literal>ngx_alloc_chain_link(pool)</literal> function. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1536 This function looks up a free chain link in the pool list and allocates a new |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1537 chain link if the pool list is empty. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1538 To free a link, call the <literal>ngx_free_chain(pool, cl)</literal> function. |
1899 | 1539 </para> |
1540 | |
1541 <para> | |
1542 Cleanup handlers can be registered in a pool. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1543 A cleanup handler is a callback with an argument which is called when pool is |
1899 | 1544 destroyed. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1545 A pool is usually tied to a specific nginx object (like an HTTP request) and is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1546 destroyed when the object reaches the end of its lifetime. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1547 Registering a pool cleanup is a convenient way to release resources, close |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1548 file descriptors or make final adjustments to the shared data associated with |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1549 the main object. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1550 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1551 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1552 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1553 To register a pool cleanup, call |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1554 <literal>ngx_pool_cleanup_add(pool, size)</literal>, which returns a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1555 <literal>ngx_pool_cleanup_t</literal> pointer to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1556 be filled in by the caller. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1557 Use the <literal>size</literal> argument to allocate context for the cleanup |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1558 handler. |
1899 | 1559 </para> |
1560 | |
1561 | |
1562 <programlisting> | |
1563 ngx_pool_cleanup_t *cln; | |
1564 | |
1565 cln = ngx_pool_cleanup_add(pool, 0); | |
1566 if (cln == NULL) { /* error */ } | |
1567 | |
1568 cln->handler = ngx_my_cleanup; | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
1569 cln->data = "foo"; |
1899 | 1570 |
1571 ... | |
1572 | |
1573 static void | |
1574 ngx_my_cleanup(void *data) | |
1575 { | |
1576 u_char *msg = data; | |
1577 | |
1578 ngx_do_smth(msg); | |
1579 } | |
1580 </programlisting> | |
1581 | |
1582 </section> | |
1583 | |
1584 | |
1585 <section name="Shared memory" id="shared_memory"> | |
1586 | |
1587 <para> | |
1588 Shared memory is used by nginx to share common data between processes. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1589 The <literal>ngx_shared_memory_add(cf, name, size, tag)</literal> function adds |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1590 a new shared memory entry <literal>ngx_shm_zone_t</literal> to a cycle. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1591 The function receives the <literal>name</literal> and <literal>size</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1592 of the zone. |
1899 | 1593 Each shared zone must have a unique name. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1594 If a shared zone entry with the provided <literal>name</literal> and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1595 <literal>tag</literal> already exists, the existing zone entry is reused. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1596 The function fails with an error if an existing entry with the same name has a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1597 different tag. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1598 Usually, the address of the module structure is passed as |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1599 <literal>tag</literal>, making it possible to reuse shared zones by name within |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1600 one nginx module. |
1899 | 1601 </para> |
1602 | |
1603 <para> | |
1604 The shared memory entry structure <literal>ngx_shm_zone_t</literal> has the | |
1605 following fields: | |
1606 </para> | |
1607 | |
1608 <para> | |
1609 <list type="bullet"> | |
1610 | |
1611 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1612 <literal>init</literal> — Initialization callback, called after the shared zone |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1613 is mapped to actual memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1614 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1615 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1616 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1617 <literal>data</literal> — Data context, used to pass arbitrary data to the |
1899 | 1618 <literal>init</literal> callback |
1619 </listitem> | |
1620 | |
1621 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1622 <literal>noreuse</literal> — Flag that disables reuse of a shared zone from the |
1899 | 1623 old cycle |
1624 </listitem> | |
1625 | |
1626 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1627 <literal>tag</literal> — Shared zone tag |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1628 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1629 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1630 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1631 <literal>shm</literal> — Platform-specific object of type |
1899 | 1632 <literal>ngx_shm_t</literal>, having at least the following fields: |
1633 <list type="bullet"> | |
1634 | |
1635 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1636 <literal>addr</literal> — Mapped shared memory address, initially NULL |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1637 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1638 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1639 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1640 <literal>size</literal> — Shared memory size |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1641 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1642 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1643 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1644 <literal>name</literal> — Shared memory name |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1645 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1646 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1647 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1648 <literal>log</literal> — Shared memory log |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1649 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1650 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1651 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1652 <literal>exists</literal> — Flag that indicates shared memory was inherited |
1899 | 1653 from the master process (Windows-specific) |
1654 </listitem> | |
1655 | |
1656 </list> | |
1657 </listitem> | |
1658 | |
1659 </list> | |
1660 </para> | |
1661 | |
1662 <para> | |
1663 Shared zone entries are mapped to actual memory in | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1664 <literal>ngx_init_cycle()</literal> after the configuration is parsed. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1665 On POSIX systems, the <literal>mmap()</literal> syscall is used to create the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1666 shared anonymous mapping. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1667 On Windows, the <literal>CreateFileMapping()</literal>/ |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1668 <literal>MapViewOfFileEx()</literal> pair is used. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1669 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1670 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1671 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1672 For allocating in shared memory, nginx provides the slab pool |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1673 <literal>ngx_slab_pool_t</literal> type. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1674 A slab pool for allocating memory is automatically created in each nginx shared |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1675 zone. |
1899 | 1676 The pool is located in the beginning of the shared zone and can be accessed by |
1677 the expression <literal>(ngx_slab_pool_t *) shm_zone->shm.addr</literal>. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1678 To allocate memory in a shared zone, call either |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1679 <literal>ngx_slab_alloc(pool, size)</literal> or |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1680 <literal>ngx_slab_calloc(pool, size)</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1681 To free memory, call <literal>ngx_slab_free(pool, p)</literal>. |
1899 | 1682 </para> |
1683 | |
1684 <para> | |
1685 Slab pool divides all shared zone into pages. | |
1686 Each page is used for allocating objects of the same size. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1687 The specified size must be a power of 2, and greater than the minimum size of |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1688 8 bytes. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1689 Nonconforming values are rounded up. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1690 A bitmask for each page tracks which blocks are in use and which are free for |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1691 allocation. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1692 For sizes greater than a half page (which is usually 2048 bytes), allocation is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1693 done an entire page at a time |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1694 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1695 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1696 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1697 To protect data in shared memory from concurrent access, use the mutex |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1698 available in the <literal>mutex</literal> field of |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1699 <literal>ngx_slab_pool_t</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1700 A mutex is most commonly used by the slab pool while allocating and freeing |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1701 memory, but it can be used to protect any other user data structures allocated |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1702 in the shared zone. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1703 To lock or unlock a mutex, call |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1704 <literal>ngx_shmtx_lock(&shpool->mutex)</literal> or |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1705 <literal>ngx_shmtx_unlock(&shpool->mutex)</literal> respectively. |
1899 | 1706 </para> |
1707 | |
1708 | |
1709 <programlisting> | |
1710 ngx_str_t name; | |
1711 ngx_foo_ctx_t *ctx; | |
1712 ngx_shm_zone_t *shm_zone; | |
1713 | |
1714 ngx_str_set(&name, "foo"); | |
1715 | |
1716 /* allocate shared zone context */ | |
1717 ctx = ngx_pcalloc(cf->pool, sizeof(ngx_foo_ctx_t)); | |
1718 if (ctx == NULL) { | |
1719 /* error */ | |
1720 } | |
1721 | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1722 /* add an entry for 64k shared zone */ |
1899 | 1723 shm_zone = ngx_shared_memory_add(cf, &name, 65536, &ngx_foo_module); |
1724 if (shm_zone == NULL) { | |
1725 /* error */ | |
1726 } | |
1727 | |
1728 /* register init callback and context */ | |
1729 shm_zone->init = ngx_foo_init_zone; | |
1730 shm_zone->data = ctx; | |
1731 | |
1732 | |
1733 ... | |
1734 | |
1735 | |
1736 static ngx_int_t | |
1737 ngx_foo_init_zone(ngx_shm_zone_t *shm_zone, void *data) | |
1738 { | |
1739 ngx_foo_ctx_t *octx = data; | |
1740 | |
1741 size_t len; | |
1742 ngx_foo_ctx_t *ctx; | |
1743 ngx_slab_pool_t *shpool; | |
1744 | |
1745 value = shm_zone->data; | |
1746 | |
1747 if (octx) { | |
1748 /* reusing a shared zone from old cycle */ | |
1749 ctx->value = octx->value; | |
1750 return NGX_OK; | |
1751 } | |
1752 | |
1753 shpool = (ngx_slab_pool_t *) shm_zone->shm.addr; | |
1754 | |
1755 if (shm_zone->shm.exists) { | |
1756 /* initialize shared zone context in Windows nginx worker */ | |
1757 ctx->value = shpool->data; | |
1758 return NGX_OK; | |
1759 } | |
1760 | |
1761 /* initialize shared zone */ | |
1762 | |
1763 ctx->value = ngx_slab_alloc(shpool, sizeof(ngx_uint_t)); | |
1764 if (ctx->value == NULL) { | |
1765 return NGX_ERROR; | |
1766 } | |
1767 | |
1768 shpool->data = ctx->value; | |
1769 | |
1770 return NGX_OK; | |
1771 } | |
1772 </programlisting> | |
1773 | |
1774 </section> | |
1775 | |
1776 | |
1777 </section> | |
1778 | |
1779 | |
1780 <section name="Logging" id="logging"> | |
1781 | |
1782 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1783 For logging nginx uses <literal>ngx_log_t</literal> objects. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1784 The nginx logger supports several types of output: |
1899 | 1785 |
1786 <list type="bullet"> | |
1787 | |
1788 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1789 stderr — Logging to standard error (stderr) |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1790 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1791 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1792 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1793 file — Logging to a file |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1794 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1795 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1796 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1797 syslog — Logging to syslog |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1798 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1799 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1800 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1801 memory — Logging to internal memory storage for development purposes; the memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1802 can be accessed later with a debugger |
1899 | 1803 </listitem> |
1804 | |
1805 </list> | |
1806 </para> | |
1807 | |
1808 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1809 A logger instance can be a chain of loggers, linked to each other with |
1899 | 1810 the <literal>next</literal> field. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1811 In this case, each message is written to all loggers in the chain. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1812 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1813 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1814 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1815 For each logger, a severity level controls which messages are written to the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1816 log (only events assigned that level or higher are logged). |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1817 The following severity levels are supported: |
1899 | 1818 </para> |
1819 | |
1820 <para> | |
1821 <list type="bullet"> | |
1822 | |
1823 <listitem> | |
1824 <literal>NGX_LOG_EMERG</literal> | |
1825 </listitem> | |
1826 | |
1827 <listitem> | |
1828 <literal>NGX_LOG_ALERT</literal> | |
1829 </listitem> | |
1830 | |
1831 <listitem> | |
1832 <literal>NGX_LOG_CRIT</literal> | |
1833 </listitem> | |
1834 | |
1835 <listitem> | |
1836 <literal>NGX_LOG_ERR</literal> | |
1837 </listitem> | |
1838 | |
1839 <listitem> | |
1840 <literal>NGX_LOG_WARN</literal> | |
1841 </listitem> | |
1842 | |
1843 <listitem> | |
1844 <literal>NGX_LOG_NOTICE</literal> | |
1845 </listitem> | |
1846 | |
1847 <listitem> | |
1848 <literal>NGX_LOG_INFO</literal> | |
1849 </listitem> | |
1850 | |
1851 <listitem> | |
1852 <literal>NGX_LOG_DEBUG</literal> | |
1853 </listitem> | |
1854 | |
1855 </list> | |
1856 </para> | |
1857 | |
1858 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1859 For debug logging, the debug mask is checked as well. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1860 The debug masks are: |
1899 | 1861 </para> |
1862 | |
1863 <para> | |
1864 <list type="bullet"> | |
1865 | |
1866 <listitem> | |
1867 <literal>NGX_LOG_DEBUG_CORE</literal> | |
1868 </listitem> | |
1869 | |
1870 <listitem> | |
1871 <literal>NGX_LOG_DEBUG_ALLOC</literal> | |
1872 </listitem> | |
1873 | |
1874 <listitem> | |
1875 <literal>NGX_LOG_DEBUG_MUTEX</literal> | |
1876 </listitem> | |
1877 | |
1878 <listitem> | |
1879 <literal>NGX_LOG_DEBUG_EVENT</literal> | |
1880 </listitem> | |
1881 | |
1882 <listitem> | |
1883 <literal>NGX_LOG_DEBUG_HTTP</literal> | |
1884 </listitem> | |
1885 | |
1886 <listitem> | |
1887 <literal>NGX_LOG_DEBUG_MAIL</literal> | |
1888 </listitem> | |
1889 | |
1890 <listitem> | |
1891 <literal>NGX_LOG_DEBUG_STREAM</literal> | |
1892 </listitem> | |
1893 | |
1894 </list> | |
1895 </para> | |
1896 | |
1897 <para> | |
1898 Normally, loggers are created by existing nginx code from | |
1899 <literal>error_log</literal> directives and are available at nearly every stage | |
1900 of processing in cycle, configuration, client connection and other objects. | |
1901 </para> | |
1902 | |
1903 <para> | |
1904 Nginx provides the following logging macros: | |
1905 </para> | |
1906 | |
1907 <para> | |
1908 <list type="bullet"> | |
1909 | |
1910 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1911 <literal>ngx_log_error(level, log, err, fmt, ...)</literal> — Error logging |
1899 | 1912 </listitem> |
1913 | |
1914 <listitem> | |
1915 <literal>ngx_log_debug0(level, log, err, fmt)</literal>, | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1916 <literal>ngx_log_debug1(level, log, err, fmt, arg1)</literal> etc — Debug |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1917 logging with up to eight supported formatting arguments |
1899 | 1918 </listitem> |
1919 | |
1920 </list> | |
1921 </para> | |
1922 | |
1923 <para> | |
1924 A log message is formatted in a buffer of size | |
1925 <literal>NGX_MAX_ERROR_STR</literal> (currently, 2048 bytes) on stack. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1926 The message is prepended with the severity level, process ID (PID), connection |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1927 ID (stored in <literal>log->connection</literal>), and the system error text. |
1899 | 1928 For non-debug messages <literal>log->handler</literal> is called as well to |
1929 prepend more specific information to the log message. | |
1930 HTTP module sets <literal>ngx_http_log_error()</literal> function as log | |
1931 handler to log client and server addresses, current action (stored in | |
1932 <literal>log->action</literal>), client request line, server name etc. | |
1933 </para> | |
1934 | |
1935 <programlisting> | |
1936 /* specify what is currently done */ | |
1937 log->action = "sending mp4 to client”; | |
1938 | |
1939 /* error and debug log */ | |
1940 ngx_log_error(NGX_LOG_INFO, c->log, 0, "client prematurely | |
1941 closed connection”); | |
1942 | |
1943 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, mp4->file.log, 0, | |
1944 "mp4 start:%ui, length:%ui”, mp4->start, mp4->length); | |
1945 </programlisting> | |
1946 | |
1947 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1948 The example above results in log entries like these: |
1899 | 1949 </para> |
1950 | |
1951 | |
1952 <programlisting> | |
1953 2016/09/16 22:08:52 [info] 17445#0: *1 client prematurely closed connection while | |
1954 sending mp4 to client, client: 127.0.0.1, server: , request: "GET /file.mp4 HTTP/1.1” | |
1955 2016/09/16 23:28:33 [debug] 22140#0: *1 mp4 start:0, length:10000 | |
1956 </programlisting> | |
1957 | |
1958 </section> | |
1959 | |
1960 | |
1961 <section name="Cycle" id="cycle"> | |
1962 | |
1963 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1964 A cycle object stores the nginx runtime context created from a specific |
1899 | 1965 configuration. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1966 Its type is <literal>ngx_cycle_t</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1967 The current cycle is referenced by the <literal>ngx_cycle</literal> global |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1968 variable and inherited by nginx workers as they start. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1969 Each time the nginx configuration is reloaded, a new cycle is created from the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1970 new nginx configuration; the old cycle is usually deleted after the new one is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1971 successfully created. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1972 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1973 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1974 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1975 A cycle is created by the <literal>ngx_init_cycle()</literal> function, which |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1976 takes the previous cycle as its argument. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1977 The function locates the previous cycle's configuration file and inherits as |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1978 many resources as possible from the previous cycle. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1979 A placeholder cycle called "init cycle" is created as nginx start, then is |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1980 replaced by an actual cycle built from configuration. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1981 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1982 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1983 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1984 Members of the cycle include: |
1899 | 1985 </para> |
1986 | |
1987 <para> | |
1988 <list type="bullet"> | |
1989 | |
1990 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1991 <literal>pool</literal> — Cycle pool. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1992 Created for each new cycle. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1993 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1994 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1995 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1996 <literal>log</literal> — Cycle log. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1997 Initially inherited from the old cycle, it is set to point to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1998 <literal>new_log</literal> after the configuration is read. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
1999 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2000 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2001 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2002 <literal>new_log</literal> — Cycle log, created by the configuration. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2003 It's affected by the root-scope <literal>error_log</literal> directive. |
1899 | 2004 </listitem> |
2005 | |
2006 <listitem> | |
1981
082724c57c38
Fixes in cycle section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1980
diff
changeset
|
2007 <literal>connections</literal>, <literal>connection_n</literal> — |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2008 Array of connections of type <literal>ngx_connection_t</literal>, created by |
1899 | 2009 the event module while initializing each nginx worker. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2010 The <literal>worker_connections</literal> directive in the nginx configuration |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2011 sets the number of connections <literal>connection_n</literal>. |
1899 | 2012 </listitem> |
2013 | |
2014 <listitem> | |
2015 <literal>free_connections</literal>, | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2016 <literal>free_connection_n</literal> — List and number of currently available |
1899 | 2017 connections. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2018 If no connections are available, an nginx worker refuses to accept new clients |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2019 or connect to upstream servers. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2020 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2021 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2022 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2023 <literal>files</literal>, <literal>files_n</literal> — Array for mapping file |
1899 | 2024 descriptors to nginx connections. |
2025 This mapping is used by the event modules, having the | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2026 <literal>NGX_USE_FD_EVENT</literal> flag (currently, it's |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2027 <literal>poll</literal> and <literal>devpoll</literal>). |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2028 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2029 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2030 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2031 <literal>conf_ctx</literal> — Array of core module configurations. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2032 The configurations are created and filled during reading of nginx configuration |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2033 files. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2034 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2035 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2036 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2037 <literal>modules</literal>, <literal>modules_n</literal> — Array of modules |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2038 of type <literal>ngx_module_t</literal>, both static and dynamic, loaded by |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2039 the current configuration. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2040 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2041 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2042 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2043 <literal>listening</literal> — Array of listening objects of type |
1899 | 2044 <literal>ngx_listening_t</literal>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2045 Listening objects are normally added by the <literal>listen</literal> |
1899 | 2046 directive of different modules which call the |
2047 <literal>ngx_create_listening()</literal> function. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2048 Listen sockets are created based on the listening objects. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2049 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2050 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2051 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2052 <literal>paths</literal> — Array of paths of type <literal>ngx_path_t</literal>. |
1899 | 2053 Paths are added by calling the function <literal>ngx_add_path()</literal> from |
2054 modules which are going to operate on certain directories. | |
2055 These directories are created by nginx after reading configuration, if missing. | |
2056 Moreover, two handlers can be added for each path: | |
2057 | |
2058 <list type="bullet"> | |
2059 | |
2060 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2061 path loader — Executes only once in 60 seconds after starting or reloading |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2062 nginx. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2063 Normally, the loader reads the directory and stores data in nginx shared |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2064 memory. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2065 The handler is called from the dedicated nginx process “nginx cache loader”. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2066 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2067 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2068 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2069 path manager — Executes periodically. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2070 Normally, the manager removes old files from the directory and updates nginx |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2071 memory to reflect the changes. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2072 The handler is called from the dedicated “nginx cache manager” process. |
1899 | 2073 </listitem> |
2074 | |
2075 </list> | |
2076 </listitem> | |
2077 | |
2078 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2079 <literal>open_files</literal> — List of open file objects of type |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2080 <literal>ngx_open_file_t</literal>, which are created by calling the function |
1899 | 2081 <literal>ngx_conf_open_file()</literal>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2082 Currently, nginx uses this kind of open files for logging. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2083 After reading the configuration, nginx opens all files in the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2084 <literal>open_files</literal> list and stores each file descriptor in the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2085 object's <literal>fd</literal> field. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2086 The files are opened in append mode and are created if missing. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2087 The files in the list are reopened by nginx workers upon receiving the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2088 reopen signal (most often <literal>USR1</literal>). |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2089 In this case the descriptor in the <literal>fd</literal> field is changed to a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2090 new value. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2091 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2092 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2093 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2094 <literal>shared_memory</literal> — List of shared memory zones, each added by |
1899 | 2095 calling the <literal>ngx_shared_memory_add()</literal> function. |
2096 Shared zones are mapped to the same address range in all nginx processes and | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2097 are used to share common data, for example the HTTP cache in-memory tree. |
1899 | 2098 </listitem> |
2099 | |
2100 </list> | |
2101 </para> | |
2102 | |
2103 </section> | |
2104 | |
2105 <section name="Buffer" id="buffer"> | |
2106 | |
2107 <para> | |
2108 For input/output operations, nginx provides the buffer type | |
2109 <literal>ngx_buf_t</literal>. | |
2110 Normally, it's used to hold data to be written to a destination or read from a | |
2111 source. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2112 A buffer can reference data in memory or in a file and it's technically |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2113 possible for a buffer to reference both at the same time. |
1899 | 2114 Memory for the buffer is allocated separately and is not related to the buffer |
2115 structure <literal>ngx_buf_t</literal>. | |
2116 </para> | |
2117 | |
2118 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2119 The <literal>ngx_buf_t</literal> structure has the following fields: |
1899 | 2120 </para> |
2121 | |
2122 <para> | |
2123 <list type="bullet"> | |
2124 | |
2125 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2126 <literal>start</literal>, <literal>end</literal> — The boundaries of the memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2127 block allocated for the buffer. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2128 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2129 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2130 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2131 <literal>pos</literal>, <literal>last</literal> — The boundaries of the memory |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2132 buffer; normally a subrange of <literal>start</literal> .. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2133 <literal>end</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2134 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2135 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2136 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2137 <literal>file_pos</literal>, <literal>file_last</literal> — The boundaries of a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2138 file buffer, expressed as offsets from the beginning of the file. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2139 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2140 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2141 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2142 <literal>tag</literal> — Unique value used to distinguish buffers; created by |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2143 different nginx modules, usually for the purpose of buffer reuse. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2144 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2145 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2146 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2147 <literal>file</literal> — File object. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2148 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2149 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2150 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2151 <literal>temporary</literal> — Flag indicating that the buffer references |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2152 writable memory. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2153 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2154 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2155 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2156 <literal>memory</literal> — Flag indicating that the buffer references read-only |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2157 memory. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2158 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2159 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2160 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2161 <literal>in_file</literal> — Flag indicating that the buffer references data |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2162 in a file. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2163 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2164 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2165 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2166 <literal>flush</literal> — Flag indicating that all data prior to the buffer |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2167 need to be flushed. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2168 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2169 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2170 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2171 <literal>recycled</literal> — Flag indicating that the buffer can be reused and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2172 needs to be consumed as soon as possible. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2173 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2174 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2175 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2176 <literal>sync</literal> — Flag indicating that the buffer carries no data or |
1899 | 2177 special signal like <literal>flush</literal> or <literal>last_buf</literal>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2178 By default nginx considers such buffers an error condition, but this flag tells |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2179 nginx to skip the error check. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2180 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2181 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2182 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2183 <literal>last_buf</literal> — Flag indicating that the buffer is the last in |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2184 output. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2185 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2186 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2187 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2188 <literal>last_in_chain</literal> — Flag indicating that there are no more data |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2189 buffers in a request or subrequest. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2190 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2191 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2192 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2193 <literal>shadow</literal> — Reference to another ("shadow") buffer related to |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2194 the current buffer, usually in the sense that the buffer uses data from the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2195 shadow. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2196 When the buffer is consumed, the shadow buffer is normally also marked as |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2197 consumed. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2198 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2199 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2200 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2201 <literal>last_shadow</literal> — Flag indicating that the buffer is the last |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2202 one that references a particular shadow buffer. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2203 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2204 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2205 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2206 <literal>temp_file</literal> — Flag indicating that the buffer is in a temporary |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2207 file. |
1899 | 2208 </listitem> |
2209 | |
2210 </list> | |
2211 </para> | |
2212 | |
2213 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2214 For input and output operations buffers are linked in chains. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2215 A chain is a sequence of chain links of type <literal>ngx_chain_t</literal>, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2216 defined as follows: |
1899 | 2217 </para> |
2218 | |
2219 | |
2220 <programlisting> | |
2221 typedef struct ngx_chain_s ngx_chain_t; | |
2222 | |
2223 struct ngx_chain_s { | |
2224 ngx_buf_t *buf; | |
2225 ngx_chain_t *next; | |
2226 }; | |
2227 </programlisting> | |
2228 | |
2229 <para> | |
2230 Each chain link keeps a reference to its buffer and a reference to the next | |
2231 chain link. | |
2232 </para> | |
2233 | |
2234 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2235 An example of using buffers and chains: |
1899 | 2236 </para> |
2237 | |
2238 | |
2239 <programlisting> | |
2240 ngx_chain_t * | |
2241 ngx_get_my_chain(ngx_pool_t *pool) | |
2242 { | |
2243 ngx_buf_t *b; | |
2244 ngx_chain_t *out, *cl, **ll; | |
2245 | |
2246 /* first buf */ | |
2247 cl = ngx_alloc_chain_link(pool); | |
2248 if (cl == NULL) { /* error */ } | |
2249 | |
2250 b = ngx_calloc_buf(pool); | |
2251 if (b == NULL) { /* error */ } | |
2252 | |
2253 b->start = (u_char *) "foo"; | |
2254 b->pos = b->start; | |
2255 b->end = b->start + 3; | |
2256 b->last = b->end; | |
2257 b->memory = 1; /* read-only memory */ | |
2258 | |
2259 cl->buf = b; | |
2260 out = cl; | |
2261 ll = &cl->next; | |
2262 | |
2263 /* second buf */ | |
2264 cl = ngx_alloc_chain_link(pool); | |
2265 if (cl == NULL) { /* error */ } | |
2266 | |
2267 b = ngx_create_temp_buf(pool, 3); | |
2268 if (b == NULL) { /* error */ } | |
2269 | |
2270 b->last = ngx_cpymem(b->last, "foo", 3); | |
2271 | |
2272 cl->buf = b; | |
2273 cl->next = NULL; | |
2274 *ll = cl; | |
2275 | |
2276 return out; | |
2277 } | |
2278 </programlisting> | |
2279 | |
2280 </section> | |
2281 | |
2282 | |
2283 <section name="Networking" id="networking"> | |
2284 | |
2285 | |
2286 <!-- | |
2287 <section name="Network data types" id="network_data_types"> | |
2288 | |
2289 <para> | |
2290 TBD: ngx_addr_t, ngx_url_t, ngx_socket_t, ngx_sockaddr_t, parse url, parse | |
2291 address... | |
2292 </para> | |
2293 | |
2294 </section> | |
2295 --> | |
2296 | |
2297 <section name="Connection" id="connection"> | |
2298 | |
2299 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2300 The connection type <literal>ngx_connection_t</literal> is a wrapper around a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2301 socket descriptor. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2302 It includes the following fields: |
1899 | 2303 </para> |
2304 | |
2305 <para> | |
2306 <list type="bullet"> | |
2307 | |
2308 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2309 <literal>fd</literal> — Socket descriptor |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2310 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2311 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2312 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2313 <literal>data</literal> — Arbitrary connection context. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2314 Normally, it is a pointer to a higher-level object built on top of the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2315 connection, such as an HTTP request or a Stream session. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2316 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2317 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2318 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2319 <literal>read</literal>, <literal>write</literal> — Read and write events for |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2320 the connection. |
1899 | 2321 </listitem> |
2322 | |
2323 <listitem> | |
2324 <literal>recv</literal>, <literal>send</literal>, | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2325 <literal>recv_chain</literal>, <literal>send_chain</literal> — I/O operations |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2326 for the connection. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2327 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2328 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2329 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2330 <literal>pool</literal> — Connection pool. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2331 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2332 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2333 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2334 <literal>log</literal> — Connection log. |
1899 | 2335 </listitem> |
2336 | |
2337 <listitem> | |
2338 <literal>sockaddr</literal>, <literal>socklen</literal>, | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2339 <literal>addr_text</literal> — Remote socket address in binary and text forms. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2340 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2341 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2342 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2343 <literal>local_sockaddr</literal>, <literal>local_socklen</literal> — Local |
1899 | 2344 socket address in binary form. |
2345 Initially, these fields are empty. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2346 Use the <literal>ngx_connection_local_sockaddr()</literal> function to get the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2347 local socket address. |
1899 | 2348 </listitem> |
2349 | |
2350 <listitem> | |
2351 <literal>proxy_protocol_addr</literal>, <literal>proxy_protocol_port</literal> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2352 - PROXY protocol client address and port, if the PROXY protocol is enabled for |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2353 the connection. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2354 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2355 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2356 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2357 <literal>ssl</literal> — SSL context for the connection. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2358 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2359 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2360 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2361 <literal>reusable</literal> — Flag indicating the connection is in a state that |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2362 makes it eligible for reuse. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2363 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2364 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2365 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2366 <literal>close</literal> — Flag indicating that the connection is being reused |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2367 and needs to be closed. |
1899 | 2368 </listitem> |
2369 | |
2370 </list> | |
2371 </para> | |
2372 | |
2373 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2374 An nginx connection can transparently encapsulate the SSL layer. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2375 In this case the connection's <literal>ssl</literal> field holds a pointer to an |
1899 | 2376 <literal>ngx_ssl_connection_t</literal> structure, keeping all SSL-related data |
2377 for the connection, including <literal>SSL_CTX</literal> and | |
2378 <literal>SSL</literal>. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2379 The <literal>recv</literal>, <literal>send</literal>, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2380 <literal>recv_chain</literal>, and <literal>send_chain</literal> handlers are |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2381 set to SSL-enabled functions as well. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2382 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2383 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2384 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2385 The <literal>worker_connections</literal> directive in the nginx configuration |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2386 limits the number of connections per nginx worker. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2387 All connection structures are precreated when a worker starts and stored in |
1899 | 2388 the <literal>connections</literal> field of the cycle object. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2389 To retrieve a connection structure, use the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2390 <literal>ngx_get_connection(s, log)</literal> function. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2391 It takes as its <literal>s</literal> argument a socket descriptor, which needs |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2392 to be wrapped in a connection structure. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2393 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2394 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2395 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2396 Because the number of connections per worker is limited, nginx provides a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2397 way to grab connections that are currently in use. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2398 To enable or disable reuse of a connection, call the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2399 <literal>ngx_reusable_connection(c, reusable)</literal> function. |
1899 | 2400 Calling <literal>ngx_reusable_connection(c, 1)</literal> sets the |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2401 <literal>reuse</literal> flag in the connection structure and inserts the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2402 connection into the <literal>reusable_connections_queue</literal> of the cycle. |
1899 | 2403 Whenever <literal>ngx_get_connection()</literal> finds out there are no |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2404 available connections in the cycle's <literal>free_connections</literal> list, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2405 it calls <literal>ngx_drain_connections()</literal> to release a |
1899 | 2406 specific number of reusable connections. |
2407 For each such connection, the <literal>close</literal> flag is set and its read | |
2408 handler is called which is supposed to free the connection by calling | |
2409 <literal>ngx_close_connection(c)</literal> and make it available for reuse. | |
2410 To exit the state when a connection can be reused | |
2411 <literal>ngx_reusable_connection(c, 0)</literal> is called. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2412 HTTP client connections are an example of reusable connections in nginx; they |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2413 are marked as reusable until the first request byte is received from the client. |
1899 | 2414 </para> |
2415 | |
2416 </section> | |
2417 | |
2418 | |
2419 </section> | |
2420 | |
2421 | |
2422 <section name="Events" id="events"> | |
2423 | |
2424 | |
2425 <section name="Event" id="event"> | |
2426 | |
2427 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2428 Event object <literal>ngx_event_t</literal> in nginx provides a mechanism |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2429 for notification that a specific event has occurred. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2430 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2431 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2432 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2433 Fields in <literal>ngx_event_t</literal> include: |
1899 | 2434 </para> |
2435 | |
2436 <para> | |
2437 <list type="bullet"> | |
2438 | |
2439 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2440 <literal>data</literal> — Arbitrary event context used in event handlers, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2441 usually as pointer to a connection related to the event. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2442 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2443 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2444 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2445 <literal>handler</literal> — Callback function to be invoked when the event |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2446 happens. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2447 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2448 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2449 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2450 <literal>write</literal> — Flag indicating a write event. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2451 Absence of the flag indicates a read event. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2452 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2453 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2454 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2455 <literal>active</literal> — Flag indicating that the event is registered for |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2456 receiving I/O notifications, normally from notification mechanisms like |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2457 <literal>epoll</literal>, <literal>kqueue</literal>, <literal>poll</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2458 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2459 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2460 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2461 <literal>ready</literal> — Flag indicating that the event has received an |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2462 I/O notification. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2463 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2464 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2465 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2466 <literal>delayed</literal> — Flag indicating that I/O is delayed due to rate |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2467 limiting. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2468 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2469 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2470 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2471 <literal>timer</literal> — Red-black tree node for inserting the event into |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2472 the timer tree. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2473 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2474 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2475 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2476 <literal>timer_set</literal> — Flag indicating that the event timer is set and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2477 not yet expired. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2478 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2479 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2480 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2481 <literal>timedout</literal> — Flag indicating that the event timer has expired. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2482 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2483 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2484 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2485 <literal>eof</literal> — Flag indicating that EOF occurred while reading data. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2486 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2487 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2488 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2489 <literal>pending_eof</literal> — Flag indicating that EOF is pending on the |
1899 | 2490 socket, even though there may be some data available before it. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2491 The flag is delivered via the <literal>EPOLLRDHUP</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2492 <literal>epoll</literal> event or |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2493 <literal>EV_EOF</literal> <literal>kqueue</literal> flag. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2494 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2495 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2496 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2497 <literal>error</literal> — Flag indicating that an error occurred during |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2498 reading (for a read event) or writing (for a write event). |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2499 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2500 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2501 <listitem> |
1995
80f53da7280c
Updated cancelable event description in the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1994
diff
changeset
|
2502 <literal>cancelable</literal> — Timer event flag indicating that the event |
80f53da7280c
Updated cancelable event description in the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1994
diff
changeset
|
2503 should be ignored while shutting down the worker. |
80f53da7280c
Updated cancelable event description in the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1994
diff
changeset
|
2504 Graceful worker shutdown is delayed until there are no non-cancelable timer |
80f53da7280c
Updated cancelable event description in the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1994
diff
changeset
|
2505 events scheduled. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2506 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2507 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2508 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2509 <literal>posted</literal> — Flag indicating that the event is posted to a queue. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2510 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2511 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2512 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2513 <literal>queue</literal> — Queue node for posting the event to a queue. |
1899 | 2514 </listitem> |
2515 | |
2516 </list> | |
2517 </para> | |
2518 | |
2519 </section> | |
2520 | |
2521 | |
2522 <section name="I/O events" id="i_o_events"> | |
2523 | |
2524 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2525 Each connection obtained by calling the <literal>ngx_get_connection()</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2526 function has two attached events, <literal>c->read</literal> and |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2527 <literal>c->write</literal>, which are used for receiving notification that the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2528 socket is ready for reading or writing. |
1899 | 2529 All such events operate in Edge-Triggered mode, meaning that they only trigger |
2530 notifications when the state of the socket changes. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2531 For example, doing a partial read on a socket does not make nginx deliver a |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2532 repeated read notification until more data arrives on the socket. |
1899 | 2533 Even when the underlying I/O notification mechanism is essentially |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2534 Level-Triggered (<literal>poll</literal>, <literal>select</literal> etc), nginx |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2535 converts the notifications to Edge-Triggered. |
1899 | 2536 To make nginx event notifications consistent across all notifications systems |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2537 on different platforms, the functions |
1899 | 2538 <literal>ngx_handle_read_event(rev, flags)</literal> and |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2539 <literal>ngx_handle_write_event(wev, lowat)</literal> must be called after |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2540 handling an I/O socket notification or calling any I/O functions on that socket. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2541 Normally, the functions are called once at the end of each read or write |
1899 | 2542 event handler. |
2543 </para> | |
2544 | |
2545 </section> | |
2546 | |
2547 | |
2548 <section name="Timer events" id="timer_events"> | |
2549 | |
2550 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2551 An event can be set to send a notification when a timeout expires. |
1899 | 2552 The function <literal>ngx_add_timer(ev, timer)</literal> sets a timeout for an |
2553 event, <literal>ngx_del_timer(ev)</literal> deletes a previously set timeout. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2554 The global timeout red-black tree <literal>ngx_event_timer_rbtree</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2555 stores all timeouts currently set. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2556 The key in the tree is of type <literal>ngx_msec_t</literal> and is the time |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2557 when the event expires, expressed in milliseconds since the midnight on of |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2558 January 1, 1970 modulus <literal>ngx_msec_t</literal> max value. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2559 The tree structure enables fast insertion and deletion operations, as well as |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2560 access to the nearest timeouts, which nginx uses to find out how long to wait |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2561 for I/O events and for expiring timeout events. |
1899 | 2562 </para> |
2563 | |
2564 </section> | |
2565 | |
2566 | |
2567 <section name="Posted events" id="posted_events"> | |
2568 | |
2569 <para> | |
2570 An event can be posted which means that its handler will be called at some | |
2571 point later within the current event loop iteration. | |
2572 Posting events is a good practice for simplifying code and escaping stack | |
2573 overflows. | |
2574 Posted events are held in a post queue. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2575 The <literal>ngx_post_event(ev, q)</literal> mscro posts the event |
1899 | 2576 <literal>ev</literal> to the post queue <literal>q</literal>. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2577 The <literal>ngx_delete_posted_event(ev)</literal> macro deletes the event |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2578 <literal>ev</literal> from the queue it's currently posted in. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2579 Normally, events are posted to the <literal>ngx_posted_events</literal> queue, |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2580 which is processed late in the event loop — after all I/O and timer |
1899 | 2581 events are already handled. |
2582 The function <literal>ngx_event_process_posted()</literal> is called to process | |
2583 an event queue. | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2584 It calls event handlers until the queue is not empty. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2585 This means that a posted event handler can post more events to be processed |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2586 within the current event loop iteration. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2587 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2588 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2589 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2590 An example: |
1899 | 2591 </para> |
2592 | |
2593 | |
2594 <programlisting> | |
2595 void | |
2596 ngx_my_connection_read(ngx_connection_t *c) | |
2597 { | |
2598 ngx_event_t *rev; | |
2599 | |
2600 rev = c->read; | |
2601 | |
2602 ngx_add_timer(rev, 1000); | |
2603 | |
2604 rev->handler = ngx_my_read_handler; | |
2605 | |
2606 ngx_my_read(rev); | |
2607 } | |
2608 | |
2609 | |
2610 void | |
2611 ngx_my_read_handler(ngx_event_t *rev) | |
2612 { | |
2613 ssize_t n; | |
2614 ngx_connection_t *c; | |
2615 u_char buf[256]; | |
2616 | |
2617 if (rev->timedout) { /* timeout expired */ } | |
2618 | |
2619 c = rev->data; | |
2620 | |
2621 while (rev->ready) { | |
2622 n = c->recv(c, buf, sizeof(buf)); | |
2623 | |
2624 if (n == NGX_AGAIN) { | |
2625 break; | |
2626 } | |
2627 | |
2628 if (n == NGX_ERROR) { /* error */ } | |
2629 | |
2630 /* process buf */ | |
2631 } | |
2632 | |
2633 if (ngx_handle_read_event(rev, 0) != NGX_OK) { /* error */ } | |
2634 } | |
2635 </programlisting> | |
2636 | |
2637 </section> | |
2638 | |
2639 | |
2640 <section name="Event loop" id="event_loop"> | |
2641 | |
2642 <para> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2643 Except for the nginx master process, all nginx processes do I/O and so have an |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2644 event loop. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2645 (The nginx master process instead spends most of its time in the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2646 <literal>sigsuspend()</literal> call waiting for signals to arrive.) |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2647 The nginx event loop is implemented in the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2648 <literal>ngx_process_events_and_timers()</literal> function, which is called |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2649 repeatedly until the process exits. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2650 </para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2651 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2652 <para> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2653 The event loop has the following stages: |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2654 |
1899 | 2655 <list type="bullet"> |
2656 | |
2657 <listitem> | |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2658 Find the timeout that is closest to expiring, by calling |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2659 <literal>ngx_event_find_timer()</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2660 This function finds the leftmost node in the timer tree and returns the |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2661 number of milliseconds until the node expires. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2662 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2663 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2664 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2665 Process I/O events by calling a handler, specific to the event notification |
1899 | 2666 mechanism, chosen by nginx configuration. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2667 This handler waits for at least one I/O event to happen, but only until the next |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2668 timeout expires. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2669 When a read or write event occurs, the <literal>ready</literal> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2670 flag is set and the event's handler is called. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2671 For Linux, the <literal>ngx_epoll_process_events()</literal> handler |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2672 is normally used, which calls <literal>epoll_wait()</literal> to wait for I/O |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2673 events. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2674 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2675 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2676 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2677 Expire timers by calling <literal>ngx_event_expire_timers()</literal>. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2678 The timer tree is iterated from the leftmost element to the right until an |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2679 unexpired timeout is found. |
1899 | 2680 For each expired node the <literal>timedout</literal> event flag is set, |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2681 the <literal>timer_set</literal> flag is reset, and the event handler is called |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2682 </listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2683 |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2684 <listitem> |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2685 Process posted events by calling <literal>ngx_event_process_posted()</literal>. |
1899 | 2686 The function repeatedly removes the first element from the posted events |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
2687 queue and calls the element's handler, until the queue is empty. |
1899 | 2688 </listitem> |
2689 | |
2690 </list> | |
2691 </para> | |
2692 | |
2693 <para> | |
2694 All nginx processes handle signals as well. | |
2695 Signal handlers only set global variables which are checked after the | |
2696 <literal>ngx_process_events_and_timers()</literal> call. | |
2697 </para> | |
2698 | |
2699 </section> | |
2700 | |
2701 | |
2702 </section> | |
2703 | |
2704 | |
2705 <section name="Processes" id="processes"> | |
2706 | |
2707 <para> | |
2708 There are several types of processes in nginx. | |
2709 The type of current process is kept in the <literal>ngx_process</literal> | |
2710 global variable: | |
2711 </para> | |
2712 | |
2713 <list type="bullet"> | |
2714 | |
2715 <listitem> | |
2716 | |
2717 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2718 <literal>NGX_PROCESS_MASTER</literal> — the master process runs the |
1899 | 2719 <literal>ngx_master_process_cycle()</literal> function. |
2720 Master process does not have any I/O and responds only to signals. | |
2721 It reads configuration, creates cycles, starts and controls child processes | |
2722 </para> | |
2723 | |
2724 | |
2725 </listitem> | |
2726 | |
2727 <listitem> | |
2728 | |
2729 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2730 <literal>NGX_PROCESS_WORKER</literal> — the worker process runs the |
1899 | 2731 <literal>ngx_worker_process_cycle()</literal> function. |
2732 Worker processes are started by master and handle client connections. | |
2733 They also respond to signals and channel commands, sent from master | |
2734 </para> | |
2735 | |
2736 | |
2737 </listitem> | |
2738 | |
2739 <listitem> | |
2740 | |
2741 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2742 <literal>NGX_PROCESS_SINGLE</literal> — single process is the only type |
1899 | 2743 of processes which exist in the <literal>master_process off</literal> mode. |
2744 The cycle function for this process is | |
2745 <literal>ngx_single_process_cycle()</literal>. | |
2746 This process creates cycles and handles client connections | |
2747 </para> | |
2748 | |
2749 | |
2750 </listitem> | |
2751 | |
2752 <listitem> | |
2753 | |
2754 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2755 <literal>NGX_PROCESS_HELPER</literal> — currently, there are two types of |
1899 | 2756 helper processes: cache manager and cache loader. |
2757 Both of them share the same cycle function | |
2758 <literal>ngx_cache_manager_process_cycle()</literal>. | |
2759 </para> | |
2760 | |
2761 | |
2762 </listitem> | |
2763 | |
2764 </list> | |
2765 | |
2766 <para> | |
2767 All nginx processes handle the following signals: | |
2768 </para> | |
2769 | |
2770 <list type="bullet"> | |
2771 | |
2772 <listitem> | |
2773 | |
2774 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2775 <literal>NGX_SHUTDOWN_SIGNAL</literal> (<literal>SIGQUIT</literal>) — graceful |
1899 | 2776 shutdown. |
2777 Upon receiving this signal master process sends shutdown signal to all child | |
2778 processes. | |
2779 When no child processes are left, master destroys cycle pool and exits. | |
2780 A worker process which received this signal, closes all listening sockets and | |
2781 waits until timeout tree becomes empty, then destroys cycle pool and exits. | |
2782 A cache manager process exits right after receiving this signal. | |
2783 The variable <literal>ngx_quit</literal> is set to one after receiving this | |
2784 signal and immediately reset after being processed. | |
2785 The variable <literal>ngx_exiting</literal> is set to one when worker process | |
2786 is in shutdown state | |
2787 </para> | |
2788 | |
2789 | |
2790 </listitem> | |
2791 | |
2792 <listitem> | |
2793 | |
2794 <para> | |
2795 <literal>NGX_TERMINATE_SIGNAL</literal> (<literal>SIGTERM</literal>) - | |
2796 terminate. | |
2797 Upon receiving this signal master process sends terminate signal to all child | |
2798 processes. | |
2799 If child processes do not exit in 1 second, they are killed with the | |
2800 <literal>SIGKILL</literal> signal. | |
2801 When no child processes are left, master process destroys cycle pool and exits. | |
2802 A worker or cache manager process which received this signal destroys cycle | |
2803 pool and exits. | |
2804 The variable <literal>ngx_terminate</literal> is set to one after receiving | |
2805 this signal | |
2806 </para> | |
2807 | |
2808 | |
2809 </listitem> | |
2810 | |
2811 <listitem> | |
2812 | |
2813 <para> | |
2814 <literal>NGX_NOACCEPT_SIGNAL</literal> (<literal>SIGWINCH</literal>) | |
2815 - gracefully shut down worker processes | |
2816 </para> | |
2817 | |
2818 | |
2819 </listitem> | |
2820 | |
2821 <listitem> | |
2822 | |
2823 <para> | |
2824 <literal>NGX_RECONFIGURE_SIGNAL</literal> (<literal>SIGHUP</literal>) - | |
2825 reconfigure. | |
2826 Upon receiving this signal master process creates a new cycle from | |
2827 configuration file. | |
2828 If the new cycle was created successfully, the old cycle is deleted and new | |
2829 child processes are started. | |
2830 Meanwhile, the old processes receive the shutdown signal. | |
2831 In single-process mode, nginx creates a new cycle as well, but keeps the old | |
2832 one until all clients, tied to the old cycle, are gone. | |
2833 Worker and helper processes ignore this signal | |
2834 </para> | |
2835 | |
2836 | |
2837 </listitem> | |
2838 | |
2839 <listitem> | |
2840 | |
2841 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2842 <literal>NGX_REOPEN_SIGNAL</literal> (<literal>SIGUSR1</literal>) — reopen |
1899 | 2843 files. |
2844 Master process passes this signal to workers. | |
2845 Worker processes reopen all <literal>open_files</literal> from the cycle | |
2846 </para> | |
2847 | |
2848 | |
2849 </listitem> | |
2850 | |
2851 <listitem> | |
2852 | |
2853 <para> | |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
2854 <literal>NGX_CHANGEBIN_SIGNAL</literal> (<literal>SIGUSR2</literal>) — change |
1899 | 2855 nginx binary. |
2856 Master process starts a new nginx binary and passes there a list of all listen | |
2857 sockets. | |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
2858 The list is passed in the environment variable <literal>“NGINX”</literal> in |
1899 | 2859 text format, where descriptor numbers separated with semicolons. |
2860 A new nginx instance reads that variable and adds the sockets to its init | |
2861 cycle. | |
2862 Other processes ignore this signal | |
2863 </para> | |
2864 | |
2865 | |
2866 </listitem> | |
2867 | |
2868 </list> | |
2869 | |
2870 <para> | |
2871 While all nginx worker processes are able to receive and properly handle POSIX | |
2872 signals, master process normally does not pass any signals to workers and | |
2873 helpers with the standard <literal>kill()</literal> syscall. | |
2874 Instead, nginx uses inter-process channels which allow sending messages between | |
2875 all nginx processes. | |
2876 Currently, however, messages are only sent from master to its children. | |
2877 Those messages carry the same signals. | |
2878 The channels are socketpairs with their ends in different processes. | |
2879 </para> | |
2880 | |
2881 <para> | |
2882 When running nginx binary, several values can be specified next to | |
2883 <literal>-s</literal> parameter. | |
2884 Those values are <literal>stop</literal>, <literal>quit</literal>, | |
2885 <literal>reopen</literal>, <literal>reload</literal>. | |
2886 They are converted to signals <literal>NGX_TERMINATE_SIGNAL</literal>, | |
2887 <literal>NGX_SHUTDOWN_SIGNAL</literal>, <literal>NGX_REOPEN_SIGNAL</literal> | |
2888 and <literal>NGX_RECONFIGURE_SIGNAL</literal> and sent to the nginx master | |
2889 process, whose pid is read from nginx pid file. | |
2890 </para> | |
2891 | |
2892 </section> | |
2893 | |
1983
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2894 <section name="Threads" id="threads"> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2895 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2896 <para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2897 It is possible to offload tasks that would otherwise block nginx worker process |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2898 into a separate thread. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2899 For example, nginx may be configured to use threads to perform |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2900 <link doc="../http/ngx_http_core_module.xml" id="aio">file I/O</link>. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2901 Another example is using a library that doesn't have asynchronous interface |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2902 and thus cannot be normally used with nginx. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2903 Keep in mind that threads interface is a helper for existing asynchronous |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2904 approach in processing client connections, and by no means a replacement. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2905 </para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2906 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2907 <para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2908 To deal with synchronization the following wrappers over pthreads primitives |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2909 are available: |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2910 <programlisting> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2911 typedef pthread_mutex_t ngx_thread_mutex_t; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2912 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2913 ngx_int_t ngx_thread_mutex_create(ngx_thread_mutex_t *mtx, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2914 ngx_int_t ngx_thread_mutex_destroy(ngx_thread_mutex_t *mtx, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2915 ngx_int_t ngx_thread_mutex_lock(ngx_thread_mutex_t *mtx, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2916 ngx_int_t ngx_thread_mutex_unlock(ngx_thread_mutex_t *mtx, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2917 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2918 typedef pthread_cond_t ngx_thread_cond_t; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2919 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2920 ngx_int_t ngx_thread_cond_create(ngx_thread_cond_t *cond, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2921 ngx_int_t ngx_thread_cond_destroy(ngx_thread_cond_t *cond, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2922 ngx_int_t ngx_thread_cond_signal(ngx_thread_cond_t *cond, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2923 ngx_int_t ngx_thread_cond_wait(ngx_thread_cond_t *cond, ngx_thread_mutex_t *mtx, |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2924 ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2925 </programlisting> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2926 </para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2927 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2928 <para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2929 Instead of creating a new thread for each task, nginx implements |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2930 a <link doc="../ngx_core_module.xml" id="thread_pool"/> strategy. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2931 Multiple thread pools may be configured intended for different purposes |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2932 (for example, performing I/O on different sets of disks). |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2933 Each thread pool is created on start and contains a limited number of threads |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2934 that process a queue of tasks. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2935 When a task is completed, a predefined completion handler is called. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2936 </para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2937 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2938 <para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2939 The <literal>src/core/ngx_thread_pool.h</literal> header file contains |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2940 corresponding definitions: |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2941 <programlisting> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2942 struct ngx_thread_task_s { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2943 ngx_thread_task_t *next; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2944 ngx_uint_t id; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2945 void *ctx; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2946 void (*handler)(void *data, ngx_log_t *log); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2947 ngx_event_t event; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2948 }; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2949 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2950 typedef struct ngx_thread_pool_s ngx_thread_pool_t; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2951 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2952 ngx_thread_pool_t *ngx_thread_pool_add(ngx_conf_t *cf, ngx_str_t *name); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2953 ngx_thread_pool_t *ngx_thread_pool_get(ngx_cycle_t *cycle, ngx_str_t *name); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2954 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2955 ngx_thread_task_t *ngx_thread_task_alloc(ngx_pool_t *pool, size_t size); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2956 ngx_int_t ngx_thread_task_post(ngx_thread_pool_t *tp, ngx_thread_task_t *task); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2957 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2958 </programlisting> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2959 At configuration time, a module willing to use threads has to obtain a |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2960 reference to thread pool by calling |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2961 <literal>ngx_thread_pool_add(cf, name)</literal> which will either create a |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2962 new thread pool with given <literal>name</literal> or return a reference |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2963 to an existing one if a pool with such name already exists. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2964 </para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2965 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2966 <para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2967 At runtime, the <literal>ngx_thread_task_post(tp, task)</literal> function |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2968 is used to add a <literal>task</literal> into a queue of a thread pool |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2969 <literal>tp</literal>. |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2970 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2971 The <literal>ngx_thread_task_t</literal> structure contains all necessary |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2972 to execute user function in thread, pass parameters and setup completion |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2973 handler: |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2974 <programlisting> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2975 typedef struct { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2976 int foo; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2977 } my_thread_ctx_t; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2978 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2979 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2980 static void |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2981 my_thread_func(void *data, ngx_log_t *log) |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2982 { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2983 my_thread_ctx_t *ctx = data; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2984 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2985 /* this function is executed in a separate thread */ |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2986 } |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2987 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2988 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2989 static void |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2990 my_thread_completion(ngx_event_t *ev) |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2991 { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2992 my_thread_ctx_t *ctx = ev->data; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2993 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2994 /* executed in nginx event loop */ |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2995 } |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2996 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2997 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2998 ngx_int_t |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
2999 my_task_offload(my_conf_t *conf) |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3000 { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3001 my_thread_ctx_t *ctx; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3002 ngx_thread_task_t *task; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3003 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3004 task = ngx_thread_task_alloc(conf->pool, sizeof(my_thread_ctx_t)); |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3005 if (task == NULL) { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3006 return NGX_ERROR; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3007 } |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3008 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3009 ctx = task->ctx; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3010 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3011 ctx->foo = 42; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3012 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3013 task->handler = my_thread_func; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3014 task->event.handler = my_thread_completion; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3015 task->event.data = ctx; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3016 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3017 if (ngx_thread_task_post(conf->thread_pool, task) != NGX_OK) { |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3018 return NGX_ERROR; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3019 } |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3020 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3021 return NGX_OK; |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3022 } |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3023 </programlisting> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3024 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3025 </para> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3026 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3027 </section> |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3028 |
7660d6390a9d
Added the "Threads" section into the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1982
diff
changeset
|
3029 |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3030 <section name="Modules" id="Modules"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3031 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3032 <section name="Adding new modules" id="adding_new_modules"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3033 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3034 The standalone nginx module resides in a separate directory that contains |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3035 at least two files: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3036 <literal>config</literal> and a file with the module source. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3037 The first file contains all information needed for nginx to integrate |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3038 the module, for example: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3039 <programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3040 ngx_module_type=CORE |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3041 ngx_module_name=ngx_foo_module |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3042 ngx_module_srcs="$ngx_addon_dir/ngx_foo_module.c" |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3043 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3044 . auto/module |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3045 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3046 ngx_addon_name=$ngx_module_name |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3047 </programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3048 The file is a POSIX shell script and it can set (or access) the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3049 following variables: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3050 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3051 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3052 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3053 <literal>ngx_module_type</literal> — the type of module to build. |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3054 Possible options are <literal>CORE</literal>, <literal>HTTP</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3055 <literal>HTTP_FILTER</literal>, <literal>HTTP_INIT_FILTER</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3056 <literal>HTTP_AUX_FILTER</literal>, <literal>MAIL</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3057 <literal>STREAM</literal>, or <literal>MISC</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3058 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3059 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3060 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3061 <literal>ngx_module_name</literal> — the name of the module. |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3062 A whitespace separated values list is accepted and may be used to build |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3063 multiple modules from a single set of source files. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3064 The first name indicates the name of the output binary for a dynamic module. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3065 The names in this list should match the names used in the module. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3066 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3067 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3068 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3069 <literal>ngx_addon_name</literal> — supplies the name of the module in the |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3070 console output text of the configure script. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3071 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3072 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3073 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3074 <literal>ngx_module_srcs</literal> — a whitespace separated list of source |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3075 files used to compile the module. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3076 The $ngx_addon_dir variable can be used as a placeholder for the path of the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3077 module source. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3078 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3079 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3080 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3081 <literal>ngx_module_incs</literal> — include paths required to build the module |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3082 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3083 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3084 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3085 <literal>ngx_module_deps</literal> — a list of module's header files. |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3086 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3087 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3088 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3089 <literal>ngx_module_libs</literal> — a list of libraries to link with the |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3090 module. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3091 For example, libpthread would be linked using |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3092 <literal>ngx_module_libs=-lpthread</literal>. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3093 The following macros can be used to link against the same libraries as |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3094 nginx: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3095 <literal>LIBXSLT</literal>, <literal>LIBGD</literal>, <literal>GEOIP</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3096 <literal>PCRE</literal>, <literal>OPENSSL</literal>, <literal>MD5</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3097 <literal>SHA1</literal>, <literal>ZLIB</literal>, and <literal>PERL</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3098 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3099 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3100 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3101 <literal>ngx_module_link</literal> — set by the build system to |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3102 <literal>DYNAMIC</literal> for a dynamic module or <literal>ADDON</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3103 for a static module and used to perform different actions depending on |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3104 linking type. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3105 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3106 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3107 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3108 <literal>ngx_module_order</literal> — sets the load order for the module which |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3109 is useful for <literal>HTTP_FILTER</literal> and |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3110 <literal>HTTP_AUX_FILTER</literal> module types. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3111 The order is stored in a reverse list. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3112 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3113 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3114 The <literal>ngx_http_copy_filter_module</literal> is near the bottom of the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3115 list so is one of the first to be executed. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3116 This reads the data for other filters. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3117 Near the top of the list is <literal>ngx_http_write_filter_module</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3118 which writes the data out and is one of the last to be executed. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3119 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3120 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3121 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3122 The format for this option is typically the current module’s name followed by |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3123 a whitespace separated list of modules to insert before, and therefore execute |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3124 after. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3125 The module will be inserted before the last module in the list that is found |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3126 to be currently loaded. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3127 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3128 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3129 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3130 By default for filter modules this is set to |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3131 “<literal>ngx_http_copy_filter</literal>” which will insert the module before |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3132 the copy filter in the list and therefore will execute after the copy filter. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3133 For other module types the default is empty. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3134 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3135 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3136 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3137 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3138 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3139 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3140 A module can be added to nginx by means of the configure script using |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3141 <literal>--add-module=/path/to/module</literal> for static compilation and |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3142 <literal>--add-dynamic-module=/path/to/module</literal> for dynamic compilation. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3143 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3144 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3145 </section> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3146 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3147 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3148 <section name="Core modules" id="core_modules"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3149 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3150 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3151 Modules are building blocks of nginx, and most of its functionality is |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3152 implemented as modules. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3153 The module source file must contain a global variable of |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3154 <literal>ngx_module_t</literal> type which is defined as follows: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3155 <programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3156 struct ngx_module_s { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3157 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3158 /* private part is omitted */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3159 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3160 void *ctx; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3161 ngx_command_t *commands; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3162 ngx_uint_t type; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3163 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3164 ngx_int_t (*init_master)(ngx_log_t *log); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3165 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3166 ngx_int_t (*init_module)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3167 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3168 ngx_int_t (*init_process)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3169 ngx_int_t (*init_thread)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3170 void (*exit_thread)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3171 void (*exit_process)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3172 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3173 void (*exit_master)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3174 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3175 /* stubs for future extensions are omitted */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3176 }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3177 </programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3178 The omitted private part includes module version, signature and is filled |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3179 using the predefined macro <literal>NGX_MODULE_V1</literal>. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3180 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3181 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3182 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3183 Each module keeps its private data in the <literal>ctx</literal> field, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3184 recognizes specific configuration directives, specified in the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3185 <literal>commands</literal> array, and may be invoked at certain stages of |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3186 nginx lifecycle. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3187 The module lifecycle consists of the following events: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3188 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3189 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3190 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3191 <listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3192 Configuration directive handlers are called as they appear |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3193 in configuration files in the context of the master process |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3194 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3195 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3196 <listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3197 The <literal>init_module</literal> handler is called in the context of |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3198 the master process after the configuration is parsed successfully |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3199 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3200 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3201 <listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3202 The master process creates worker process(es) and |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3203 <literal>init_process</literal> handler is called in each of them |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3204 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3205 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3206 <listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3207 When a worker process receives the shutdown command from master, it invokes |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3208 the <literal>exit_process</literal> handler |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3209 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3210 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3211 <listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3212 The master process calls the <literal>exit_master</literal> handler before |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3213 exiting. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3214 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3215 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3216 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3217 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3218 <note> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3219 <literal>init_module</literal> handler may be called multiple times |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3220 in the master process if the configuration reload is requested. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3221 </note> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3222 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3223 The <literal>init_master</literal>, <literal>init_thread</literal> and |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3224 <literal>exit_thread</literal> handlers are not implemented at the moment; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3225 Threads in nginx are only used as supplementary I/O facility with its own |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3226 API and <literal>init_master</literal> handler looks unnecessary. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3227 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3228 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3229 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3230 The module <literal>type</literal> defines what exactly is stored in the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3231 <literal>ctx</literal> field. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3232 There are several types of modules: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3233 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3234 <listitem><literal>NGX_CORE_MODULE</literal></listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3235 <listitem><literal>NGX_EVENT_MODULE</literal></listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3236 <listitem><literal>NGX_HTTP_MODULE</literal></listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3237 <listitem><literal>NGX_MAIL_MODULE</literal></listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3238 <listitem><literal>NGX_STREAM_MODULE</literal></listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3239 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3240 The <literal>NGX_CORE_MODULE</literal> is the most basic and thus the most |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3241 generic and most low-level type of module. Other module types are implemented |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3242 on top of it and provide more convenient way to deal with corresponding |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3243 problem domains, like handling events or http requests. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3244 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3245 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3246 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3247 The examples of core modules are <literal>ngx_core_module</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3248 <literal>ngx_errlog_module</literal>, <literal>ngx_regex_module</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3249 <literal>ngx_thread_pool_module</literal>, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3250 <literal>ngx_openssl_module</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3251 modules and, of course, http, stream, mail and event modules itself. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3252 The context of a core module is defined as: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3253 <programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3254 typedef struct { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3255 ngx_str_t name; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3256 void *(*create_conf)(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3257 char *(*init_conf)(ngx_cycle_t *cycle, void *conf); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3258 } ngx_core_module_t; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3259 </programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3260 where the <literal>name</literal> is a string with a module name for |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3261 convenience, <literal>create_conf</literal> and <literal>init_conf</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3262 are pointers to functions that create and initialize module configuration |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3263 correspondingly. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3264 For core modules, nginx will call <literal>create_conf</literal> before parsing |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3265 a new configuration and <literal>init_conf</literal> after all configuration |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3266 was parsed successfully. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3267 The typical <literal>create_conf</literal> function allocates memory for the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3268 configuration and sets default values. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3269 The <literal>init_conf</literal> deals with known configuration and thus may |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3270 perform sanity checks and complete initialization. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3271 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3272 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3273 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3274 For example, the simplistic <literal>ngx_foo_module</literal> can look like |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3275 this: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3276 <programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3277 /* |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3278 * Copyright (C) Author. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3279 */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3280 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3281 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3282 #include <ngx_config.h> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3283 #include <ngx_core.h> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3284 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3285 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3286 typedef struct { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3287 ngx_flag_t enable; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3288 } ngx_foo_conf_t; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3289 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3290 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3291 static void *ngx_foo_create_conf(ngx_cycle_t *cycle); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3292 static char *ngx_foo_init_conf(ngx_cycle_t *cycle, void *conf); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3293 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3294 static char *ngx_foo_enable(ngx_conf_t *cf, void *post, void *data); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3295 static ngx_conf_post_t ngx_foo_enable_post = { ngx_foo_enable }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3296 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3297 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3298 static ngx_command_t ngx_foo_commands[] = { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3299 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3300 { ngx_string("foo_enabled"), |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3301 NGX_MAIN_CONF|NGX_DIRECT_CONF|NGX_CONF_FLAG, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3302 ngx_conf_set_flag_slot, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3303 0, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3304 offsetof(ngx_foo_conf_t, enable), |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3305 &ngx_foo_enable_post }, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3306 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3307 ngx_null_command |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3308 }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3309 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3310 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3311 static ngx_core_module_t ngx_foo_module_ctx = { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3312 ngx_string("foo"), |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3313 ngx_foo_create_conf, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3314 ngx_foo_init_conf |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3315 }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3316 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3317 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3318 ngx_module_t ngx_foo_module = { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3319 NGX_MODULE_V1, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3320 &ngx_foo_module_ctx, /* module context */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3321 ngx_foo_commands, /* module directives */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3322 NGX_CORE_MODULE, /* module type */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3323 NULL, /* init master */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3324 NULL, /* init module */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3325 NULL, /* init process */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3326 NULL, /* init thread */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3327 NULL, /* exit thread */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3328 NULL, /* exit process */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3329 NULL, /* exit master */ |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3330 NGX_MODULE_V1_PADDING |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3331 }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3332 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3333 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3334 static void * |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3335 ngx_foo_create_conf(ngx_cycle_t *cycle) |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3336 { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3337 ngx_foo_conf_t *fcf; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3338 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3339 fcf = ngx_pcalloc(cycle->pool, sizeof(ngx_foo_conf_t)); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3340 if (fcf == NULL) { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3341 return NULL; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3342 } |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3343 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3344 fcf->enable = NGX_CONF_UNSET; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3345 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3346 return fcf; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3347 } |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3348 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3349 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3350 static char * |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3351 ngx_foo_init_conf(ngx_cycle_t *cycle, void *conf) |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3352 { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3353 ngx_foo_conf_t *fcf = conf; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3354 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3355 ngx_conf_init_value(fcf->enable, 0); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3356 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3357 return NGX_CONF_OK; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3358 } |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3359 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3360 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3361 static char * |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3362 ngx_foo_enable(ngx_conf_t *cf, void *post, void *data) |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3363 { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3364 ngx_flag_t *fp = data; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3365 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3366 if (*fp == 0) { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3367 return NGX_CONF_OK; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3368 } |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3369 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3370 ngx_log_error(NGX_LOG_NOTICE, cf->log, 0, "Foo Module is enabled"); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3371 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3372 return NGX_CONF_OK; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3373 } |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3374 </programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3375 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3376 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3377 </section> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3378 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3379 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3380 <section name="Configuration directives" id="config_directives"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3381 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3382 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3383 The <literal>ngx_command_t</literal> describes single configuration directive. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3384 Each module, supporting configuration, provides an array of such specifications |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3385 that describe how to process arguments and what handlers to call: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3386 <programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3387 struct ngx_command_s { |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3388 ngx_str_t name; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3389 ngx_uint_t type; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3390 char *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3391 ngx_uint_t conf; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3392 ngx_uint_t offset; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3393 void *post; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3394 }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3395 </programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3396 The array should be terminated by a special value |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3397 “<literal>ngx_null_command</literal>”. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3398 The <literal>name</literal> is the literal name of a directive, as it appears |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3399 in configuration file, for example “<literal>worker_processes</literal>” or |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3400 “<literal>listen</literal>”. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3401 The <literal>type</literal> is a bitfield that controls number of arguments, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3402 command type and other properties using corresponding flags. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3403 Arguments flags: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3404 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3405 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3406 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3407 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3408 <literal>NGX_CONF_NOARGS</literal> — directive without arguments |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3409 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3410 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3411 <listitem><literal>NGX_CONF_1MORE</literal> — one required argument</listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3412 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3413 <listitem><literal>NGX_CONF_2MORE</literal> — two required arguments</listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3414 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3415 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3416 <literal>NGX_CONF_TAKE1..7</literal> — exactly 1..7 arguments |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3417 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3418 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3419 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3420 <literal>NGX_CONF_TAKE12, 13, 23, 123, 1234</literal> — one or two arguments, |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3421 or other combinations |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3422 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3423 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3424 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3425 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3426 Directive types: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3427 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3428 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3429 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3430 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3431 <literal>NGX_CONF_BLOCK</literal> — the directive is a block, i.e. it may |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3432 contain other directives in curly braces, or even implement its own parser |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3433 to handle contents inside. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3434 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3435 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3436 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3437 <literal>NGX_CONF_FLAG</literal> — the directive value is a flag, a boolean |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3438 value represented by “<literal>on</literal>” or “<literal>off</literal>” |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3439 strings. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3440 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3441 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3442 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3443 Context of a directive defines where in the configuration it may appear |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3444 and how to access module context to store corresponding values: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3445 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3446 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3447 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3448 <literal>NGX_MAIN_CONF</literal> — top level configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3449 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3450 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3451 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3452 <literal>NGX_HTTP_MAIN_CONF</literal> — in the http block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3453 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3454 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3455 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3456 <literal>NGX_HTTP_SRV_CONF</literal> — in the http server block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3457 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3458 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3459 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3460 <literal>NGX_HTTP_LOC_CONF</literal> — in the http location |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3461 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3462 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3463 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3464 <literal>NGX_HTTP_UPS_CONF</literal> — in the http upstream block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3465 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3466 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3467 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3468 <literal>NGX_HTTP_SIF_CONF</literal> — in the http server “if” |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3469 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3470 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3471 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3472 <literal>NGX_HTTP_LIF_CONF</literal> — in the http location “if” |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3473 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3474 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3475 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3476 <literal>NGX_HTTP_LMT_CONF</literal> — in the http “limit_except” |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3477 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3478 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3479 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3480 <literal>NGX_STREAM_MAIN_CONF</literal> — in the stream block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3481 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3482 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3483 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3484 <literal>NGX_STREAM_SRV_CONF</literal> — in the stream server block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3485 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3486 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3487 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3488 <literal>NGX_STREAM_UPS_CONF</literal> — in the stream upstream block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3489 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3490 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3491 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3492 <literal>NGX_MAIL_MAIN_CONF</literal> — in the the mail block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3493 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3494 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3495 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3496 <literal>NGX_MAIL_SRV_CONF</literal> — in the mail server block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3497 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3498 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3499 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3500 <literal>NGX_EVENT_CONF</literal> — in the event block |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3501 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3502 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3503 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3504 <literal>NGX_DIRECT_CONF</literal> — used by modules that don't |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3505 create a hierarchy of contexts and store module configuration directly in ctx |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3506 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3507 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3508 The configuration parser uses this flags to throw an error in case of |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3509 a misplaced directive and calls directive handlers supplied with a proper |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3510 configuration pointer, so that same directives in different locations could |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3511 store their values in distinct places. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3512 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3513 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3514 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3515 The <literal>set</literal> field defines a handler that processes a directive |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3516 and stores parsed values into corresponding configuration. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3517 Nginx offers a convenient set of functions that perform common conversions: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3518 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3519 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3520 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3521 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3522 <literal>ngx_conf_set_flag_slot</literal> — converts literal |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3523 “<literal>on</literal>” or “<literal>off</literal>” strings into |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3524 <literal>ngx_flag_t</literal> type with values 1 or 0 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3525 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3526 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3527 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3528 <literal>ngx_conf_set_str_slot</literal> — stores string as a value of the |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3529 <literal>ngx_str_t</literal> type |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3530 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3531 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3532 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3533 <literal>ngx_conf_set_str_array_slot</literal> — appends |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3534 <literal>ngx_array_t</literal> of <literal>ngx_str_t</literal> with a new value. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3535 The array is created if not yet exists |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3536 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3537 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3538 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3539 <literal>ngx_conf_set_keyval_slot</literal> — appends |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3540 <literal>ngx_array_t</literal> of <literal>ngx_keyval_t</literal> with |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3541 a new value, where key is the first string and value is second. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3542 The array is created if not yet exists |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3543 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3544 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3545 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3546 <literal>ngx_conf_set_num_slot</literal> — converts directive argument |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3547 to a <literal>ngx_int_t</literal> value |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3548 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3549 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3550 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3551 <literal>ngx_conf_set_size_slot</literal> — converts |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3552 <link doc="../syntax.xml">size</link> to <literal>size_t</literal> value |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3553 in bytes |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3554 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3555 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3556 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3557 <literal>ngx_conf_set_off_slot</literal> — converts |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3558 <link doc="../syntax.xml">offset</link> to <literal>off_t</literal> value |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3559 in bytes |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3560 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3561 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3562 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3563 <literal>ngx_conf_set_msec_slot</literal> — converts |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3564 <link doc="../syntax.xml">time</link> to <literal>ngx_msec_t</literal> value |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3565 in milliseconds |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3566 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3567 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3568 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3569 <literal>ngx_conf_set_sec_slot</literal> — converts |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3570 <link doc="../syntax.xml">time</link> to <literal>time_t</literal> value |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3571 in seconds |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3572 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3573 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3574 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3575 <literal>ngx_conf_set_bufs_slot</literal> — converts two arguments |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3576 into <literal>ngx_bufs_t</literal> that holds <literal>ngx_int_t</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3577 number and <link doc="../syntax.xml">size</link> of buffers |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3578 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3579 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3580 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3581 <literal>ngx_conf_set_enum_slot</literal> — converts argument |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3582 into <literal>ngx_uint_t</literal> value. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3583 The null-terminated array of <literal>ngx_conf_enum_t</literal> passed in the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3584 <literal>post</literal> field defines acceptable strings and corresponding |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3585 integer values |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3586 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3587 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3588 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3589 <literal>ngx_conf_set_bitmask_slot</literal> — arguments are converted to |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3590 <literal>ngx_uint_t</literal> value and OR'ed with the resulting value, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3591 forming a bitmask. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3592 The null-terminated array of <literal>ngx_conf_bitmask_t</literal> passed in |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3593 the <literal>post</literal> field defines acceptable strings and corresponding |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3594 mask values |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3595 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3596 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3597 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3598 <literal>set_path_slot</literal> — converts arguments to |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3599 <literal>ngx_path_t</literal> type and performs all required initializations. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3600 See the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3601 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_temp_path">proxy_temp_path</link> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3602 directive description for details |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3603 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3604 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3605 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3606 <literal>set_access_slot</literal> — converts arguments to file permissions |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3607 mask. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3608 See the |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3609 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_store_access">proxy_store_access</link> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3610 directive description for details |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3611 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3612 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3613 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3614 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3615 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3616 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3617 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3618 The <literal>conf</literal> field defines which context is used to store |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3619 the value of the directive, or zero if contexts are not used. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3620 Only simple core modules use configuration without context and set |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3621 <literal>NGX_DIRECT_CONF</literal> flag. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3622 In real life, such modules like http or stream require more sophisticated |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3623 configuration that can be applied per-server or per-location, or even more |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3624 precisely, in the context of the “<literal>if</literal>” directive or |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3625 some limit. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3626 In this modules, configuration structure is more complex. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3627 Please refer to corresponding modules description to understand how |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3628 they manage their configuration. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3629 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3630 <list type="bullet"> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3631 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3632 <literal>NGX_HTTP_MAIN_CONF_OFFSET</literal> — http block configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3633 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3634 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3635 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3636 <literal>NGX_HTTP_SRV_CONF_OFFSET</literal> — http server configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3637 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3638 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3639 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3640 <literal>NGX_HTTP_LOC_CONF_OFFSET</literal> — http location configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3641 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3642 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3643 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3644 <literal>NGX_STREAM_MAIN_CONF_OFFSET</literal> — stream block configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3645 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3646 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3647 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3648 <literal>NGX_STREAM_SRV_CONF_OFFSET</literal> — stream server configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3649 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3650 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3651 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3652 <literal>NGX_MAIL_MAIN_CONF_OFFSET</literal> — mail block configuration |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3653 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3654 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3655 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3656 <literal>NGX_MAIL_SRV_CONF_OFFSET</literal> — mail server configuration |
1928
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3657 </listitem> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3658 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3659 </list> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3660 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3661 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3662 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3663 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3664 The <literal>offset</literal> defines an offset of a field in a module |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3665 configuration structure that holds values of this particular directive. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3666 The typical use is to employ <literal>offsetof()</literal> macro. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3667 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3668 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3669 <para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3670 The <literal>post</literal> is a twofold field: it may be used to define |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3671 a handler to be called after main handler completed or to pass additional |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3672 data to the main handler. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3673 In the first case, <literal>ngx_conf_post_t</literal> structure needs to |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3674 be initialized with a pointer to handler, for example: |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3675 <programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3676 static char *ngx_do_foo(ngx_conf_t *cf, void *post, void *data); |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3677 static ngx_conf_post_t ngx_foo_post = { ngx_do_foo }; |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3678 </programlisting> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3679 The <literal>post</literal> argument is the <literal>ngx_conf_post_t</literal> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3680 object itself, and the <literal>data</literal> is a pointer to value, |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3681 converted from arguments by the main handler with the appropriate type. |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3682 </para> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3683 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3684 </section> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3685 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3686 </section> |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3687 |
2c14a16c61eb
Added modules section to development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1920
diff
changeset
|
3688 |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3689 <section name="HTTP" id="http"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3690 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3691 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3692 <section name="Connection" id="http_connection"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3693 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3694 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3695 Each client HTTP connection runs through the following stages: |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3696 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3697 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3698 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3699 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3700 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3701 <literal>ngx_event_accept()</literal> accepts a client TCP connection. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3702 This handler is called in response to a read notification on a listen socket. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3703 A new <literal>ngx_connecton_t</literal> object is created at this stage. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3704 The object wraps the newly accepted client socket. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3705 Each nginx listener provides a handler to pass the new connection object to. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3706 For HTTP connections it's <literal>ngx_http_init_connection(c)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3707 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3708 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3709 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3710 <literal>ngx_http_init_connection()</literal> performs early initialization of |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3711 an HTTP connection. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3712 At this stage an <literal>ngx_http_connection_t</literal> object is created for |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3713 the connection and its reference is stored in connection's |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3714 <literal>data</literal> field. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3715 Later it will be substituted with an HTTP request object. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3716 PROXY protocol parser and SSL handshake are started at this stage as well |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3717 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3718 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3719 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3720 <literal>ngx_http_wait_request_handler()</literal> is a read event handler, that |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3721 is called when data is available in the client socket. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3722 At this stage an HTTP request object <literal>ngx_http_request_t</literal> is |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3723 created and set to connection's <literal>data</literal> field |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3724 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3725 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3726 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3727 <literal>ngx_http_process_request_line()</literal> is a read event handler, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3728 which reads client request line. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3729 The handler is set by <literal>ngx_http_wait_request_handler()</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3730 Reading is done into connection's <literal>buffer</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3731 The size of the buffer is initially set by the directive |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3732 <link doc="../http/ngx_http_core_module.xml" id="client_header_buffer_size"/>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3733 The entire client header is supposed to fit the buffer. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3734 If the initial size is not enough, a bigger buffer is allocated, whose size is |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3735 set by the <literal>large_client_header_buffers</literal> directive |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3736 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3737 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3738 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3739 <literal>ngx_http_process_request_headers()</literal> is a read event handler, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3740 which is set after <literal>ngx_http_process_request_line()</literal> to read |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3741 client request header |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3742 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3743 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3744 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3745 <literal>ngx_http_core_run_phases()</literal> is called when the request header |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3746 is completely read and parsed. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3747 This function runs request phases from |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3748 <literal>NGX_HTTP_POST_READ_PHASE</literal> to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3749 <literal>NGX_HTTP_CONTENT_PHASE</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3750 The last phase is supposed to generate response and pass it along the filter |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3751 chain. |
1979 | 3752 The response is not necessarily sent to the client at this phase. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3753 It may remain buffered and will be sent at the finalization stage |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3754 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3755 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3756 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3757 <literal>ngx_http_finalize_request()</literal> is usually called when the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3758 request has generated all the output or produced an error. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3759 In the latter case an appropriate error page is looked up and used as the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3760 response. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3761 If the response is not completely sent to the client by this point, an |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3762 HTTP writer <literal>ngx_http_writer()</literal> is activated to finish |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3763 sending outstanding data |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3764 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3765 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3766 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3767 <literal>ngx_http_finalize_connection()</literal> is called when the response is |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3768 completely sent to the client and the request can be destroyed. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3769 If client connection keepalive feature is enabled, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3770 <literal>ngx_http_set_keepalive()</literal> is called, which destroys current |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3771 request and waits for the next request on the connection. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3772 Otherwise, <literal>ngx_http_close_request()</literal> destroys both the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3773 request and the connection |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3774 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3775 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3776 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3777 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3778 </section> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3779 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3780 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3781 <section name="Request" id="http_request"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3782 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3783 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3784 For each client HTTP request the <literal>ngx_http_request_t</literal> object is |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3785 created. Some of the fields of this object: |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3786 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3787 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3788 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3789 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3790 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3791 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3792 <para> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3793 <literal>connection</literal> — pointer to a <literal>ngx_connection_t</literal> |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3794 client connection object. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3795 Several requests may reference the same connection object at the same time - |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3796 one main request and its subrequests. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3797 After a request is deleted, a new request may be created on the same connection. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3798 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3799 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3800 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3801 Note that for HTTP connections <literal>ngx_connection_t</literal>'s |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3802 <literal>data</literal> field points back to the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3803 Such request is called active, as opposed to the other requests tied with the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3804 connection. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3805 Active request is used to handle client connection events and is allowed to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3806 output its response to the client. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3807 Normally, each request becomes active at some point to be able to send its |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3808 output |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3809 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3810 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3811 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3812 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3813 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3814 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3815 <para> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3816 <literal>ctx</literal> — array of HTTP module contexts. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3817 Each module of type <literal>NGX_HTTP_MODULE</literal> can store any value |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3818 (normally, a pointer to a structure) in the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3819 The value is stored in the <literal>ctx</literal> array at the module's |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3820 <literal>ctx_index</literal> position. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3821 The following macros provide a convenient way to get and set request contexts: |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3822 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3823 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3824 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3825 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3826 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3827 <literal>ngx_http_get_module_ctx(r, module)</literal> — returns |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3828 <literal>module</literal>'s context |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3829 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3830 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3831 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3832 <literal>ngx_http_set_ctx(r, c, module)</literal> — sets <literal>c</literal> |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3833 as <literal>module</literal>'s context |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3834 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3835 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3836 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3837 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3838 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3839 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3840 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3841 <literal>main_conf, srv_conf, loc_conf</literal> — arrays of current request |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3842 configurations. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3843 Configurations are stored at module's <literal>ctx_index</literal> positions |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3844 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3845 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3846 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3847 <literal>read_event_handler</literal>, <literal>write_event_handler</literal> - |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3848 read and write event handlers for the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3849 Normally, an HTTP connection has <literal>ngx_http_request_handler()</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3850 set as both read and write event handlers. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3851 This function calls <literal>read_event_handler</literal> and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3852 <literal>write_event_handler</literal> handlers of the currently active request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3853 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3854 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3855 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3856 <literal>cache</literal> — request cache object for caching upstream response |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3857 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3858 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3859 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3860 <literal>upstream</literal> — request upstream object for proxying |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3861 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3862 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3863 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3864 <literal>pool</literal> — request pool. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3865 This pool is destroyed when the request is deleted. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3866 The request object itself is allocated in this pool. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3867 For allocations which should be available throughout the client connection's |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3868 lifetime, <literal>ngx_connection_t</literal>'s pool should be used instead |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3869 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3870 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3871 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3872 <literal>header_in</literal> — buffer where client HTTP request header in read |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3873 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3874 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3875 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3876 <literal>headers_in, headers_out</literal> — input and output HTTP headers |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3877 objects. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3878 Both objects contain the <literal>headers</literal> field of type |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3879 <literal>ngx_list_t</literal> keeping the raw list of headers. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3880 In addition to that, specific headers are available for getting and setting as |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3881 separate fields, for example <literal>content_length_n</literal>, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3882 <literal>status</literal> etc |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3883 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3884 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3885 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3886 <literal>request_body</literal> — client request body object |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3887 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3888 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3889 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3890 <literal>start_sec, start_msec</literal> — time point when the request was |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3891 created. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3892 Used for tracking request duration |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3893 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3894 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3895 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3896 <literal>method, method_name</literal> — numeric and textual representation of |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3897 client HTTP request method. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3898 Numeric values for methods are defined in |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3899 <literal>src/http/ngx_http_request.h</literal> with macros |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3900 <literal>NGX_HTTP_GET, NGX_HTTP_HEAD, NGX_HTTP_POST</literal> etc |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3901 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3902 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3903 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3904 <literal>http_protocol, http_version, http_major, http_minor</literal> - |
1936
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
3905 client HTTP protocol version in its original textual form (“HTTP/1.0”, |
8f996938fe23
Style: proper quotes usage.
Vladimir Homutov <vl@nginx.com>
parents:
1935
diff
changeset
|
3906 “HTTP/1.1” etc), numeric form (<literal>NGX_HTTP_VERSION_10</literal>, |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3907 <literal>NGX_HTTP_VERSION_11</literal> etc) and separate major and minor |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3908 versions |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3909 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3910 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3911 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3912 <literal>request_line, unparsed_uri</literal> — client original request line |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3913 and URI |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3914 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3915 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3916 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3917 <literal>uri, args, exten</literal> — current request URI, arguments and file |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3918 extention. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3919 The URI value here might differ from the original URI sent by the client due to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3920 normalization. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3921 Throughout request processing, these value can change while performing internal |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3922 redirects |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3923 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3924 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3925 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3926 <literal>main</literal> — pointer to a main request object. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3927 This object is created to process client HTTP request, as opposed to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3928 subrequests, created to perform a specific sub-task within the main request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3929 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3930 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3931 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3932 <literal>parent</literal> — pointer to a parent request of a subrequest |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3933 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3934 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3935 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3936 <literal>postponed</literal> — list of output buffers and subrequests in the |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3937 order they are sent and created. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3938 The list is used by the postpone filter to provide consistent request output, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3939 when parts of it are created by subrequests |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3940 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3941 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3942 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3943 <literal>post_subrequest</literal> — pointer to a handler with context to be |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3944 called when a subrequest gets finalized. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3945 Unused for main requests |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3946 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3947 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3948 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3949 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3950 <para> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3951 <literal>posted_requests</literal> — list of requests to be started or |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3952 resumed. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3953 Starting or resuming is done by calling the request's |
1932 | 3954 <literal>write_event_handler</literal>. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3955 Normally, this handler holds the request main function, which at first runs |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3956 request phases and then produces the output. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3957 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3958 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3959 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3960 A request is usually posted by the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3961 <literal>ngx_http_post_request(r, NULL)</literal> call. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3962 It is always posted to the main request <literal>posted_requests</literal> list. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3963 The function <literal>ngx_http_run_posted_requests(c)</literal> runs all |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3964 requests, posted in the main request of the passed connection's active request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3965 This function should be called in all event handlers, which can lead to new |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3966 posted requests. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3967 Normally, it's called always after invoking a request's read or write handler |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3968 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3969 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3970 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3971 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3972 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3973 <literal>phase_handler</literal> — index of current request phase |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3974 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3975 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3976 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3977 <literal>ncaptures, captures, captures_data</literal> — regex captures produced |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3978 by the last regex match of the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3979 While processing a request, there's a number of places where a regex match can |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3980 happen: map lookup, server lookup by SNI or HTTP Host, rewrite, proxy_redirect |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3981 etc. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3982 Captures produced by a lookup are stored in the above mentioned fields. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3983 The field <literal>ncaptures</literal> holds the number of captures, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3984 <literal>captures</literal> holds captures boundaries, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3985 <literal>captures_data</literal> holds a string, against which the regex was |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3986 matched and which should be used to extract captures. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3987 After each new regex match request captures are reset to hold new values |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3988 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3989 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3990 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
3991 <literal>count</literal> — request reference counter. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3992 The field only makes sense for the main request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3993 Increasing the counter is done by simple <literal>r->main->count++</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3994 To decrease the counter <literal>ngx_http_finalize_request(r, rc)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3995 should be called. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3996 Creation of a subrequest or running request body read process increase the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3997 counter |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3998 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
3999 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4000 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4001 <literal>subrequests</literal> — current subrequest nesting level. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4002 Each subrequest gets the nesting level of its parent decreased by one. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4003 Once the value reaches zero an error is generated. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4004 The value for the main request is defined by the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4005 <literal>NGX_HTTP_MAX_SUBREQUESTS</literal> constant |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4006 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4007 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4008 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4009 <literal>uri_changes</literal> — number of URI changes left for the request. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4010 The total number of times a request can change its URI is limited by the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4011 <literal>NGX_HTTP_MAX_URI_CHANGES</literal> constant. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4012 With each change the value is decreased until it reaches zero. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4013 In the latter case an error is generated. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4014 The actions considered as URI changes are rewrites and internal redirects to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4015 normal or named locations |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4016 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4017 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4018 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4019 <literal>blocked</literal> — counter of blocks held on the request. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4020 While this value is non-zero, request cannot be terminated. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4021 Currently, this value is increased by pending AIO operations (POSIX AIO and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4022 thread operations) and active cache lock |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4023 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4024 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4025 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4026 <literal>buffered</literal> — bitmask showing which modules have buffered the |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4027 output produced by the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4028 A number of filters can buffer output, for example sub_filter can buffer data |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4029 due to a partial string match, copy filter can buffer data because of the lack |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4030 of free output_buffers etc. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4031 As long as this value is non-zero, request is not finalized, expecting the flush |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4032 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4033 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4034 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4035 <literal>header_only</literal> — flag showing that output does not require body. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4036 For example, this flag is used by HTTP HEAD requests |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4037 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4038 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4039 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4040 <para> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4041 <literal>keepalive</literal> — flag showing if client connection keepalive is |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4042 supported. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4043 The value is inferred from HTTP version and <header>Connection</header> header |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4044 value |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4045 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4046 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4047 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4048 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4049 <literal>header_sent</literal> — flag showing that output header has already |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4050 been sent by the request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4051 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4052 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4053 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4054 <literal>internal</literal> — flag showing that current request is internal. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4055 To enter the internal state, a request should pass through an internal |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4056 redirect or be a subrequest. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4057 Internal requests are allowed to enter internal locations |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4058 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4059 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4060 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4061 <literal>allow_ranges</literal> — flag showing that partial response can be |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4062 sent to client, if requested by the HTTP Range header |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4063 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4064 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4065 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4066 <literal>subrequest_ranges</literal> — flag showing that a partial response is |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4067 allowed to be sent while processing a subrequest |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4068 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4069 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4070 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4071 <literal>single_range</literal> — flag showing that only a single continuous |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4072 range of output data can be sent to the client. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4073 This flag is usually set when sending a stream of data, for example from a |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4074 proxied server, and the entire response is not available at once |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4075 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4076 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4077 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4078 <literal>main_filter_need_in_memory, filter_need_in_memory</literal> — flags |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4079 showing that the output should be produced in memory buffers but not in files. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4080 This is a signal to the copy filter to read data from file buffers even if |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4081 sendfile is enabled. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4082 The difference between these two flags is the location of filter modules which |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4083 set them. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4084 Filters called before the postpone filter in filter chain, set |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4085 <literal>filter_need_in_memory</literal> requesting that only the current |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4086 request output should come in memory buffers. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4087 Filters called later in filter chain set |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4088 <literal>main_filter_need_in_memory</literal> requiring that both the main |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4089 request and all the subrequest read files in memory while sending output |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4090 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4091 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4092 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4093 <literal>filter_need_temporary</literal> — flag showing that the request output |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4094 should be produced in temporary buffers, but not in readonly memory buffers or |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4095 file buffers. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4096 This is used by filters which may change output directly in the buffers, where |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4097 it's sent </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4098 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4099 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4100 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4101 </section> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4102 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4103 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4104 <section name="Configuration" id="http_conf"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4105 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4106 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4107 Each HTTP module may have three types of configuration: |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4108 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4109 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4110 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4111 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4112 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4113 Main configuration. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4114 This configuration applies to the entire nginx http{} block. This is global |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4115 configuration. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4116 It stores global settings for a module |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4117 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4118 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4119 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4120 Server configuration. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4121 This configuration applies to a single nginx server{}. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4122 It stores server-specific settings for a module |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4123 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4124 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4125 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4126 Location configuration. |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4127 This configuration applies to a single location{}, if{} or limit_except() block. |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4128 This configuration stores settings specific to a location |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4129 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4130 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4131 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4132 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4133 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4134 Configuration structures are created at nginx configuration stage by calling |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4135 functions, which allocate these structures, initialize them and merge. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4136 The following example shows how to create a simple module location |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4137 configuration. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4138 The configuration has one setting <literal>foo</literal> of unsiged integer |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4139 type. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4140 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4141 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4142 <programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4143 typedef struct { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4144 ngx_uint_t foo; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4145 } ngx_http_foo_loc_conf_t; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4146 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4147 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4148 static ngx_http_module_t ngx_http_foo_module_ctx = { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4149 NULL, /* preconfiguration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4150 NULL, /* postconfiguration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4151 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4152 NULL, /* create main configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4153 NULL, /* init main configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4154 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4155 NULL, /* create server configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4156 NULL, /* merge server configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4157 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4158 ngx_http_foo_create_loc_conf, /* create location configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4159 ngx_http_foo_merge_loc_conf /* merge location configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4160 }; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4161 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4162 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4163 static void * |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4164 ngx_http_foo_create_loc_conf(ngx_conf_t *cf) |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4165 { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4166 ngx_http_foo_loc_conf_t *conf; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4167 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4168 conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_foo_loc_conf_t)); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4169 if (conf == NULL) { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4170 return NULL; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4171 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4172 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4173 conf->foo = NGX_CONF_UNSET_UINT; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4174 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4175 return conf; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4176 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4177 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4178 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4179 static char * |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4180 ngx_http_foo_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child) |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4181 { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4182 ngx_http_foo_loc_conf_t *prev = parent; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4183 ngx_http_foo_loc_conf_t *conf = child; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4184 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4185 ngx_conf_merge_uint_value(conf->foo, prev->foo, 1); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4186 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4187 </programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4188 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4189 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4190 As seen in the example, <literal>ngx_http_foo_create_loc_conf()</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4191 function creates a new configuration structure and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4192 <literal>ngx_http_foo_merge_loc_conf()</literal> merges a configuration with |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4193 another configuration from a higher level. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4194 In fact, server and location configuration do not only exist at server and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4195 location levels, but also created for all the levels above. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4196 Specifically, a server configuration is created at the main level as well and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4197 location configurations are created for main, server and location levels. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4198 These configurations make it possible to specify server and location-specific |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4199 settings at any level of nginx configuration file. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4200 Eventually configurations are merged down. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4201 To indicate a missing setting and ignore it while merging, nginx provides a |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4202 number of macros like <literal>NGX_CONF_UNSET</literal> and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4203 <literal>NGX_CONF_UNSET_UINT</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4204 Standard nginx merge macros like <literal>ngx_conf_merge_value()</literal> and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4205 <literal>ngx_conf_merge_uint_value()</literal> provide a convenient way to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4206 merge a setting and set the default value if none of configurations provided an |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4207 explicit value. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4208 For complete list of macros for different types see |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4209 <literal>src/core/ngx_conf_file.h</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4210 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4211 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4212 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4213 To access configuration of any HTTP module at configuration time, the following |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4214 macros are available. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4215 They receive <literal>ngx_conf_t</literal> reference as the first argument. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4216 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4217 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4218 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4219 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4220 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4221 <literal>ngx_http_conf_get_module_main_conf(cf, module)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4222 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4223 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4224 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4225 <literal>ngx_http_conf_get_module_srv_conf(cf, module)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4226 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4227 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4228 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4229 <literal>ngx_http_conf_get_module_loc_conf(cf, module)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4230 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4231 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4232 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4233 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4234 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4235 The following example gets a pointer to a location configuration of |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4236 standard nginx core module |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4237 <link doc="../http/ngx_http_core_module.xml">ngx_http_core_module</link> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4238 and changes |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4239 location content handler kept in the <literal>handler</literal> field of the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4240 structure. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4241 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4242 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4243 <programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4244 static ngx_int_t ngx_http_foo_handler(ngx_http_request_t *r); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4245 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4246 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4247 static ngx_command_t ngx_http_foo_commands[] = { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4248 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4249 { ngx_string("foo"), |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4250 NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4251 ngx_http_foo, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4252 0, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4253 0, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4254 NULL }, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4255 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4256 ngx_null_command |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4257 }; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4258 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4259 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4260 static char * |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4261 ngx_http_foo(ngx_conf_t *cf, ngx_command_t *cmd, void *conf) |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4262 { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4263 ngx_http_core_loc_conf_t *clcf; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4264 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4265 clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4266 clcf->handler = ngx_http_bar_handler; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4267 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4268 return NGX_CONF_OK; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4269 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4270 </programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4271 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4272 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4273 In runtime the following macros are available to get configurations of HTTP |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4274 modules. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4275 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4276 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4277 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4278 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4279 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4280 <literal>ngx_http_get_module_main_conf(r, module)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4281 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4282 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4283 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4284 <literal>ngx_http_get_module_srv_conf(r, module)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4285 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4286 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4287 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4288 <literal>ngx_http_get_module_loc_conf(r, module)</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4289 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4290 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4291 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4292 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4293 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4294 These macros receive a reference to an HTTP request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4295 <literal>ngx_http_request_t</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4296 Main configuration of a request never changes. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4297 Server configuration may change from a default one after choosing a virtual |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4298 server for a request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4299 Request location configuration may change multiple times as a result of a |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4300 rewrite or internal redirect. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4301 The following example shows how to access HTTP configuration in runtime. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4302 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4303 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4304 <programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4305 static ngx_int_t |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4306 ngx_http_foo_handler(ngx_http_request_t *r) |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4307 { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4308 ngx_http_foo_loc_conf_t *flcf; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4309 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4310 flcf = ngx_http_get_module_loc_conf(r, ngx_http_foo_module); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4311 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4312 ... |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4313 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4314 </programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4315 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4316 </section> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4317 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4318 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4319 <section name="Phases" id="http_phases"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4320 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4321 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4322 Each HTTP request passes through a list of HTTP phases. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4323 Each phase is specialized in a particular type of processing. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4324 Most phases allow installing handlers. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4325 The phase handlers are called successively once the request reaches the phase. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4326 Many standard nginx modules install their phase handlers as a way to get called |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4327 at a specific request processing stage. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4328 Following is the list of nginx HTTP phases. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4329 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4330 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4331 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4332 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4333 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4334 <literal>NGX_HTTP_POST_READ_PHASE</literal> is the earliest phase. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4335 The <link doc="../http/ngx_http_realip_module.xml">ngx_http_realip_module</link> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4336 installs its handler at this phase. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4337 This allows to substitute client address before any other module is invoked |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4338 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4339 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4340 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4341 <literal>NGX_HTTP_SERVER_REWRITE_PHASE</literal> is used to run rewrite script, |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4342 defined at the server level, that is out of any location block. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4343 The |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4344 <link doc="../http/ngx_http_rewrite_module.xml">ngx_http_rewrite_module</link> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4345 installs its handler at this phase |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4346 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4347 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4348 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4349 <literal>NGX_HTTP_FIND_CONFIG_PHASE</literal> — a special phase used to choose a |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4350 location based on request URI. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4351 This phase does not allow installing any handlers. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4352 It only performs the default action of choosing a location. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4353 Before this phase, the server default location is assigned to the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4354 Any module requesting a location configuration, will receive the default server |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4355 location configuration. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4356 After this phase a new location is assigned to the request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4357 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4358 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4359 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4360 <literal>NGX_HTTP_REWRITE_PHASE</literal> — same as |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4361 <literal>NGX_HTTP_SERVER_REWRITE_PHASE</literal>, but for a new location, |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4362 chosen at the previous phase |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4363 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4364 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4365 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4366 <literal>NGX_HTTP_POST_REWRITE_PHASE</literal> — a special phase, used to |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4367 redirect the request to a new location, if the URI was changed during rewrite. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4368 The redirect is done by going back to |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4369 <literal>NGX_HTTP_FIND_CONFIG_PHASE</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4370 No handlers are allowed at this phase |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4371 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4372 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4373 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4374 <literal>NGX_HTTP_PREACCESS_PHASE</literal> — a common phase for different |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4375 types of handlers, not associated with access check. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4376 Standard nginx modules |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4377 <link doc="../http/ngx_http_limit_conn_module.xml">ngx_http_limit_conn_module |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4378 </link> and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4379 <link doc="../http/ngx_http_limit_req_module.xml"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4380 ngx_http_limit_req_module</link> register their handlers at this phase |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4381 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4382 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4383 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4384 <literal>NGX_HTTP_ACCESS_PHASE</literal> — used to check access permissions |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4385 for the request. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4386 Standard nginx modules such as |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4387 <link doc="../http/ngx_http_access_module.xml">ngx_http_access_module</link> and |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4388 <link doc="../http/ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4389 </link> register their handlers at this phase. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4390 If configured so by the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4391 <link doc="../http/ngx_http_core_module.xml" id="satisfy"/> directive, only one |
1971
5fb870087b76
Fixed typo and removed trailing spaces.
Vladimir Homutov <vl@nginx.com>
parents:
1970
diff
changeset
|
4392 of access phase handlers may allow access to the request in order to continue |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4393 processing |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4394 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4395 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4396 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4397 <literal>NGX_HTTP_POST_ACCESS_PHASE</literal> — a special phase for the |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4398 <link doc="../http/ngx_http_core_module.xml" id="satisfy">satisfy any</link> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4399 case. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4400 If some access phase handlers denied the access and none of them allowed, the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4401 request is finalized. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4402 No handlers are supported at this phase |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4403 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4404 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4405 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4406 <literal>NGX_HTTP_TRY_FILES_PHASE</literal> — a special phase, for the |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4407 <link doc="../http/ngx_http_core_module.xml" id="try_files"/> feature. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4408 No handlers are allowed at this phase |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4409 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4410 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4411 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4412 <literal>NGX_HTTP_CONTENT_PHASE</literal> — a phase, at which the response |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4413 is supposed to be generated. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4414 Multiple nginx standard modules register their handers at this phase, for |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4415 example |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4416 <link doc="../http/ngx_http_index_module.xml">ngx_http_index_module</link> or |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4417 <literal>ngx_http_static_module</literal>. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4418 All these handlers are called sequentially until one of them finally produces |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4419 the output. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4420 It's also possible to set content handlers on a per-location basis. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4421 If the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4422 <link doc="../http/ngx_http_core_module.xml">ngx_http_core_module</link>'s |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4423 location configuration has <literal>handler</literal> set, this handler is |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4424 called as the content handler and content phase handlers are ignored |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4425 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4426 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4427 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4428 <literal>NGX_HTTP_LOG_PHASE</literal> is used to perform request logging. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4429 Currently, only the |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4430 <link doc="../http/ngx_http_log_module.xml">ngx_http_log_module</link> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4431 registers its handler |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4432 at this stage for access logging. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4433 Log phase handlers are called at the very end of request processing, right |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4434 before freeing the request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4435 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4436 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4437 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4438 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4439 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4440 Following is the example of a preaccess phase handler. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4441 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4442 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4443 <programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4444 static ngx_http_module_t ngx_http_foo_module_ctx = { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4445 NULL, /* preconfiguration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4446 ngx_http_foo_init, /* postconfiguration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4447 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4448 NULL, /* create main configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4449 NULL, /* init main configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4450 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4451 NULL, /* create server configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4452 NULL, /* merge server configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4453 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4454 NULL, /* create location configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4455 NULL /* merge location configuration */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4456 }; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4457 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4458 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4459 static ngx_int_t |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4460 ngx_http_foo_handler(ngx_http_request_t *r) |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4461 { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4462 ngx_str_t *ua; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4463 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4464 ua = r->headers_in->user_agent; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4465 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4466 if (ua == NULL) { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4467 return NGX_DECLINED; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4468 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4469 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4470 /* reject requests with "User-Agent: foo" */ |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4471 if (ua->value.len == 3 && ngx_strncmp(ua->value.data, "foo", 3) == 0) { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4472 return NGX_HTTP_FORBIDDEN; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4473 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4474 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4475 return NGX_DECLINED; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4476 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4477 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4478 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4479 static ngx_int_t |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4480 ngx_http_foo_init(ngx_conf_t *cf) |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4481 { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4482 ngx_http_handler_pt *h; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4483 ngx_http_core_main_conf_t *cmcf; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4484 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4485 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4486 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4487 h = ngx_array_push(&cmcf->phases[NGX_HTTP_PREACCESS_PHASE].handlers); |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4488 if (h == NULL) { |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4489 return NGX_ERROR; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4490 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4491 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4492 *h = ngx_http_foo_handler; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4493 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4494 return NGX_OK; |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4495 } |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4496 </programlisting> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4497 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4498 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4499 Phase handlers are expected to return specific codes: |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4500 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4501 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4502 <list type="bullet"> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4503 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4504 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4505 <literal>NGX_OK</literal> — proceed to the next phase |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4506 </listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4507 |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4508 <listitem> |
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4509 <literal>NGX_DECLINED</literal> — proceed to the next handler of the current |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4510 phase. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4511 If current handler is the last in current phase, move to the next phase |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4512 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4513 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4514 <listitem> |
1935
be7490a66d1b
Style: use long dash with non-breaking space where appropriate.
Vladimir Homutov <vl@nginx.com>
parents:
1932
diff
changeset
|
4515 <literal>NGX_AGAIN, NGX_DONE</literal> — suspend phase handling until some |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4516 future event. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4517 This can be for example asynchronous I/O operation or just a delay. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4518 It is supposed, that phase handling will be resumed later by calling |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4519 <literal>ngx_http_core_run_phases()</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4520 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4521 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4522 <listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4523 Any other value returned by the phase handler is treated as a request |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4524 finalization code, in particular, HTTP response code. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4525 The request is finalized with the code provided |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4526 </listitem> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4527 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4528 </list> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4529 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4530 <para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4531 Some phases treat return codes in a slightly different way. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4532 At content phase, any return code other that <literal>NGX_DECLINED</literal> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4533 is considered a finalization code. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4534 As for the location content handlers, any return from them is considered a |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4535 finalization code. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4536 At access phase, in |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4537 <link doc="../http/ngx_http_core_module.xml" id="satisfy">satisfy any</link> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4538 mode, returning a code other |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4539 than <literal>NGX_OK, NGX_DECLINED, NGX_AGAIN, NGX_DONE</literal> is considered |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4540 a denial. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4541 If none of future access handlers allow access or deny with a new |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4542 code, the denial code will become the finalization code. |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4543 </para> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4544 |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4545 </section> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
4546 |
1939
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
4547 |
1959
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4548 <section name="Variables" id="http_variables"> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4549 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4550 <section name="Accessing existing variables" id="http_existing_variables"> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4551 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4552 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4553 Variables may be referenced using index (this is the most common method) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4554 or names (see below in the section about creating variables). |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4555 Index is created at configuration stage, when a variable is added |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4556 to configuration. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4557 The variable index can be obtained using |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4558 <literal>ngx_http_get_variable_index()</literal>: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4559 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4560 ngx_str_t name; /* ngx_string("foo") */ |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4561 ngx_int_t index; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4562 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4563 index = ngx_http_get_variable_index(cf, &name); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4564 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4565 Here, the <literal>cf</literal> is a pointer to nginx configuration and the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4566 <literal>name</literal> points to a string with the variable name. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4567 The function returns <literal>NGX_ERROR</literal> on error or valid index |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4568 otherwise, which is typically stored somewhere in a module configuration for |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4569 future use. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4570 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4571 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4572 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4573 All HTTP variables are evaluated in the context of HTTP request and results |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4574 are specific to and cached in HTTP request. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4575 All functions that evaluate variables return |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4576 <literal>ngx_http_variable_value_t</literal> type, representing |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4577 the variable value: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4578 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4579 typedef ngx_variable_value_t ngx_http_variable_value_t; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4580 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4581 typedef struct { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4582 unsigned len:28; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4583 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4584 unsigned valid:1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4585 unsigned no_cacheable:1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4586 unsigned not_found:1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4587 unsigned escape:1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4588 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4589 u_char *data; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4590 } ngx_variable_value_t; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4591 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4592 where: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4593 <list type="bullet"> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4594 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4595 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4596 <literal>len</literal> — length of a value |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4597 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4598 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4599 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4600 <literal>data</literal> — value itself |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4601 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4602 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4603 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4604 <literal>valid</literal> — value is valid |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4605 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4606 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4607 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4608 <literal>not_found</literal> — variable was not found and thus |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4609 the <literal>data</literal> and <literal>len</literal> fields are irrelevant; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4610 this may happen, for example, with such variables as <var>$arg_foo</var> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4611 when a corresponding argument was not passed in a request |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4612 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4613 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4614 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4615 <literal>no_cacheable</literal> — do not cache result |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4616 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4617 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4618 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4619 <literal>escape</literal> — used internally by the logging module to mark |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4620 values that require escaping on output |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4621 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4622 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4623 </list> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4624 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4625 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4626 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4627 The <literal>ngx_http_get_flushed_variable()</literal> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4628 and <literal>ngx_http_get_indexed_variable()</literal> functions |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4629 are used to obtain the variable value. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4630 They have the same interface - accepting a HTTP request <literal>r</literal> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4631 as a context for evaluating the variable and an <literal>index</literal>, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4632 identifying it. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4633 Example of typical usage: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4634 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4635 ngx_http_variable_value_t *v; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4636 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4637 v = ngx_http_get_flushed_variable(r, index); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4638 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4639 if (v == NULL || v->not_found) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4640 /* we failed to get value or there is no such variable, handle it */ |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4641 return NGX_ERROR; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4642 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4643 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4644 /* some meaningful value is found */ |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4645 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4646 The difference between functions is that the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4647 <literal>ngx_http_get_indexed_variable()</literal> returns cached value |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4648 and <literal>ngx_http_get_flushed_variable()</literal> flushes cache for |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4649 non-cacheable variables. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4650 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4651 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4652 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4653 There are cases when it is required to deal with variables which names are |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4654 not known at configuration time and thus they cannot be accessed using indexes, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4655 for example in modules like SSI or Perl. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4656 The <literal>ngx_http_get_variable(r, name, key)</literal> function may be |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4657 used in such cases. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4658 It searches for the <literal>variable</literal> with a given |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4659 <literal>name</literal> and its hash <literal>key</literal>. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4660 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4661 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4662 </section> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4663 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4664 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4665 <section name="Creating variables" id="http_creating_variables"> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4666 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4667 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4668 To create a variable <literal>ngx_http_add_variable()</literal> function |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4669 is used. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4670 It takes configuration (where variable is registered), variable name and |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4671 flags that control its behaviour: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4672 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4673 <list type="bullet"> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4674 <listitem><literal>NGX_HTTP_VAR_CHANGEABLE</literal> — allows redefining |
1959
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4675 the variable; If another module will define a variable with such name, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4676 no conflict will happen. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4677 For example, this allows user to override variables using the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4678 <link doc="../http/ngx_http_rewrite_module.xml" id="set"/> directive. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4679 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4680 |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4681 <listitem><literal>NGX_HTTP_VAR_NOCACHEABLE</literal> — disables caching, |
1959
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4682 is useful for such variables as <literal>$time_local</literal> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4683 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4684 |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4685 <listitem><literal>NGX_HTTP_VAR_NOHASH</literal> — indicates that |
1959
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4686 this variable is only accessible by index, not by name. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4687 This is a small optimization which may be used when it is known that the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4688 variable is not needed in modules like SSI or Perl. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4689 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4690 |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
4691 <listitem><literal>NGX_HTTP_VAR_PREFIX</literal> — the name of this |
1959
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4692 variable is a prefix. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4693 A handler must implement additional logic to obtain value of specific |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4694 variable. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4695 For example, all “<literal>arg_</literal>” variables are processed by the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4696 same handler which performs lookup in request arguments and returns value |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4697 of specific argument. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4698 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4699 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4700 </list> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4701 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4702 The function returns NULL in case of error or a pointer to |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4703 <literal>ngx_http_variable_t</literal>: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4704 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4705 struct ngx_http_variable_s { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4706 ngx_str_t name; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4707 ngx_http_set_variable_pt set_handler; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4708 ngx_http_get_variable_pt get_handler; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4709 uintptr_t data; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4710 ngx_uint_t flags; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4711 ngx_uint_t index; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4712 }; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4713 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4714 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4715 The <literal>get</literal> and <literal>set</literal> handlers |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4716 are called to obtain or set the variable value, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4717 <literal>data</literal> will be passed to variable handlers, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4718 <literal>index</literal> will hold assigned variable index, used to reference |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4719 the variable. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4720 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4721 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4722 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4723 Usually, a null-terminated static array of such structures is created |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4724 by a module and processed at the preconfiguration stage to add variables |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4725 into configuration: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4726 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4727 static ngx_http_variable_t ngx_http_foo_vars[] = { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4728 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4729 { ngx_string("foo_v1"), NULL, ngx_http_foo_v1_variable, NULL, 0, 0 }, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4730 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4731 { ngx_null_string, NULL, NULL, 0, 0, 0 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4732 }; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4733 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4734 static ngx_int_t |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4735 ngx_http_foo_add_variables(ngx_conf_t *cf) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4736 { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4737 ngx_http_variable_t *var, *v; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4738 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4739 for (v = ngx_http_foo_vars; v->name.len; v++) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4740 var = ngx_http_add_variable(cf, &v->name, v->flags); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4741 if (var == NULL) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4742 return NGX_ERROR; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4743 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4744 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4745 var->get_handler = v->get_handler; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4746 var->data = v->data; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4747 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4748 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4749 return NGX_OK; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4750 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4751 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4752 This function is used to initialize the <literal>preconfiguration</literal> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4753 field of the HTTP module context and is called before parsing HTTP configuration, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4754 so it could refer to these variables. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4755 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4756 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4757 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4758 The <literal>get</literal> handler is responsible for evaluating the variable |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4759 in a context of specific request, for example: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4760 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4761 static ngx_int_t |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4762 ngx_http_variable_connection(ngx_http_request_t *r, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4763 ngx_http_variable_value_t *v, uintptr_t data) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4764 { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4765 u_char *p; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4766 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4767 p = ngx_pnalloc(r->pool, NGX_ATOMIC_T_LEN); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4768 if (p == NULL) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4769 return NGX_ERROR; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4770 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4771 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4772 v->len = ngx_sprintf(p, "%uA", r->connection->number) - p; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4773 v->valid = 1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4774 v->no_cacheable = 0; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4775 v->not_found = 0; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4776 v->data = p; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4777 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4778 return NGX_OK; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4779 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4780 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4781 It returns <literal>NGX_ERROR</literal> in case of internal error |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4782 (for example, failed memory allocation) or <literal>NGX_OK</literal> otherwise. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4783 The status of variable evaluation may be understood by inspecting flags |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4784 of the <literal>ngx_http_variable_value_t</literal> (see description above). |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4785 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4786 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4787 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4788 The <literal>set</literal> handler allows setting the property |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4789 referred by the variable. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4790 For example, the <literal>$limit_rate</literal> variable set handler |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4791 modifies the request's <literal>limit_rate</literal> field: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4792 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4793 ... |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4794 { ngx_string("limit_rate"), ngx_http_variable_request_set_size, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4795 ngx_http_variable_request_get_size, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4796 offsetof(ngx_http_request_t, limit_rate), |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4797 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 }, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4798 ... |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4799 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4800 static void |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4801 ngx_http_variable_request_set_size(ngx_http_request_t *r, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4802 ngx_http_variable_value_t *v, uintptr_t data) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4803 { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4804 ssize_t s, *sp; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4805 ngx_str_t val; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4806 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4807 val.len = v->len; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4808 val.data = v->data; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4809 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4810 s = ngx_parse_size(&val); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4811 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4812 if (s == NGX_ERROR) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4813 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4814 "invalid size \"%V\"", &val); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4815 return; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4816 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4817 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4818 sp = (ssize_t *) ((char *) r + data); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4819 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4820 *sp = s; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4821 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4822 return; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4823 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4824 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4825 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4826 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4827 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4828 </section> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4829 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4830 </section> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4831 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4832 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4833 <section name="Complex values" id="http_complex_values"> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4834 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4835 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4836 A complex value, despite its name, provides an easy way to evaluate |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4837 expressions that may contain text, variables, and their combination. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4838 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4839 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4840 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4841 The complex value description in |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4842 <literal>ngx_http_compile_complex_value</literal> is compiled at the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4843 configuration stage into <literal>ngx_http_complex_value_t</literal> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4844 which is used at runtime to obtain evaluated expression results. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4845 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4846 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4847 ngx_str_t *value; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4848 ngx_http_complex_value_t cv; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4849 ngx_http_compile_complex_value_t ccv; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4850 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4851 value = cf->args->elts; /* directive arguments */ |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4852 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4853 ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t)); |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4854 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4855 ccv.cf = cf; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4856 ccv.value = &value[1]; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4857 ccv.complex_value = &cv; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4858 ccv.zero = 1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4859 ccv.conf_prefix = 1; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4860 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4861 if (ngx_http_compile_complex_value(&ccv) != NGX_OK) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4862 return NGX_CONF_ERROR; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4863 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4864 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4865 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4866 Here, <literal>ccv</literal> holds all parameters that are required to |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4867 initialize the complex value <literal>cv</literal>: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4868 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4869 <list type="bullet"> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4870 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4871 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4872 <literal>cf</literal> — configuration pointer |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4873 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4874 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4875 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4876 <literal>value</literal> — string for parsing (input) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4877 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4878 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4879 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4880 <literal>complex_value</literal> — compiled value (output) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4881 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4882 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4883 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4884 <literal>zero</literal> — flag that enables zero-terminating value |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4885 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4886 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4887 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4888 <literal>conf_prefix</literal> — prefixes result with configuration prefix |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4889 (the directory where nginx is currently looking for configuration) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4890 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4891 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4892 <listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4893 <literal>root_prefix</literal> — prefixes result with root prefix |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4894 (this is the normal nginx installation prefix) |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4895 </listitem> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4896 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4897 </list> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4898 The <literal>zero</literal> flag is usable when results are to be passed to |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4899 libraries that require zero-terminated strings, and prefixes are handy when |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4900 dealing with filenames. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4901 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4902 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4903 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4904 Upon successful compilation, <literal>cv.lengths</literal> may |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4905 be inspected to get information about the presence of variables |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4906 in the expression. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4907 The NULL value means that the expression contained static text only, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4908 and there is no need in storing it as a complex value, |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4909 so a simple string can be used. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4910 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4911 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4912 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4913 The <literal>ngx_http_set_complex_value_slot()</literal> is a convenient |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4914 function used to initialize complex value completely right in the directive |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4915 declaration. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4916 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4917 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4918 <para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4919 At runtime, a complex value may be calculated using the |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4920 <literal>ngx_http_complex_value()</literal> function: |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4921 <programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4922 ngx_str_t res; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4923 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4924 if (ngx_http_complex_value(r, &cv, &res) != NGX_OK) { |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4925 return NGX_ERROR; |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4926 } |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4927 </programlisting> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4928 Given the request <literal>r</literal> and previously compiled |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4929 value <literal>cv</literal> the function will evaluate |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4930 expression and put result into <literal>res</literal>. |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4931 </para> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4932 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4933 </section> |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4934 |
d0aebb2337ec
Added the "Variables" section to the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1958
diff
changeset
|
4935 |
1967
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4936 <section name="Request redirection" id="http_request_redirection"> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4937 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4938 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4939 An HTTP request is always connected to a location via the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4940 <literal>loc_conf</literal> field of the <literal>ngx_http_request_t</literal> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4941 structure. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4942 This means that at any point the location configuration of any module can be |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4943 retrieved from the request by calling |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4944 <literal>ngx_http_get_module_loc_conf(r, module)</literal>. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4945 Request location may be changed several times throughout its lifetime. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4946 Initially, a default server location of the default server is assigned to a |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4947 request. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4948 Once a request switches to a different server (chosen by the HTTP |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4949 <header>Host</header> header or SSL SNI extension), the request switches to the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4950 default location of that server as well. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4951 The next change of the location takes place at the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4952 <literal>NGX_HTTP_FIND_CONFIG_PHASE</literal> request phase. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4953 At this phase a location is chosen by request URI among all non-named locations |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4954 configured for the server. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4955 The |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4956 <link doc="../http/ngx_http_rewrite_module.xml">ngx_http_rewrite_module</link> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4957 may change the request URI at the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4958 <literal>NGX_HTTP_REWRITE_PHASE</literal> request phase as a result of |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4959 <link doc="../http/ngx_http_rewrite_module.xml" id="rewrite">rewrite</link> and |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4960 return to the <literal>NGX_HTTP_FIND_CONFIG_PHASE</literal> phase for choosing a |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4961 new location based on the new URI. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4962 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4963 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4964 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4965 It is also possible to redirect a request to a new location at any point by |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4966 calling one of the functions |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4967 <literal>ngx_http_internal_redirect(r, uri, args)</literal> or |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4968 <literal>ngx_http_named_location(r, name)</literal>. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4969 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4970 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4971 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4972 The function <literal>ngx_http_internal_redirect(r, uri, args)</literal> changes |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4973 the request URI and returns the request to the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4974 <literal>NGX_HTTP_SERVER_REWRITE_PHASE</literal> phase. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4975 The request proceeds with a server default location. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4976 Later at <literal>NGX_HTTP_FIND_CONFIG_PHASE</literal> a new location is chosen |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4977 based on the new request URI. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4978 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4979 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4980 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4981 The following example performs an internal redirect with the new request |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4982 arguments. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4983 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4984 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4985 <programlisting> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4986 ngx_int_t |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4987 ngx_http_foo_redirect(ngx_http_request_t *r) |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4988 { |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4989 ngx_str_t uri, args; |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4990 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4991 ngx_str_set(&uri, "/foo"); |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4992 ngx_str_set(&args, "bar=1"); |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4993 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4994 return ngx_http_internal_redirect(r, &uri, &args); |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4995 } |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4996 </programlisting> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4997 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4998 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
4999 The function <literal>ngx_http_named_location(r, name)</literal> redirects |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5000 a request to a named location. The name of the location is passed as the |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5001 argument. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5002 The location is looked up among all named locations of the current |
1967
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5003 server, after which the requests switches to the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5004 <literal>NGX_HTTP_REWRITE_PHASE</literal> phase. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5005 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5006 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5007 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5008 The following example performs a redirect to a named location @foo. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5009 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5010 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5011 <programlisting> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5012 ngx_int_t |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5013 ngx_http_foo_named_redirect(ngx_http_request_t *r) |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5014 { |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5015 ngx_str_t name; |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5016 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5017 ngx_str_set(&name, "foo"); |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5018 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5019 return ngx_http_named_location(r, &name); |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5020 } |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5021 </programlisting> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5022 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5023 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5024 Both functions <literal>ngx_http_internal_redirect(r, uri, args)</literal> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5025 and <literal>ngx_http_named_location(r, name)</literal> may be called when |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5026 a request already has some contexts saved in its <literal>ctx</literal> field |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5027 by nginx modules. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5028 These contexts could become inconsistent with the new |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5029 location configuration. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5030 To prevent inconsistency, all request contexts are |
1967
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5031 erased by both redirect functions. |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5032 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5033 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5034 <para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5035 Redirected and rewritten requests become internal and may access the |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5036 <link doc="../http/ngx_http_core_module.xml" id="internal">internal</link> |
1993
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5037 locations. |
98b713b0a9fa
Language and style fixes in development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1983
diff
changeset
|
5038 Internal requests have the <literal>internal</literal> flag set. |
1967
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5039 </para> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5040 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5041 </section> |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5042 |
ef27e3ef0c46
The HTTP request redirection section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1960
diff
changeset
|
5043 |
1968
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5044 <section name="Subrequests" id="http_subrequests"> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5045 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5046 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5047 Subrequests are primarily used to include output of one request into another, |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5048 possibly mixed with other data. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5049 A subrequest looks like a normal request, but shares some data with its parent. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5050 Particularly, all fields related to client input are shared since a subrequest |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5051 does not receive any other input from client. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5052 The request field <literal>parent</literal> for a subrequest keeps a link to its |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5053 parent request and is NULL for the main request. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5054 The field <literal>main</literal> keeps a link to the main request in a group of |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5055 requests. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5056 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5057 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5058 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5059 A subrequest starts with <literal>NGX_HTTP_SERVER_REWRITE_PHASE</literal> phase. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5060 It passes through the same phases as a normal request and is assigned a location |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5061 based on its own URI. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5062 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5063 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5064 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5065 Subrequest output header is always ignored. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5066 Subrequest output body is placed by the |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5067 <literal>ngx_http_postpone_filter</literal> into the right position in relation |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5068 to other data produced by the parent request. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5069 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5070 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5071 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5072 Subrequests are related to the concept of active requests. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5073 A request <literal>r</literal> is considered active if |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5074 <literal>c->data == r</literal>, where <literal>c</literal> is the client |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5075 connection object. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5076 At any point, only the active request in a request group is allowed to output |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5077 its buffers to the client. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5078 A non-active request can still send its data to the filter chain, but they |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5079 will not pass beyond the <literal>ngx_http_postpone_filter</literal> and will |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5080 remain buffered by that filter until the request becomes active. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5081 Here are some rules of request activation: |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5082 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5083 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5084 <list type="bullet"> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5085 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5086 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5087 Initially, the main request is active |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5088 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5089 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5090 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5091 The first subrequest of an active request becomes active right after creation |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5092 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5093 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5094 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5095 The <literal>ngx_http_postpone_filter</literal> activates the next request |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5096 in active request's subrequest list, once all data prior to that request are |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5097 sent |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5098 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5099 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5100 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5101 When a request is finalized, its parent is activated |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5102 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5103 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5104 </list> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5105 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5106 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5107 A subrequest is created by calling the function |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5108 <literal>ngx_http_subrequest(r, uri, args, psr, ps, flags)</literal>, where |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5109 <literal>r</literal> is the parent request, <literal>uri</literal> and |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5110 <literal>args</literal> are URI and arguments of the |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5111 subrequest, <literal>psr</literal> is the output parameter, receiving the |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5112 newly created subrequest reference, <literal>ps</literal> is a callback object |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5113 for notifying the parent request that the subrequest is being finalized, |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5114 <literal>flags</literal> is subrequest creation flags bitmask. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5115 The following flags are available: |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5116 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5117 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5118 <list type="bullet"> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5119 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5120 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5121 <literal>NGX_HTTP_SUBREQUEST_IN_MEMORY</literal> - subrequest output should not |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5122 be sent to the client, but rather stored in memory. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5123 This only works for proxying subrequests. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5124 After subrequest finalization its output is available in |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5125 <literal>r->upstream->buffer</literal> buffer of type |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5126 <literal>ngx_buf_t</literal> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5127 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5128 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5129 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5130 <literal>NGX_HTTP_SUBREQUEST_WAITED</literal> - the subrequest |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5131 <literal>done</literal> flag is set even if it is finalized being non-active. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5132 This subrequest flag is used by the SSI filter |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5133 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5134 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5135 <listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5136 <literal>NGX_HTTP_SUBREQUEST_CLONE</literal> - the subrequest is created as a |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5137 clone of its parent. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5138 It is started at the same location and proceeds from the same phase as the |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5139 parent request |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5140 </listitem> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5141 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5142 </list> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5143 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5144 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5145 The following example creates a subrequest with the URI of "/foo". |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5146 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5147 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5148 <programlisting> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5149 ngx_int_t rc; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5150 ngx_str_t uri; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5151 ngx_http_request_t *sr; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5152 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5153 ... |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5154 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5155 ngx_str_set(&uri, "/foo"); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5156 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5157 rc = ngx_http_subrequest(r, &uri, NULL, &sr, NULL, 0); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5158 if (rc == NGX_ERROR) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5159 /* error */ |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5160 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5161 </programlisting> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5162 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5163 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5164 This example clones the current request and sets a finalization callback for the |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5165 subrequest. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5166 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5167 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5168 <programlisting> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5169 ngx_int_t |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5170 ngx_http_foo_clone(ngx_http_request_t *r) |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5171 { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5172 ngx_http_request_t *sr; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5173 ngx_http_post_subrequest_t *ps; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5174 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5175 ps = ngx_palloc(r->pool, sizeof(ngx_http_post_subrequest_t)); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5176 if (ps == NULL) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5177 return NGX_ERROR; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5178 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5179 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5180 ps->handler = ngx_http_foo_subrequest_done; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5181 ps->data = "foo"; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5182 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5183 return ngx_http_subrequest(r, &r->uri, &r->args, &sr, ps, |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5184 NGX_HTTP_SUBREQUEST_CLONE); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5185 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5186 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5187 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5188 ngx_int_t |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5189 ngx_http_foo_subrequest_done(ngx_http_request_t *r, void *data, ngx_int_t rc) |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5190 { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5191 char *msg = (char *) data; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5192 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5193 ngx_log_error(NGX_LOG_INFO, r->connection->log, 0, |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5194 "done subrequest r:%p msg:%s rc:%i", r, msg, rc); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5195 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5196 return rc; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5197 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5198 </programlisting> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5199 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5200 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5201 Subrequests are normally created in a body filter. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5202 In this case subrequest output can be treated as any other explicit request |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5203 output. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5204 This means that eventually the output of a subrequest is sent to the client |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5205 after all explicit buffers passed prior to subrequest creation and before any |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5206 buffers passed later. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5207 This ordering is preserved even for large hierarchies of subrequests. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5208 The following example inserts a subrequest output after all request data |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5209 buffers, but before the final buffer with the <literal>last_buf</literal> flag. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5210 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5211 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5212 <programlisting> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5213 ngx_int_t |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5214 ngx_http_foo_body_filter(ngx_http_request_t *r, ngx_chain_t *in) |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5215 { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5216 ngx_int_t rc; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5217 ngx_buf_t *b; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5218 ngx_uint_t last; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5219 ngx_chain_t *cl, out; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5220 ngx_http_request_t *sr; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5221 ngx_http_foo_filter_ctx_t *ctx; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5222 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5223 ctx = ngx_http_get_module_ctx(r, ngx_http_foo_filter_module); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5224 if (ctx == NULL) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5225 return ngx_http_next_body_filter(r, in); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5226 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5227 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5228 last = 0; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5229 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5230 for (cl = in; cl; cl = cl->next) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5231 if (cl->buf->last_buf) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5232 cl->buf->last_buf = 0; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5233 cl->buf->last_in_chain = 1; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5234 cl->buf->sync = 1; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5235 last = 1; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5236 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5237 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5238 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5239 /* Output explicit output buffers */ |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5240 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5241 rc = ngx_http_next_body_filter(r, in); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5242 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5243 if (rc == NGX_ERROR || !last) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5244 return rc; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5245 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5246 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5247 /* |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5248 * Create the subrequest. The output of the subrequest |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5249 * will automatically be sent after all preceding buffers, |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5250 * but before the last_buf buffer passed later in this function. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5251 */ |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5252 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5253 if (ngx_http_subrequest(r, ctx->uri, NULL, &sr, NULL, 0) != NGX_OK) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5254 return NGX_ERROR; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5255 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5256 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5257 ngx_http_set_ctx(r, NULL, ngx_http_foo_filter_module); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5258 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5259 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5260 /* Output the final buffer with the last_buf flag */ |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5261 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5262 b = ngx_calloc_buf(r->pool); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5263 if (b == NULL) { |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5264 return NGX_ERROR; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5265 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5266 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5267 b->last_buf = 1; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5268 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5269 out.buf = b; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5270 out.next = NULL; |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5271 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5272 return ngx_http_output_filter(r, &out); |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5273 } |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5274 </programlisting> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5275 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5276 <para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5277 A subrequest may also be created for other purposes than data output. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5278 For example, the <link doc="../http/ngx_http_auth_request_module.xml"> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5279 ngx_http_auth_request_module</link> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5280 creates a subrequest at <literal>NGX_HTTP_ACCESS_PHASE</literal> phase. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5281 To disable any output at this point, the subrequest |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5282 <literal>header_only</literal> flag is set. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5283 This prevents subrequest body from being sent to the client. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5284 Its header is ignored anyway. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5285 The result of the subrequest can be analyzed in the callback handler. |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5286 </para> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5287 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5288 </section> |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5289 |
69908bd68481
The HTTP subrequests section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1967
diff
changeset
|
5290 |
1969
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5291 <section name="Request finalization" id="http_request_finalization"> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5292 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5293 <para> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5294 An HTTP request is finalized by calling the function |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5295 <literal>ngx_http_finalize_request(r, rc)</literal>. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5296 It is usually finalized by the content handler after sending all output buffers |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5297 to the filter chain. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5298 At this point the output may not be completely sent to the client, but remain |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5299 buffered somewhere along the filter chain. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5300 If it is, the <literal>ngx_http_finalize_request(r, rc)</literal> function will |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5301 automatically install a special handler <literal>ngx_http_writer(r)</literal> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5302 to finish sending the output. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5303 A request is also finalized in case of an error or if a standard HTTP response |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5304 code needs to be returned to the client. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5305 </para> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5306 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5307 <para> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5308 The function <literal>ngx_http_finalize_request(r, rc)</literal> expects the |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5309 following <literal>rc</literal> values: |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5310 </para> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5311 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5312 <list type="bullet"> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5313 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5314 <listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5315 <literal>NGX_DONE</literal> - fast finalization. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5316 Decrement request <literal>count</literal> and destroy the request if it |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5317 reaches zero. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5318 The client connection may still be used for more requests after that |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5319 </listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5320 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5321 <listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5322 <literal>NGX_ERROR</literal>, <literal>NGX_HTTP_REQUEST_TIME_OUT</literal> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5323 (408), <literal>NGX_HTTP_CLIENT_CLOSED_REQUEST</literal> (499) - error |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5324 finalization. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5325 Terminate the request as soon as possible and close the client connection. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5326 </listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5327 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5328 <listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5329 <literal>NGX_HTTP_CREATED</literal> (201), |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5330 <literal>NGX_HTTP_NO_CONTENT</literal> (204), codes greater than or equal to |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5331 <literal>NGX_HTTP_SPECIAL_RESPONSE</literal> (300) - special response |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5332 finalization. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5333 For these values nginx either sends a default code response page to the client |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5334 or performs the internal redirect to an |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5335 <link doc="../http/ngx_http_core_module.xml" id="error_page"/> location if it's |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5336 configured for the code |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5337 </listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5338 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5339 <listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5340 Other codes are considered success finalization codes and may activate the |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5341 request writer to finish sending the response body. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5342 Once body is completely sent, request <literal>count</literal> is decremented. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5343 If it reaches zero, the request is destroyed, but the client connection may |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5344 still be used for other requests. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5345 If <literal>count</literal> is positive, there are unfinished activities |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5346 within the request, which will be finalized at a later point. |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5347 </listitem> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5348 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5349 </list> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5350 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5351 </section> |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5352 |
275c928ab386
The HTTP request finalization section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1968
diff
changeset
|
5353 |
1970
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5354 <section name="Request body" id="http_request_body"> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5355 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5356 <para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5357 For dealing with client request body, nginx provides the following functions: |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5358 <literal>ngx_http_read_client_request_body(r, post_handler)</literal> and |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5359 <literal>ngx_http_discard_request_body(r)</literal>. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5360 The first function reads the request body and makes it available via the |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5361 <literal>request_body</literal> request field. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5362 The second function instructs nginx to discard (read and ignore) the request |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5363 body. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5364 One of these functions must be called for every request. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5365 Normally, it is done in the content handler. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5366 </para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5367 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5368 <para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5369 Reading or discarding client request body from a subrequest is not allowed. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5370 It should always be done in the main request. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5371 When a subrequest is created, it inherits the parent |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5372 <literal>request_body</literal> object which can be used by the subrequest if |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5373 the main request has previously read the request body. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5374 </para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5375 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5376 <para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5377 The function |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5378 <literal>ngx_http_read_client_request_body(r, post_handler)</literal> starts |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5379 the process of reading the request body. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5380 When the body is completely read, the <literal>post_handler</literal> callback |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5381 is called to continue processing the request. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5382 If request body is missing or already read, the callback is called immediately. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5383 The function |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5384 <literal>ngx_http_read_client_request_body(r, post_handler)</literal> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5385 allocates the <literal>request_body</literal> request field of type |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5386 <literal>ngx_http_request_body_t</literal>. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5387 The field <literal>bufs</literal> of this object keeps the result as a buffer |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5388 chain. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5389 The body can be saved in memory buffers or file buffers, if |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5390 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5391 is not enough to fit the entire body in memory. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5392 </para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5393 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5394 <para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5395 The following example reads client request body and returns its size. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5396 </para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5397 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5398 <programlisting> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5399 ngx_int_t |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5400 ngx_http_foo_content_handler(ngx_http_request_t *r) |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5401 { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5402 ngx_int_t rc; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5403 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5404 rc = ngx_http_read_client_request_body(r, ngx_http_foo_init); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5405 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5406 if (rc >= NGX_HTTP_SPECIAL_RESPONSE) { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5407 /* error */ |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5408 return rc; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5409 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5410 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5411 return NGX_DONE; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5412 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5413 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5414 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5415 void |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5416 ngx_http_foo_init(ngx_http_request_t *r) |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5417 { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5418 off_t len; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5419 ngx_buf_t *b; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5420 ngx_int_t rc; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5421 ngx_chain_t *in, out; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5422 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5423 if (r->request_body == NULL) { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5424 ngx_http_finalize_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5425 return; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5426 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5427 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5428 len = 0; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5429 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5430 for (in = r->request_body->bufs; in; in = in->next) { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5431 len += ngx_buf_size(in->buf); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5432 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5433 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5434 b = ngx_create_temp_buf(r->pool, NGX_OFF_T_LEN); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5435 if (b == NULL) { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5436 ngx_http_finalize_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5437 return; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5438 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5439 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5440 b->last = ngx_sprintf(b->pos, "%O", len); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5441 b->last_buf = (r == r->main) ? 1: 0; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5442 b->last_in_chain = 1; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5443 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5444 r->headers_out.status = NGX_HTTP_OK; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5445 r->headers_out.content_length_n = b->last - b->pos; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5446 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5447 rc = ngx_http_send_header(r); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5448 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5449 if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) { |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5450 ngx_http_finalize_request(r, rc); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5451 return; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5452 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5453 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5454 out.buf = b; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5455 out.next = NULL; |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5456 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5457 rc = ngx_http_output_filter(r, &out); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5458 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5459 ngx_http_finalize_request(r, rc); |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5460 } |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5461 </programlisting> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5462 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5463 <para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5464 The following fields of the request affect the way request body is read: |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5465 </para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5466 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5467 <list type="bullet"> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5468 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5469 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5470 <literal>request_body_in_single_buf</literal> - read body to a single memory |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5471 buffer |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5472 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5473 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5474 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5475 <literal>request_body_in_file_only</literal> - always read body to a file, |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5476 even if fits the memory buffer |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5477 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5478 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5479 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5480 <literal>request_body_in_persistent_file</literal> - do not unlink the file |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5481 right after creation. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5482 Such a file can be moved to another directory |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5483 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5484 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5485 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5486 <literal>request_body_in_clean_file</literal> - unlink the file the when the |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5487 request is finalized. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5488 This can be useful when a file was supposed to be moved to another directory |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5489 but eventually was not moved for some reason |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5490 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5491 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5492 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5493 <literal>request_body_file_group_access</literal> - enable file group access. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5494 By default a file is created with 0600 access mask. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5495 When the flag is set, 0660 access mask is used |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5496 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5497 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5498 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5499 <literal>request_body_file_log_level</literal> - log file errors with this |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5500 log level |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5501 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5502 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5503 <listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5504 <literal>request_body_no_buffering</literal> - read request body without |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5505 buffering |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5506 </listitem> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5507 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5508 </list> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5509 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5510 <para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5511 When the <literal>request_body_no_buffering</literal> flag is set, the |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5512 unbuffered mode of reading the request body is enabled. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5513 In this mode, after calling |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5514 <literal>ngx_http_read_client_request_body()</literal>, the |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5515 <literal>bufs</literal> chain may keep only a part of the body. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5516 To read the next part, the |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5517 <literal>ngx_http_read_unbuffered_request_body(r)</literal> function should be |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5518 called. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5519 The return value of <literal>NGX_AGAIN</literal> and the request flag |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5520 <literal>reading_body</literal> indicate that more data is available. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5521 If <literal>bufs</literal> is NULL after calling this function, there is |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5522 nothing to read at the moment. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5523 The request callback <literal>read_event_handler</literal> will be called when |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5524 the next part of request body is available. |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5525 </para> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5526 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5527 </section> |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5528 |
a1d29eda04b6
The HTTP request body section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1969
diff
changeset
|
5529 |
1960
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5530 <section name="Response" id="http_response"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5531 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5532 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5533 An HTTP response in nginx is produced by sending the response header followed by |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5534 the optional response body. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5535 Both header and body are passed through a chain of filters and eventually get |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5536 written to the client socket. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5537 An nginx module can install its handler into the header or body filter chain |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5538 and process the output coming from the previous handler. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5539 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5540 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5541 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5542 <section name="Response header" id="http_response_header"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5543 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5544 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5545 Output header is sent by the function |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5546 <literal>ngx_http_send_header(r)</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5547 Prior to calling this function, <literal>r->headers_out</literal> should contain |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5548 all the data required to produce the HTTP response header. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5549 It's always required to set the <literal>status</literal> field of |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5550 <literal>r->headers_out</literal>. |
1971
5fb870087b76
Fixed typo and removed trailing spaces.
Vladimir Homutov <vl@nginx.com>
parents:
1970
diff
changeset
|
5551 If the response status suggests that a response body follows the header, |
1960
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5552 <literal>content_length_n</literal> can be set as well. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5553 The default value for this field is -1, which means that the body size is |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5554 unknown. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5555 In this case, chunked transfer encoding is used. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5556 To output an arbitrary header, <literal>headers</literal> list should be |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5557 appended. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5558 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5559 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5560 <programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5561 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5562 ngx_http_foo_content_handler(ngx_http_request_t *r) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5563 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5564 ngx_int_t rc; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5565 ngx_table_elt_t *h; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5566 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5567 /* send header */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5568 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5569 r->headers_out.status = NGX_HTTP_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5570 r->headers_out.content_length_n = 3; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5571 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5572 /* X-Foo: foo */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5573 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5574 h = ngx_list_push(&r->headers_out.headers); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5575 if (h == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5576 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5577 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5578 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5579 h->hash = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5580 ngx_str_set(&h->key, "X-Foo"); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5581 ngx_str_set(&h->value, "foo"); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5582 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5583 rc = ngx_http_send_header(r); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5584 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5585 if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5586 return rc; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5587 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5588 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5589 /* send body */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5590 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5591 ... |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5592 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5593 </programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5594 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5595 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5596 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5597 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5598 <section name="Header filters" id="http_header_filters"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5599 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5600 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5601 The <literal>ngx_http_send_header(r)</literal> function invokes the header |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5602 filter chain by calling the top header filter handler |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5603 <literal>ngx_http_top_header_filter</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5604 It's assumed that every header handler calls the next handler in chain until |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5605 the final handler <literal>ngx_http_header_filter(r)</literal> is called. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5606 The final header handler constructs the HTTP response based on |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5607 <literal>r->headers_out</literal> and passes it to the |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5608 <literal>ngx_http_writer_filter</literal> for output. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5609 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5610 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5611 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5612 To add a handler to the header filter chain, one should store its address in |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5613 <literal>ngx_http_top_header_filter</literal> global variable at configuration |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5614 time. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5615 The previous handler address is normally stored in a module's static variable |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5616 and is called by the newly added handler before exiting. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5617 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5618 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5619 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5620 The following is an example header filter module, adding the HTTP header |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5621 "X-Foo: foo" to every output with the status 200. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5622 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5623 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5624 <programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5625 #include <ngx_config.h> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5626 #include <ngx_core.h> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5627 #include <ngx_http.h> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5628 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5629 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5630 static ngx_int_t ngx_http_foo_header_filter(ngx_http_request_t *r); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5631 static ngx_int_t ngx_http_foo_header_filter_init(ngx_conf_t *cf); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5632 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5633 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5634 static ngx_http_module_t ngx_http_foo_header_filter_module_ctx = { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5635 NULL, /* preconfiguration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5636 ngx_http_foo_header_filter_init, /* postconfiguration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5637 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5638 NULL, /* create main configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5639 NULL, /* init main configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5640 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5641 NULL, /* create server configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5642 NULL, /* merge server configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5643 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5644 NULL, /* create location configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5645 NULL /* merge location configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5646 }; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5647 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5648 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5649 ngx_module_t ngx_http_foo_header_filter_module = { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5650 NGX_MODULE_V1, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5651 &ngx_http_foo_header_filter_module_ctx, /* module context */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5652 NULL, /* module directives */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5653 NGX_HTTP_MODULE, /* module type */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5654 NULL, /* init master */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5655 NULL, /* init module */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5656 NULL, /* init process */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5657 NULL, /* init thread */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5658 NULL, /* exit thread */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5659 NULL, /* exit process */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5660 NULL, /* exit master */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5661 NGX_MODULE_V1_PADDING |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5662 }; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5663 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5664 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5665 static ngx_http_output_header_filter_pt ngx_http_next_header_filter; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5666 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5667 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5668 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5669 ngx_http_foo_header_filter(ngx_http_request_t *r) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5670 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5671 ngx_table_elt_t *h; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5672 |
1971
5fb870087b76
Fixed typo and removed trailing spaces.
Vladimir Homutov <vl@nginx.com>
parents:
1970
diff
changeset
|
5673 /* |
1960
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5674 * The filter handler adds "X-Foo: foo" header |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5675 * to every HTTP 200 response |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5676 */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5677 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5678 if (r->headers_out.status != NGX_HTTP_OK) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5679 return ngx_http_next_header_filter(r); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5680 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5681 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5682 h = ngx_list_push(&r->headers_out.headers); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5683 if (h == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5684 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5685 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5686 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5687 h->hash = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5688 ngx_str_set(&h->key, "X-Foo"); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5689 ngx_str_set(&h->value, "foo"); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5690 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5691 return ngx_http_next_header_filter(r); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5692 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5693 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5694 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5695 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5696 ngx_http_foo_header_filter_init(ngx_conf_t *cf) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5697 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5698 ngx_http_next_header_filter = ngx_http_top_header_filter; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5699 ngx_http_top_header_filter = ngx_http_foo_header_filter; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5700 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5701 return NGX_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5702 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5703 </programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5704 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5705 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5706 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5707 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5708 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5709 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5710 <section name="Response body" id="http_response_body"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5711 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5712 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5713 Response body is sent by calling the function |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5714 <literal>ngx_http_output_filter(r, cl)</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5715 The function can be called multiple times. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5716 Each time it sends a part of the response body passed as a buffer chain. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5717 The last body buffer should have the <literal>last_buf</literal> flag set. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5718 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5719 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5720 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5721 The following example produces a complete HTTP output with "foo" as its body. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5722 In order for the example to work not only as a main request but as a subrequest |
1980 | 5723 as well, the <literal>last_in_chain</literal> flag is set in the last buffer |
1960
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5724 of the output. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5725 The <literal>last_buf</literal> flag is set only for the main request since |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5726 a subrequest's last buffers does not end the entire output. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5727 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5728 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5729 <programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5730 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5731 ngx_http_bar_content_handler(ngx_http_request_t *r) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5732 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5733 ngx_int_t rc; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5734 ngx_buf_t *b; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5735 ngx_chain_t out; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5736 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5737 /* send header */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5738 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5739 r->headers_out.status = NGX_HTTP_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5740 r->headers_out.content_length_n = 3; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5741 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5742 rc = ngx_http_send_header(r); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5743 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5744 if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5745 return rc; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5746 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5747 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5748 /* send body */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5749 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5750 b = ngx_calloc_buf(r->pool); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5751 if (b == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5752 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5753 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5754 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5755 b->last_buf = (r == r->main) ? 1: 0; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5756 b->last_in_chain = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5757 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5758 b->memory = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5759 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5760 b->pos = (u_char *) "foo"; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5761 b->last = b->pos + 3; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5762 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5763 out.buf = b; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5764 out.next = NULL; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5765 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5766 return ngx_http_output_filter(r, &out); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5767 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5768 </programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5769 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5770 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5771 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5772 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5773 <section name="Body filters" id="http_body_filters"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5774 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5775 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5776 The function <literal>ngx_http_output_filter(r, cl)</literal> invokes the |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5777 body filter chain by calling the top body filter handler |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5778 <literal>ngx_http_top_body_filter</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5779 It's assumed that every body handler calls the next handler in chain until |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5780 the final handler <literal>ngx_http_write_filter(r, cl)</literal> is called. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5781 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5782 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5783 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5784 A body filter handler receives a chain of buffers. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5785 The handler is supposed to process the buffers and pass a possibly new chain to |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5786 the next handler. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5787 It's worth noting that the chain links <literal>ngx_chain_t</literal> of the |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5788 incoming chain belong to the caller. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5789 They should never be reused or changed. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5790 Right after the handler completes, the caller can use its output chain links |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5791 to keep track of the buffers it has sent. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5792 To save the buffer chain or to substitute some buffers before sending further, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5793 a handler should allocate its own chain links. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5794 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5795 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5796 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5797 Following is the example of a simple body filter counting the number of |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5798 body bytes. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5799 The result is available as the <literal>$counter</literal> variable which can be |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5800 used in the access log. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5801 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5802 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5803 <programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5804 #include <ngx_config.h> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5805 #include <ngx_core.h> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5806 #include <ngx_http.h> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5807 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5808 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5809 typedef struct { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5810 off_t count; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5811 } ngx_http_counter_filter_ctx_t; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5812 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5813 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5814 static ngx_int_t ngx_http_counter_body_filter(ngx_http_request_t *r, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5815 ngx_chain_t *in); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5816 static ngx_int_t ngx_http_counter_variable(ngx_http_request_t *r, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5817 ngx_http_variable_value_t *v, uintptr_t data); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5818 static ngx_int_t ngx_http_counter_add_variables(ngx_conf_t *cf); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5819 static ngx_int_t ngx_http_counter_filter_init(ngx_conf_t *cf); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5820 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5821 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5822 static ngx_http_module_t ngx_http_counter_filter_module_ctx = { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5823 ngx_http_counter_add_variables, /* preconfiguration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5824 ngx_http_counter_filter_init, /* postconfiguration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5825 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5826 NULL, /* create main configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5827 NULL, /* init main configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5828 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5829 NULL, /* create server configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5830 NULL, /* merge server configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5831 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5832 NULL, /* create location configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5833 NULL /* merge location configuration */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5834 }; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5835 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5836 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5837 ngx_module_t ngx_http_counter_filter_module = { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5838 NGX_MODULE_V1, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5839 &ngx_http_counter_filter_module_ctx, /* module context */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5840 NULL, /* module directives */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5841 NGX_HTTP_MODULE, /* module type */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5842 NULL, /* init master */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5843 NULL, /* init module */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5844 NULL, /* init process */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5845 NULL, /* init thread */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5846 NULL, /* exit thread */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5847 NULL, /* exit process */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5848 NULL, /* exit master */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5849 NGX_MODULE_V1_PADDING |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5850 }; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5851 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5852 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5853 static ngx_http_output_body_filter_pt ngx_http_next_body_filter; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5854 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5855 static ngx_str_t ngx_http_counter_name = ngx_string("counter"); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5856 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5857 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5858 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5859 ngx_http_counter_body_filter(ngx_http_request_t *r, ngx_chain_t *in) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5860 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5861 ngx_chain_t *cl; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5862 ngx_http_counter_filter_ctx_t *ctx; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5863 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5864 ctx = ngx_http_get_module_ctx(r, ngx_http_counter_filter_module); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5865 if (ctx == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5866 ctx = ngx_pcalloc(r->pool, sizeof(ngx_http_counter_filter_ctx_t)); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5867 if (ctx == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5868 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5869 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5870 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5871 ngx_http_set_ctx(r, ctx, ngx_http_counter_filter_module); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5872 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5873 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5874 for (cl = in; cl; cl = cl->next) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5875 ctx->count += ngx_buf_size(cl->buf); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5876 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5877 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5878 return ngx_http_next_body_filter(r, in); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5879 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5880 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5881 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5882 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5883 ngx_http_counter_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5884 uintptr_t data) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5885 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5886 u_char *p; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5887 ngx_http_counter_filter_ctx_t *ctx; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5888 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5889 ctx = ngx_http_get_module_ctx(r, ngx_http_counter_filter_module); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5890 if (ctx == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5891 v->not_found = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5892 return NGX_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5893 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5894 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5895 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5896 if (p == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5897 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5898 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5899 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5900 v->data = p; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5901 v->len = ngx_sprintf(p, "%O", ctx->count) - p; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5902 v->valid = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5903 v->no_cacheable = 0; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5904 v->not_found = 0; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5905 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5906 return NGX_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5907 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5908 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5909 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5910 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5911 ngx_http_counter_add_variables(ngx_conf_t *cf) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5912 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5913 ngx_http_variable_t *var; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5914 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5915 var = ngx_http_add_variable(cf, &ngx_http_counter_name, 0); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5916 if (var == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5917 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5918 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5919 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5920 var->get_handler = ngx_http_counter_variable; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5921 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5922 return NGX_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5923 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5924 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5925 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5926 static ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5927 ngx_http_counter_filter_init(ngx_conf_t *cf) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5928 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5929 ngx_http_next_body_filter = ngx_http_top_body_filter; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5930 ngx_http_top_body_filter = ngx_http_counter_body_filter; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5931 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5932 return NGX_OK; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5933 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5934 </programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5935 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5936 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5937 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5938 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5939 <section name="Building filter modules" id="http_building_filter_modules"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5940 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5941 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5942 When writing a body or header filter, a special care should be taken of the |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5943 filters order. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5944 There's a number of header and body filters registered by nginx standard |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5945 modules. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5946 It's important to register a filter module in the right place in respect to |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5947 other filters. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5948 Normally, filters are registered by modules in their postconfiguration handlers. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5949 The order in which filters are called is obviously the reverse of when they are |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5950 registered. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5951 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5952 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5953 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5954 A special slot <literal>HTTP_AUX_FILTER_MODULES</literal> for third-party filter |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5955 modules is provided by nginx. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5956 To register a filter module in this slot, the <literal>ngx_module_type</literal> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5957 variable should be set to the value of <literal>HTTP_AUX_FILTER</literal> in |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5958 module's configuration. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5959 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5960 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5961 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5962 The following example shows a filter module config file assuming it only has |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5963 one source file <literal>ngx_http_foo_filter_module.c</literal> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5964 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5965 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5966 <programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5967 ngx_module_type=HTTP_AUX_FILTER |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5968 ngx_module_name=ngx_http_foo_filter_module |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5969 ngx_module_srcs="$ngx_addon_dir/ngx_http_foo_filter_module.c" |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5970 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5971 . auto/module |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5972 </programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5973 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5974 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5975 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5976 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5977 <section name="Buffer reuse" id="http_body_buffers_reuse"> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5978 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5979 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5980 When issuing or altering a stream of buffers, it's often desirable to reuse the |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5981 allocated buffers. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5982 A standard approach widely adopted in nginx code is to keep two buffer chains |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5983 for this purpose: <literal>free</literal> and <literal>busy</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5984 The <literal>free</literal> chain keeps all free buffers. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5985 These buffers can be reused. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5986 The <literal>busy</literal> chain keeps all buffers sent by the current |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5987 module which are still in use by some other filter handler. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5988 A buffer is considered in use if its size is greater than zero. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5989 Normally, when a buffer is consumed by a filter, its <literal>pos</literal> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5990 (or <literal>file_pos</literal> for a file buffer) is moved towards |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5991 <literal>last</literal> (<literal>file_last</literal> for a file buffer). |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5992 Once a buffer is completely consumed, it's ready to be reused. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5993 To update the <literal>free</literal> chain with newly freed buffers, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5994 it's enough to iterate over the <literal>busy</literal> chain and move the zero |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5995 size buffers at the head of it to <literal>free</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5996 This operation is so common that there is a special function |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5997 <literal>ngx_chain_update_chains(free, busy, out, tag)</literal> which does |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5998 this. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
5999 The function appends the output chain <literal>out</literal> to |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6000 <literal>busy</literal> and moves free buffers from the top of |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6001 <literal>busy</literal> to <literal>free</literal>. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6002 Only the buffers with the given <literal>tag</literal> are reused. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6003 This lets a module reuse only the buffers allocated by itself. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6004 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6005 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6006 <para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6007 The following example is a body filter inserting the “foo” string before each |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6008 incoming buffer. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6009 The new buffers allocated by the module are reused if possible. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6010 Note that for this example to work properly, it's also required to set up a |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6011 header filter and reset <literal>content_length_n</literal> to -1, which is |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6012 beyond the scope of this section. |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6013 </para> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6014 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6015 <programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6016 typedef struct { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6017 ngx_chain_t *free; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6018 ngx_chain_t *busy; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6019 } ngx_http_foo_filter_ctx_t; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6020 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6021 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6022 ngx_int_t |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6023 ngx_http_foo_body_filter(ngx_http_request_t *r, ngx_chain_t *in) |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6024 { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6025 ngx_int_t rc; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6026 ngx_buf_t *b; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6027 ngx_chain_t *cl, *tl, *out, **ll; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6028 ngx_http_foo_filter_ctx_t *ctx; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6029 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6030 ctx = ngx_http_get_module_ctx(r, ngx_http_foo_filter_module); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6031 if (ctx == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6032 ctx = ngx_pcalloc(r->pool, sizeof(ngx_http_foo_filter_ctx_t)); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6033 if (ctx == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6034 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6035 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6036 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6037 ngx_http_set_ctx(r, ctx, ngx_http_foo_filter_module); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6038 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6039 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6040 /* create a new chain "out" from "in" with all the changes */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6041 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6042 ll = &out; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6043 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6044 for (cl = in; cl; cl = cl->next) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6045 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6046 /* append "foo" in a reused buffer if possible */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6047 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6048 tl = ngx_chain_get_free_buf(r->pool, &ctx->free); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6049 if (tl == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6050 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6051 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6052 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6053 b = tl->buf; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6054 b->tag = (ngx_buf_tag_t) &ngx_http_foo_filter_module; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6055 b->memory = 1; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6056 b->pos = (u_char *) "foo"; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6057 b->last = b->pos + 3; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6058 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6059 *ll = tl; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6060 ll = &tl->next; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6061 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6062 /* append the next incoming buffer */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6063 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6064 tl = ngx_alloc_chain_link(r->pool); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6065 if (tl == NULL) { |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6066 return NGX_ERROR; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6067 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6068 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6069 tl->buf = cl->buf; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6070 *ll = tl; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6071 ll = &tl->next; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6072 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6073 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6074 *ll = NULL; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6075 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6076 /* send the new chain */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6077 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6078 rc = ngx_http_next_body_filter(r, out); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6079 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6080 /* update "busy" and "free" chains for reuse */ |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6081 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6082 ngx_chain_update_chains(r->pool, &ctx->free, &ctx->busy, &out, |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6083 (ngx_buf_tag_t) &ngx_http_foo_filter_module); |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6084 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6085 return rc; |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6086 } |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6087 </programlisting> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6088 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6089 </section> |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6090 |
9550ea66abdd
HTTP response section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1959
diff
changeset
|
6091 |
1939
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6092 <section name="Load balancing" id="http_load_balancing"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6093 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6094 <para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6095 The |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6096 <link doc="../http/ngx_http_upstream_module.xml">ngx_http_upstream_module</link> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6097 provides basic functionality to pass requests to remote servers. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6098 This functionality is used by modules that implement specific protocols, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6099 such as HTTP or FastCGI. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6100 The module also provides an interface for creating custom |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6101 load balancing modules and implements a default round-robin balancing method. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6102 </para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6103 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6104 <para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6105 Examples of modules that implement alternative load balancing methods are |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6106 <link doc="../http/ngx_http_upstream_module.xml" id="least_conn"/> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6107 and <link doc="../http/ngx_http_upstream_module.xml" id="hash"/>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6108 Note that these modules are actually implemented as extensions of the upstream |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6109 module and share a lot of code, such as representation of a server group. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6110 The <link doc="../http/ngx_http_upstream_module.xml" id="keepalive"/> module |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6111 is an example of an independent module, extending upstream functionality. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6112 </para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6113 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6114 <para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6115 The |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6116 <link doc="../http/ngx_http_upstream_module.xml">ngx_http_upstream_module</link> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6117 may be configured explicitly by placing the corresponding |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6118 <link doc="../http/ngx_http_upstream_module.xml" id="upstream"/> block into |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6119 the configuration file, or implicitly by using directives |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6120 that accept a URL evaluated at some point to the list of servers, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6121 for example, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6122 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_pass"/>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6123 Only explicit configurations may use an alternative load balancing method. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6124 The upstream module configuration has its own directive context |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6125 <literal>NGX_HTTP_UPS_CONF</literal>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6126 The structure is defined as follows: |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6127 <programlisting> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6128 struct ngx_http_upstream_srv_conf_s { |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6129 ngx_http_upstream_peer_t peer; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6130 void **srv_conf; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6131 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6132 ngx_array_t *servers; /* ngx_http_upstream_server_t */ |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6133 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6134 ngx_uint_t flags; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6135 ngx_str_t host; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6136 u_char *file_name; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6137 ngx_uint_t line; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6138 in_port_t port; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6139 ngx_uint_t no_port; /* unsigned no_port:1 */ |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6140 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6141 #if (NGX_HTTP_UPSTREAM_ZONE) |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6142 ngx_shm_zone_t *shm_zone; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6143 #endif |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6144 }; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6145 </programlisting> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6146 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6147 <list type="bullet"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6148 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6149 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6150 <literal>srv_conf</literal> — configuration context of upstream modules |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6151 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6152 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6153 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6154 <literal>servers</literal> — array of |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6155 <literal>ngx_http_upstream_server_t</literal>, the result of parsing a set of |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6156 <link doc="../http/ngx_http_upstream_module.xml" id="server"/> directives |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6157 in the <literal>upstream</literal> block |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6158 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6159 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6160 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6161 <literal>flags</literal> — flags that mostly mark which features |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6162 (configured as parameters of |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6163 the <link doc="../http/ngx_http_upstream_module.xml" id="server"/> directive) |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6164 are supported by the particular load balancing method. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6165 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6166 <list type="bullet"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6167 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6168 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6169 <literal>NGX_HTTP_UPSTREAM_CREATE</literal> — used to distinguish explicitly |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6170 defined upstreams from automatically created by |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6171 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_pass"/> and “friends” |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6172 (FastCGI, SCGI, etc.) |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6173 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6174 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6175 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6176 <literal>NGX_HTTP_UPSTREAM_WEIGHT</literal> — “<literal>weight</literal>” |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6177 is supported |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6178 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6179 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6180 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6181 <literal>NGX_HTTP_UPSTREAM_MAX_FAILS</literal> — “<literal>max_fails</literal>” |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6182 is supported |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6183 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6184 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6185 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6186 <literal>NGX_HTTP_UPSTREAM_FAIL_TIMEOUT</literal> — |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6187 “<literal>fail_timeout</literal>” is supported |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6188 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6189 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6190 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6191 <literal>NGX_HTTP_UPSTREAM_DOWN</literal> — “<literal>down</literal>” |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6192 is supported |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6193 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6194 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6195 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6196 <literal>NGX_HTTP_UPSTREAM_BACKUP</literal> — “<literal>backup</literal>” |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6197 is supported |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6198 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6199 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6200 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6201 <literal>NGX_HTTP_UPSTREAM_MAX_CONNS</literal> — “<literal>max_conns</literal>” |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6202 is supported |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6203 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6204 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6205 </list> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6206 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6207 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6208 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6209 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6210 <literal>host</literal> — the name of an upstream |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6211 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6212 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6213 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6214 <literal>file_name, line</literal> — the name of the configuration file |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6215 and the line where the <literal>upstream</literal> block is located |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6216 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6217 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6218 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6219 <literal>port</literal> and <literal>no_port</literal> — unused by explicit |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6220 upstreams |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6221 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6222 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6223 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6224 <literal>shm_zone</literal> — a shared memory zone used by this upstream, if any |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6225 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6226 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6227 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6228 <literal>peer</literal> — an object that holds generic methods for |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6229 initializing upstream configuration: |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6230 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6231 <programlisting> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6232 typedef struct { |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6233 ngx_http_upstream_init_pt init_upstream; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6234 ngx_http_upstream_init_peer_pt init; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6235 void *data; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6236 } ngx_http_upstream_peer_t; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6237 </programlisting> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6238 A module that implements a load balancing algorithm must set these |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6239 methods and initialize private <literal>data</literal>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6240 If <literal>init_upstream</literal> was not initialized during configuration |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6241 parsing, <literal>ngx_http_upstream_module</literal> sets it to default |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6242 <literal>ngx_http_upstream_init_round_robin</literal>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6243 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6244 <list type="bullet"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6245 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6246 <literal>init_upstream(cf, us)</literal> — configuration-time |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6247 method responsible for initializing a group of servers and |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6248 initializing the <literal>init()</literal> method in case of success. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6249 A typical load balancing module uses a list of servers in the upstream block |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6250 to create some efficient data structure that it uses and saves own |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6251 configuration to the <literal>data</literal> field. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6252 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6253 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6254 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6255 <literal>init(r, us)</literal> — initializes per-request |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6256 <literal>ngx_http_upstream_peer_t.peer</literal> (not to be confused with the |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6257 <literal>ngx_http_upstream_srv_conf_t.peer</literal> described above which |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6258 is per-upstream) structure that is used for load balancing. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6259 It will be passed as <literal>data</literal> argument to all callbacks that |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6260 deal with server selection. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6261 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6262 </list> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6263 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6264 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6265 </list> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6266 </para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6267 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6268 <para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6269 When nginx has to pass a request to another host for processing, it uses |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6270 a configured load balancing method to obtain an address to connect to. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6271 The method is taken from the |
1994
effdf0747a05
Development guide: fixed a typo.
Vladimir Homutov <vl@nginx.com>
parents:
1993
diff
changeset
|
6272 <literal>ngx_http_upstream_t.peer</literal> object |
1939
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6273 of type <literal>ngx_peer_connection_t</literal>: |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6274 <programlisting> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6275 struct ngx_peer_connection_s { |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6276 [...] |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6277 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6278 struct sockaddr *sockaddr; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6279 socklen_t socklen; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6280 ngx_str_t *name; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6281 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6282 ngx_uint_t tries; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6283 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6284 ngx_event_get_peer_pt get; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6285 ngx_event_free_peer_pt free; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6286 ngx_event_notify_peer_pt notify; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6287 void *data; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6288 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6289 #if (NGX_SSL || NGX_COMPAT) |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6290 ngx_event_set_peer_session_pt set_session; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6291 ngx_event_save_peer_session_pt save_session; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6292 #endif |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6293 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6294 [..] |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6295 }; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6296 </programlisting> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6297 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6298 The structure has the following fields: |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6299 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6300 <list type="bullet"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6301 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6302 <literal>sockaddr</literal>, <literal>socklen</literal>, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6303 <literal>name</literal> — address of an upstream server to connect to; |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6304 this is the output parameter of a load balancing method |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6305 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6306 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6307 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6308 <literal>data</literal> — per-request load balancing method data; keeps the |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6309 state of selection algorithm and usually includes the link to upstream |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6310 configuration. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6311 It will be passed as an argument to all methods that deal with server selection |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6312 (see below) |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6313 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6314 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6315 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6316 <literal>tries</literal> — allowed |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6317 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_next_upstream_tries">number</link> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6318 of attempts to connect to an upstream. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6319 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6320 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6321 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6322 <literal>get</literal>, <literal>free</literal>, <literal>notify</literal>, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6323 <literal>set_session</literal>, and <literal>save_session</literal> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6324 - methods of the load balancing module, see description below |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6325 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6326 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6327 </list> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6328 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6329 </para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6330 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6331 <para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6332 All methods accept at least two arguments: peer connection object |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6333 <literal>pc</literal> and the <literal>data</literal> created by |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6334 <literal>ngx_http_upstream_srv_conf_t.peer.init()</literal>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6335 Note that in general case it may differ from <literal>pc.data</literal> due |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6336 to “chaining” of load balancing modules. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6337 </para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6338 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6339 <para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6340 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6341 <list type="bullet"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6342 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6343 <literal>get(pc, data)</literal> — the method is called when the upstream |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6344 module is ready to pass a request to an upstream server and needs to know |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6345 its address. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6346 The method is responsible to fill in the <literal>sockaddr</literal>, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6347 <literal>socklen</literal>, and <literal>name</literal> fields of |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6348 <literal>ngx_peer_connection_t</literal> structure. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6349 The return value may be one of: |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6350 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6351 <list type="bullet"> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6352 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6353 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6354 <literal>NGX_OK</literal> — server was selected |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6355 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6356 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6357 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6358 <literal>NGX_ERROR</literal> — internal error occurred |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6359 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6360 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6361 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6362 <literal>NGX_BUSY</literal> — there are no available servers at the moment. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6363 This can happen due to many reasons, such as: dynamic server group is empty, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6364 all servers in the group are in the failed state, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6365 all servers in the group are already |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6366 handling the maximum number of connections or similar. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6367 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6368 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6369 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6370 <literal>NGX_DONE</literal> — this is set by the <literal>keepalive</literal> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6371 module to indicate that the underlying connection was reused and there is no |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6372 need to create a new connection to the upstream server. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6373 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6374 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6375 <!-- |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6376 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6377 <literal>NGX_ABORT</literal> — this is set by the <literal>queue</literal> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6378 module to indicate that the request was queued and the further processing |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6379 of this request should be postponed. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6380 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6381 --> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6382 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6383 </list> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6384 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6385 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6386 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6387 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6388 <literal>free(pc, data, state)</literal> — the method is called when an |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6389 upstream module has finished work with a particular server. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6390 The <literal>state</literal> argument is the status of upstream connection |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6391 completion. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6392 This is a bitmask, the following values may be set: |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6393 <literal>NGX_PEER_FAILED</literal> — this attempt is considered |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6394 <link doc="../http/ngx_http_upstream_module.xml" id="max_fails">unsuccessful</link>, |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6395 <literal>NGX_PEER_NEXT</literal> — a special case with codes 403 and 404 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6396 (see link above), which are not considered a failure. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6397 <literal>NGX_PEER_KEEPALIVE</literal>. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6398 Also, <literal>tries</literal> counter is decremented by this method. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6399 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6400 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6401 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6402 <literal>notify(pc, data, type)</literal> — currently unused |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6403 in the OSS version. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6404 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6405 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6406 <listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6407 <literal>set_session(pc, data)</literal> and |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6408 <literal>save_session(pc, data)</literal> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6409 — SSL-specific methods that allow to cache sessions to upstream |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6410 servers. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6411 The implementation is provided by the round-robin balancing method. |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6412 </listitem> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6413 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6414 </list> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6415 |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6416 </para> |
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6417 |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
6418 </section> |
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
6419 |
1939
c1b0169e8f54
Added the "Load balancing" section of the development guide.
Vladimir Homutov <vl@nginx.com>
parents:
1936
diff
changeset
|
6420 </section> |
1929
7f290929b32d
HTTP section of the development guide.
Roman Arutyunyan <arut@nginx.com>
parents:
1928
diff
changeset
|
6421 |
1899 | 6422 </article> |