comparison xml/ru/docs/http/ngx_http_memcached_module.xml @ 361:1018108c5068

Revision.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 26 Jan 2012 21:22:01 +0000
parents 95e5ceac093d
children bb51d3e17dd0
comparison
equal deleted inserted replaced
360:43f379b12b76 361:1018108c5068
1 <?xml version="1.0"?> 1 <?xml version="1.0"?>
2 2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4 4
5 <module name="Директивы модуля ngx_http_memcached_module" 5 <module name="Модуль ngx_http_memcached_module"
6 link="/ru/docs/http/ngx_http_memcached_module.html" 6 link="/ru/docs/http/ngx_http_memcached_module.html"
7 lang="ru"> 7 lang="ru">
8 8
9 <section id="summary"> 9 <section id="summary">
10 10
11 <para> 11 <para>
12 Модуль ngx_http_memcached_module позволяет получать ответ из сервера memcached. 12 Модуль <literal>ngx_http_memcached_module</literal> позволяет получать
13 Ключ задаётся в переменной $memcached_key. 13 ответ из сервера memcached.
14 Ключ задаётся в переменной <var>$memcached_key</var>.
14 Ответ в memcached должен быть предварительно помещён внешним по отношению 15 Ответ в memcached должен быть предварительно помещён внешним по отношению
15 к nginx'у способом. 16 к nginx’у способом.
16 </para> 17 </para>
17 18
18 </section> 19 </section>
19 20
20 21
21 <section name="Пример конфигурации" id="example"> 22 <section id="example" name="Пример конфигурации">
22 23
23 <para> 24 <para>
24 <example> 25 <example>
25 server { 26 server {
26 location / { 27 location / {
27 set $memcached_key "$uri?$args"; 28 set $memcached_key "$uri?$args";
28 memcached_pass host:11211; 29 memcached_pass host:11211;
29 error_page 404 502 504 = @fallback; 30 error_page 404 502 504 = @fallback;
30 } 31 }
31 32
32 location @fallback { 33 location @fallback {
33 proxy_pass http://backend; 34 proxy_pass http://backend;
34 } 35 }
35 } 36 }
36 </example> 37 </example>
37 </para> 38 </para>
38 39
39 </section> 40 </section>
40 41
41 42
42 <section name="Директивы" id="directives"> 43 <section id="directives" name="Директивы">
43 44
44 <directive name="memcached_buffer_size"> 45 <directive name="memcached_buffer_size">
45 <syntax><value>размер</value></syntax> 46 <syntax><value>размер</value></syntax>
46 <default>4k/8k</default> 47 <default>4k|8k</default>
47 <context>http, server, location</context> 48 <context>http</context>
49 <context>server</context>
50 <context>location</context>
48 51
49 <para> 52 <para>
50 Директива задаёт размер буфера, в который будет читаться ответ, 53 Задаёт <value>размер</value> буфера, в который будет читаться ответ,
51 получаемый от сервера memcached. 54 получаемый от сервера memcached.
52 Ответ синхронно передаётся клиенту сразу же по мере его поступления. 55 Ответ синхронно передаётся клиенту сразу же по мере его поступления.
53 </para> 56 </para>
54 57
55 </directive> 58 </directive>
56 59
57 60
58 <directive name="memcached_connect_timeout"> 61 <directive name="memcached_connect_timeout">
59 <syntax><value>время</value></syntax> 62 <syntax><value>время</value></syntax>
60 <default>60</default> 63 <default>60s</default>
61 <context>http, server, location</context> 64 <context>http</context>
65 <context>server</context>
66 <context>location</context>
62 67
63 <para> 68 <para>
64 Директива задаёт таймаут для соединения с сервером memcached. 69 Задаёт таймаут для установления соединения с сервером memcached.
65 Необходимо иметь в виду, что этот таймаут не может быть больше 75 секунд. 70 Необходимо иметь в виду, что этот таймаут обычно не может превышать 75 секунд.
66 </para> 71 </para>
67 72
68 </directive> 73 </directive>
69 74
70 75
75 <literal>invalid_response</literal> | 80 <literal>invalid_response</literal> |
76 <literal>not_found</literal> | 81 <literal>not_found</literal> |
77 <literal>off</literal> 82 <literal>off</literal>
78 ...</syntax> 83 ...</syntax>
79 <default>error timeout</default> 84 <default>error timeout</default>
80 <context>http, server, location</context> 85 <context>http</context>
86 <context>server</context>
87 <context>location</context>
81 88
82 <para> 89 <para>
83 Директива определяет, в каких случаях запрос будет передан следующему 90 Определяет, в каких случаях запрос будет передан следующему серверу:
84 серверу memcached: 91 <list type="tag">
85 <list type="bullet">
86 92
87 <listitem> 93 <tag-name><literal>error</literal></tag-name>
88 error — произшла ошибка соединения с сервером, передачи ему запроса или 94 <tag-desc>произошла ошибка соединения с сервером, передачи ему запроса или
89 чтения заголовка ответа сервера; 95 чтения заголовка ответа сервера;</tag-desc>
90 </listitem>
91 96
92 <listitem> 97 <tag-name><literal>timeout</literal></tag-name>
93 timeout — произошёл таймаут во время соединения с сервером, 98 <tag-desc>произошёл таймаут во время соединения с сервером,
94 передачи ему запроса или чтения заголовка ответа сервера; 99 передачи ему запроса или чтения заголовка ответа сервера;</tag-desc>
95 </listitem>
96 100
97 <listitem> 101 <tag-name><literal>invalid_response</literal></tag-name>
98 invalid_response — сервер вернул пустой или неверный ответ; 102 <tag-desc>сервер вернул пустой или неверный ответ;</tag-desc>
99 </listitem>
100 103
101 <listitem> 104 <tag-name><literal>not_found</literal></tag-name>
102 not_found — сервер не нашёл ответ; 105 <tag-desc>сервер не нашёл ответ;</tag-desc>
103 </listitem>
104 106
105 <listitem> 107 <tag-name><literal>off</literal></tag-name>
106 off — запрещает передачу запроса следующему серверу; 108 <tag-desc>запрещает передачу запроса следующему серверу.</tag-desc>
107 </listitem>
108 109
109 </list> 110 </list>
110 </para> 111 </para>
111 112
112 <para> 113 <para>
118 119
119 </directive> 120 </directive>
120 121
121 122
122 <directive name="memcached_pass"> 123 <directive name="memcached_pass">
123 <syntax><value>URL</value></syntax> 124 <syntax><value>адрес</value></syntax>
124 <default/> 125 <default/>
125 <context>location, if в location, limit_except</context> 126 <context>location</context>
127 <context>if в location</context>
126 128
127 <para> 129 <para>
128 Директива задаёт адрес сервера memcached. 130 Задаёт адрес сервера memcached.
129 Адрес может быть указан в виде доменного имени или адреса, и порта: 131 Адрес может быть указан в виде доменного имени или адреса, и порта, например,
130 <example> 132 <example>
131 memcached_pass localhost:11211; 133 memcached_pass localhost:11211;
132 </example> 134 </example>
133 </para> 135 </para>
134 136
135 <para> 137 <para>
136 Если доменное имя резолвится в несколько адресов, то все они будут 138 Если доменному имени соответствует несколько адресов, то все они будут
137 использоваться в режиме round-robin. 139 использоваться по очереди (round-robin).
138 И кроме того, адрес может быть 140 И, кроме того, адрес может быть
139 <link doc="ngx_http_upstream_module.xml">группой серверов</link>. 141 <link doc="ngx_http_upstream_module.xml">группой серверов</link>.
140 </para> 142 </para>
141 143
142 </directive> 144 </directive>
143 145
144 146
145 <directive name="memcached_read_timeout"> 147 <directive name="memcached_read_timeout">
146 <syntax><value>время</value></syntax> 148 <syntax><value>время</value></syntax>
147 <default>60</default> 149 <default>60s</default>
148 <context>http, server, location</context> 150 <context>http</context>
151 <context>server</context>
152 <context>location</context>
149 153
150 <para> 154 <para>
151 Директива задаёт таймаут при чтении ответа сервера memcached. 155 Задаёт таймаут при чтении ответа сервера memcached.
152 Таймаут устанавливается не на всю передачу ответа, 156 Таймаут устанавливается не на всю передачу ответа,
153 а только между двумя операциями чтения. 157 а только между двумя операциями чтения.
154 Если по истечении этого времени сервер ничего не передаст, 158 Если по истечении этого времени сервер memcached ничего не передаст,
155 то nginx закрывает соединение. 159 соединение закрывается.
156 </para> 160 </para>
157 161
158 </directive> 162 </directive>
159 163
160 164
161 <directive name="memcached_send_timeout"> 165 <directive name="memcached_send_timeout">
162 <syntax><value>время</value></syntax> 166 <syntax><value>время</value></syntax>
163 <default>60</default> 167 <default>60s</default>
164 <context>http, server, location</context> 168 <context>http</context>
169 <context>server</context>
170 <context>location</context>
165 171
166 <para> 172 <para>
167 Директива задаёт таймаут при передаче запроса серверу memcached. 173 Задаёт таймаут при передаче запроса серверу memcached.
168 Таймаут устанавливается не на всю передачу запроса, 174 Таймаут устанавливается не на всю передачу запроса,
169 а только между двумя операциями записи. 175 а только между двумя операциями записи.
170 Если по истечении этого времени сервер не примет новых данных, 176 Если по истечении этого времени сервер memcached не примет новых данных,
171 то nginx закрывает соединение. 177 соединение закрывается.
172 </para> 178 </para>
173 179
174 </directive> 180 </directive>
175 181
176 </section> 182 </section>