Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_memcached_module.xml @ 814:f46a132af596

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"memcached_pass" can be a UNIX-domain socket.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 16 Jan 2013 14:25:01 +0400
parents ce121bf644f5
children ed29fd8be462
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
814
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
13 rev="4">
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>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_memcached_module</literal> module allows to obtain
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.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 A response should be put in memcached in advance via means that are
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">
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
52 <syntax><value>address</value></syntax>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
53 <default/>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
54 <context>http</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
55 <context>server</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
56 <context>location</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
57 <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
58
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
59 <para>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
60 Forces outgoing connections to a memcached server to originate
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
61 from the specified local IP <value>address</value>.
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
62 </para>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
63
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
64 </directive>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
65
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
66
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 <directive name="memcached_buffer_size">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 <syntax><value>size</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <default>4k|8k</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 Sets <value>size</value> of the buffer used for reading a response
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 received from the memcached server.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 A response is passed to a client synchronously, immediately as it is received.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <directive name="memcached_connect_timeout">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 Defines a timeout for establishing a connection with the memcached server.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 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
93 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97
675
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
98 <directive name="memcached_gzip_flag">
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
99 <syntax><value>flag</value></syntax>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
100 <default></default>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
101 <context>http</context>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
102 <context>server</context>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
103 <context>location</context>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
104 <appeared-in>1.3.6</appeared-in>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
105
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
106 <para>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
107 Enables the test for the <value>flag</value> presence in the memcached
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
108 server response and sets the request header field
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
109 “<literal>Content-Encoding</literal>” to “<literal>gzip</literal>”
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
110 if the flag is set.
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
111 </para>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
112
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
113 </directive>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
114
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
115
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 <directive name="memcached_next_upstream">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 <syntax>
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
118 <literal>error</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
119 <literal>timeout</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
120 <literal>invalid_response</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
121 <literal>not_found</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
122 <literal>off</literal>
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
123 ...</syntax>
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 <default>error timeout</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 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
131 <list type="tag">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 <tag-name><literal>error</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 <tag-desc>an error occurred while establishing a connection with the
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 server, passing it a request, or reading the response header;</tag-desc>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137 <tag-name><literal>timeout</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 <tag-desc>a timeout has occurred while establishing a connection with the
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 server, passing it a request, or reading the response header;</tag-desc>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 <tag-name><literal>invalid_response</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <tag-desc>a server returned empty or invalid response;</tag-desc>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 <tag-name><literal>not_found</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 <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
146
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <tag-name><literal>off</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 <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
149
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 </list>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 It should be understood that passing a request to the next server is
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 only possible if a client was not sent anything yet.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 That is, if an error or a timeout occurs in the middle of
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157 transferring a response, fixing this is impossible.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161
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 <directive name="memcached_pass">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 <syntax><value>address</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 <default/>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167 <context>if in location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 Sets an address of the memcached server.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 An address can be specified as a domain name or an address, and a port,
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 for example,
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 <example>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 memcached_pass localhost:11211;
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 </example>
814
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
176 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
177 <example>
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
178 memcached_pass unix:/tmp/memcached.socket;
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
179 </example>
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 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
184 used in a round-robin fashion.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 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
186 <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
187 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 <directive name="memcached_read_timeout">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 Defines a timeout for reading a response from the memcached server.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 A timeout is only set between two successive read operations,
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 not for the transmission of the whole response.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 If a memcached server does not transmit anything within this time,
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 a connection is closed.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 <directive name="memcached_send_timeout">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 Sets a timeout for transmitting a request to the memcached server.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 A timeout is only set between two successive write operations,
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 not for the transmission of the whole request.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 If a memcached server does not receive anything within this time,
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 a connection is closed.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 </section>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 </module>