comparison xml/ru/docs/http/ngx_http_memcached_module.xml @ 76:4a4caa566120

Russian documentation import. Changes in module.dtd: <example> now allowed to contain <value> and <emphasis> elements (we need this to show important parts in examples), less strict checking of <directive> syntax (we don't want to fully document some directives, notably deprecated ones). Known issues: 1. <syntax> elements are preserved as is, they will require manual conversion (likely to some not-yet-existed format a la DocBook cmdsynopsis, as currently used one seems to be incomplete); 2. <value> no longer corresponds to replaceable content, and it's use in examples isn't correct; 3. <link doc="document#fragment"> doesn't work with current xslt, either should be supported or changed to <link doc="document" id="fragment">. The following files are intentionally omitted: maillists.xml (support.xml should be used instead), experimental.xml (obsolete), faq.xml (conflicts with existing one, needs discussion). Not yet linked to site.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 11 Oct 2011 12:57:50 +0000
parents
children 1d315ef37215
comparison
equal deleted inserted replaced
75:2bf4cd2787c5 76:4a4caa566120
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Директивы модуля ngx_http_memcached_module"
6 link="/ru/docs/http/ngx_http_memcached_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_memcached_module позволяет получать ответ из сервера memcached.
13 Ключ задаётся в переменной $memcached_key.
14 Ответ в memcached должен быть предварительно помещён внешним по отношению
15 к nginx'у способом.
16 </para>
17
18 </section>
19
20
21 <section name="Пример конфигурации" id="example">
22
23 <para>
24 <example>
25 server {
26 location / {
27 set $memcached_key "$uri?$args";
28 memcached_pass host:11211;
29 error_page 404 502 504 = @fallback;
30 }
31
32 location @fallback {
33 proxy_pass http://backend;
34 }
35 }
36 </example>
37 </para>
38
39 </section>
40
41
42 <section name="Директивы" id="directives">
43
44 <directive name="memcached_buffer_size">
45 <syntax>memcached_buffer_size <value>размер</value></syntax>
46 <default>memcached_buffer_size 4k/8k</default>
47 <context>http, server, location</context>
48
49 <para>
50 Директива задаёт размер буфера, в который будет читаться ответ,
51 получаемый от cервера memcached.
52 Ответ синхронно передаётся клиенту сразу же по мере его поступления.
53 </para>
54
55 </directive>
56
57
58 <directive name="memcached_connect_timeout">
59 <syntax>memcached_connect_timeout <value>время</value></syntax>
60 <default>memcached_connect_timeout 60</default>
61 <context>http, server, location</context>
62
63 <para>
64 Директива задаёт таймаут для соединения с cервером memcached.
65 Необходимо иметь в виду, что этот таймаут не может быть больше 75 секунд.
66 </para>
67
68 </directive>
69
70
71 <directive name="memcached_next_upstream">
72 <syntax>memcached_next_upstream
73 <value>[error|timeout|invalid_response|not_found|off]</value>
74 </syntax>
75 <default>memcached_next_upstream error timeout</default>
76 <context>http, server, location</context>
77
78 <para>
79 Директива определяет, в каких случаях запрос будет передан следующему
80 серверу memcached:
81 <list type="bullet">
82
83 <listitem>
84 error — произшла ошибка соединения с сервером, передачи ему запроса или
85 чтения заголовка ответа сервера;
86 </listitem>
87
88 <listitem>
89 timeout — произошёл таймаут во время соединения с сервером,
90 передачи ему запроса или чтения заголовка ответа сервера;
91 </listitem>
92
93 <listitem>
94 invalid_response — сервер вернул пустой или неверный ответ;
95 </listitem>
96
97 <listitem>
98 not_found — сервер не нашёл ответ;
99 </listitem>
100
101 <listitem>
102 off — запрещает передачу запроса следующему серверу;
103 </listitem>
104
105 </list>
106 </para>
107
108 <para>
109 Необходимо понимать, что передача запроса следующему серверу возможна
110 только при условии, что клиенту ещё ничего не передавалось.
111 То есть, если ошибка или таймаут возникли в середине передачи ответа,
112 то исправить это уже невозможно.
113 </para>
114
115 </directive>
116
117
118 <directive name="memcached_pass">
119 <syntax>memcached_pass <value>URL</value></syntax>
120 <default>нет</default>
121 <context>location, if в location, limit_except</context>
122
123 <para>
124 Директива задаёт адрес сервера memcached.
125 Адрес может быть указан в виде доменного имени или адреса и порта:
126 <example>
127 memcached_pass localhost:11211;
128 </example>
129 </para>
130
131 <para>
132 Если доменное имя резолвится в несколько адресов, то все они будут
133 использоваться в режиме round-robin.
134 И кроме того, адрес может быть
135 <link doc="ngx_http_upstream.xml">группой серверов</link>.
136 </para>
137
138 </directive>
139
140
141 <directive name="memcached_read_timeout">
142 <syntax>memcached_read_timeout <value>время</value></syntax>
143 <default>memcached_read_timeout 60</default>
144 <context>http, server, location</context>
145
146 <para>
147 Директива задаёт таймаут при чтении ответа сервера memcached.
148 Таймаут устанавливается не на всю передачу ответа,
149 а только между двумя операциями чтения.
150 Если по истечении этого времени сервер ничего не передаст,
151 то nginx закрывает соединение.
152 </para>
153
154 </directive>
155
156
157 <directive name="memcached_send_timeout">
158 <syntax>memcached_send_timeout <value>время</value></syntax>
159 <default>memcached_send_timeout 60</default>
160 <context>http, server, location</context>
161
162 <para>
163 Директива задаёт таймаут при передаче запроса серверу memcached.
164 Таймаут устанавливается не на всю передачу запроса,
165 а только между двумя операциями записи.
166 Если по истечении этого времени сервер не примет новых данных,
167 то nginx закрывает соединение.
168 </para>
169
170 </directive>
171
172 </section>
173
174 </module>