Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_memcached_module.xml @ 2996:98bd95a5ac70
Added link to Preload Objects from js_preload_object.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 16 Aug 2023 12:12:22 +0100 |
parents | 53734009b0c3 |
children |
rev | line source |
---|---|
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
7 |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_memcached_module" |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_memcached_module.html" |
589 | 12 lang="en" |
2861
53734009b0c3
Removed documentation for nonexistent memcached_force_ranges.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2254
diff
changeset
|
13 rev="18"> |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
966 | 18 The <literal>ngx_http_memcached_module</literal> module is used to obtain |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 responses from a memcached server. |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 The key is set in the <var>$memcached_key</var> variable. |
966 | 21 A response should be put in memcached in advance by means |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 external to nginx. |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 </section> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 <section id="example" name="Example Configuration"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 <para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 <example> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 server { |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 location / { |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 set $memcached_key "$uri?$args"; |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 memcached_pass host:11211; |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 error_page 404 502 504 = @fallback; |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 } |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 location @fallback { |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 proxy_pass http://backend; |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 } |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 } |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 </example> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 </section> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 <section id="directives" name="Directives"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
51 <directive name="memcached_bind"> |
1885
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
52 <syntax> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
53 <value>address</value> |
2115
d7d65cc0aa1e
Removed space from memcached_bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2090
diff
changeset
|
54 [<literal>transparent </literal>] | |
1885
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
55 <literal>off</literal></syntax> |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
56 <default/> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
57 <context>http</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
58 <context>server</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
59 <context>location</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
60 <appeared-in>0.8.22</appeared-in> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
61 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
62 <para> |
966 | 63 Makes outgoing connections to a memcached server originate |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
64 from the specified local IP address with an optional port (1.11.2). |
966 | 65 Parameter value can contain variables (1.3.12). |
815
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
814
diff
changeset
|
66 The special value <literal>off</literal> (1.3.12) cancels the effect |
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
814
diff
changeset
|
67 of the <literal>memcached_bind</literal> directive |
966 | 68 inherited from the previous configuration level, which allows the |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
69 system to auto-assign the local IP address and port. |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
70 </para> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
71 |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
72 <para id="memcached_bind_transparent"> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
73 The <literal>transparent</literal> parameter (1.11.0) allows |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
74 outgoing connections to a memcached server originate |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
75 from a non-local IP address, |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
76 for example, from a real IP address of a client: |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
77 <example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
78 memcached_bind $remote_addr transparent; |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
79 </example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
80 In order for this parameter to work, |
2090
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2056
diff
changeset
|
81 it is usually necessary to run nginx worker processes with the |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2056
diff
changeset
|
82 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges. |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2056
diff
changeset
|
83 On Linux it is not required (1.13.8) as if |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2056
diff
changeset
|
84 the <literal>transparent</literal> parameter is specified, worker processes |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2056
diff
changeset
|
85 inherit the <literal>CAP_NET_RAW</literal> capability from the master process. |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2056
diff
changeset
|
86 It is also necessary to configure kernel routing table |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
87 to intercept network traffic from the memcached server. |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
88 </para> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
89 |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
90 </directive> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
91 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
677
diff
changeset
|
92 |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 <directive name="memcached_buffer_size"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 <syntax><value>size</value></syntax> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 <default>4k|8k</default> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <context>http</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <context>server</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 <context>location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
101 Sets the <value>size</value> of the buffer used for reading the response |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 received from the memcached server. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
103 The response is passed to the client synchronously, as soon as it is received. |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 </directive> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 <directive name="memcached_connect_timeout"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 <syntax><value>time</value></syntax> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 <default>60s</default> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 <context>http</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 <context>server</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <context>location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 <para> |
966 | 117 Defines a timeout for establishing a connection with a memcached server. |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 It should be noted that this timeout cannot usually exceed 75 seconds. |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 </directive> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 |
675
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
124 <directive name="memcached_gzip_flag"> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
125 <syntax><value>flag</value></syntax> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
126 <default></default> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
127 <context>http</context> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
128 <context>server</context> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
129 <context>location</context> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
130 <appeared-in>1.3.6</appeared-in> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
131 |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
132 <para> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
133 Enables the test for the <value>flag</value> presence in the memcached |
966 | 134 server response and sets the “<literal>Content-Encoding</literal>” |
135 response header field to “<literal>gzip</literal>” | |
675
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
136 if the flag is set. |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
137 </para> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
138 |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
139 </directive> |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
140 |
08140f6b7964
Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
141 |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 <directive name="memcached_next_upstream"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 <syntax> |
364 | 144 <literal>error</literal> | |
145 <literal>timeout</literal> | | |
146 <literal>invalid_response</literal> | | |
147 <literal>not_found</literal> | | |
148 <literal>off</literal> | |
149 ...</syntax> | |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 <default>error timeout</default> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 <context>http</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <context>server</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <context>location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 <para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 Specifies in which cases a request should be passed to the next server: |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 <list type="tag"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 <tag-name><literal>error</literal></tag-name> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 <tag-desc>an error occurred while establishing a connection with the |
966 | 161 server, passing a request to it, or reading the response header;</tag-desc> |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 <tag-name><literal>timeout</literal></tag-name> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 <tag-desc>a timeout has occurred while establishing a connection with the |
966 | 165 server, passing a request to it, or reading the response header;</tag-desc> |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 <tag-name><literal>invalid_response</literal></tag-name> |
966 | 168 <tag-desc>a server returned an empty or invalid response;</tag-desc> |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 <tag-name><literal>not_found</literal></tag-name> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 <tag-desc>a response was not found on the server;</tag-desc> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 <tag-name><literal>off</literal></tag-name> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 <tag-desc>disables passing a request to the next server.</tag-desc> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 </list> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 <para> |
966 | 180 One should bear in mind that passing a request to the next server is |
181 only possible if nothing has been sent to a client yet. | |
182 That is, if an error or timeout occurs in the middle of the | |
183 transferring of a response, fixing this is impossible. | |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
186 <para> |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1157
diff
changeset
|
187 The directive also defines what is considered an |
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1157
diff
changeset
|
188 <link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful |
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1157
diff
changeset
|
189 attempt</link> of communication with a server. |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
190 The cases of <literal>error</literal>, <literal>timeout</literal> and |
2056
af6f326dee75
Fixed spelling of "invalid_response" in "memcached_next_upstream".
Ruslan Ermilov <ru@nginx.com>
parents:
1885
diff
changeset
|
191 <literal>invalid_response</literal> are always considered unsuccessful attempts, |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
192 even if they are not specified in the directive. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
193 The case of <literal>not_found</literal> |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
194 is never considered an unsuccessful attempt. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
195 </para> |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
878
diff
changeset
|
196 |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
197 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
198 Passing a request to the next server can be limited by |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
199 <link id="memcached_next_upstream_tries">the number of tries</link> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
200 and by <link id="memcached_next_upstream_timeout">time</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
201 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
202 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
203 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
204 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
205 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
206 <directive name="memcached_next_upstream_timeout"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
207 <syntax><value>time</value></syntax> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
208 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
209 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
210 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
211 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
212 <appeared-in>1.7.5</appeared-in> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
213 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
214 <para> |
1672
9c98c4498f08
Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1622
diff
changeset
|
215 Limits the time during which a request can be passed to the |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
216 <link id="memcached_next_upstream">next server</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
217 The <literal>0</literal> value turns off this limitation. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
218 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
219 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
220 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
221 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
222 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
223 <directive name="memcached_next_upstream_tries"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
224 <syntax><value>number</value></syntax> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
225 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
226 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
227 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
228 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
229 <appeared-in>1.7.5</appeared-in> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
230 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
231 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
232 Limits the number of possible tries for passing a request to the |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
233 <link id="memcached_next_upstream">next server</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
234 The <literal>0</literal> value turns off this limitation. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
235 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
236 |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 </directive> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 <directive name="memcached_pass"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 <syntax><value>address</value></syntax> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 <default/> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 <context>location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 <context>if in location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 <para> |
966 | 247 Sets the memcached server address. |
1622
c4c1dddfedac
Unified *_pass address descriptions.
Ruslan Ermilov <ru@nginx.com>
parents:
1337
diff
changeset
|
248 The address can be specified as a domain name or IP address, |
c4c1dddfedac
Unified *_pass address descriptions.
Ruslan Ermilov <ru@nginx.com>
parents:
1337
diff
changeset
|
249 and a port: |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 <example> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
251 memcached_pass localhost:11211; |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 </example> |
814
f46a132af596
"memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents:
772
diff
changeset
|
253 or as a UNIX-domain socket path: |
f46a132af596
"memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents:
772
diff
changeset
|
254 <example> |
f46a132af596
"memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents:
772
diff
changeset
|
255 memcached_pass unix:/tmp/memcached.socket; |
f46a132af596
"memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents:
772
diff
changeset
|
256 </example> |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 <para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 If a domain name resolves to several addresses, all of them will be |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 used in a round-robin fashion. |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 In addition, an address can be specified as a |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 <link doc="ngx_http_upstream_module.xml">server group</link>. |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 </directive> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 <directive name="memcached_read_timeout"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 <syntax><value>time</value></syntax> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 <default>60s</default> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 <context>http</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 <context>server</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 <context>location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 <para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 Defines a timeout for reading a response from the memcached server. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
966
diff
changeset
|
278 The timeout is set only between two successive read operations, |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 not for the transmission of the whole response. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
966
diff
changeset
|
280 If the memcached server does not transmit anything within this time, |
966 | 281 the connection is closed. |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 </directive> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <directive name="memcached_send_timeout"> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 <syntax><value>time</value></syntax> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 <default>60s</default> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 <context>http</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 <context>server</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 <context>location</context> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 <para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 Sets a timeout for transmitting a request to the memcached server. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
966
diff
changeset
|
296 The timeout is set only between two successive write operations, |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 not for the transmission of the whole request. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
966
diff
changeset
|
298 If the memcached server does not receive anything within this time, |
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
966
diff
changeset
|
299 the connection is closed. |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 </para> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
302 </directive> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 |
2254
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
304 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
305 <directive name="memcached_socket_keepalive"> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
306 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
307 <default>off</default> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
308 <context>http</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
309 <context>server</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
310 <context>location</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
311 <appeared-in>1.15.6</appeared-in> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
312 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
313 <para> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
314 Configures the “TCP keepalive” behavior |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
315 for outgoing connections to a memcached server. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
316 By default, the operating system’s settings are in effect for the socket. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
317 If the directive is set to the value “<literal>on</literal>”, the |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
318 <c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
319 </para> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
320 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
321 </directive> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2115
diff
changeset
|
322 |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 </section> |
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 |
1157
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
325 |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
326 <section id="variables" name="Embedded Variables"> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
327 |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
328 <para> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
329 <list type="tag"> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
330 |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
331 <tag-name id="var_memcached_key"><var>$memcached_key</var></tag-name> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
332 <tag-desc> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
333 Defines a key for obtaining response from a memcached server. |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
334 </tag-desc> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
335 |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
336 </list> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
337 </para> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
338 |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
339 </section> |
a8a643647c76
Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents:
1151
diff
changeset
|
340 |
363
c7fccbe03827
English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 </module> |