comparison xml/en/docs/stream/ngx_stream_proxy_module.xml @ 1535:61b1ab5adbc9

Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 14 Jul 2015 19:44:42 +0300
parents 7b15698cbdb7
children 08498db38e58
comparison
equal deleted inserted replaced
1534:e318a80033f5 1535:61b1ab5adbc9
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_proxy_module" 9 <module name="Module ngx_stream_proxy_module"
10 link="/en/docs/stream/ngx_stream_proxy_module.html" 10 link="/en/docs/stream/ngx_stream_proxy_module.html"
11 lang="en" 11 lang="en"
12 rev="9"> 12 rev="10">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows passing 17 The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows passing
79 </para> 79 </para>
80 80
81 </directive> 81 </directive>
82 82
83 83
84 <directive name="proxy_download_rate">
85 <syntax><value>rate</value></syntax>
86 <default>0</default>
87 <context>stream</context>
88 <context>server</context>
89 <appeared-in>1.9.3</appeared-in>
90
91 <para>
92 Limits the speed of reading the data from the proxied server.
93 The <value>rate</value> is specified in bytes per second.
94 The zero value disables rate limiting.
95 The limit is set per a connection, so if nginx simultaneously opens
96 two connections to the proxied server,
97 the overall rate will be twice as much as the specified limit.
98 </para>
99
100 </directive>
101
102
84 <directive name="proxy_downstream_buffer"> 103 <directive name="proxy_downstream_buffer">
85 <syntax><value>size</value></syntax> 104 <syntax><value>size</value></syntax>
86 <default>16k</default> 105 <default>16k</default>
87 <context>stream</context> 106 <context>stream</context>
88 <context>server</context> 107 <context>server</context>
89 108
90 <para> 109 <para>
91 Sets the <value>size</value> of the 110 Sets the <value>size</value> of the
92 buffer used for reading data from the client. 111 buffer used for reading data from the client.
93 </para>
94
95 </directive>
96
97
98 <directive name="proxy_downstream_limit_rate">
99 <syntax><value>rate</value></syntax>
100 <default>0</default>
101 <context>stream</context>
102 <context>server</context>
103 <appeared-in>1.9.3</appeared-in>
104
105 <para>
106 Limits the speed of reading the data from the client.
107 The <value>rate</value> is specified in bytes per second.
108 The zero value disables rate limiting.
109 The limit is set per a connection, so if the client simultaneously opens
110 two connections,
111 the overall rate will be twice as much as the specified limit.
112 </para> 112 </para>
113 113
114 </directive> 114 </directive>
115 115
116 116
425 </para> 425 </para>
426 426
427 </directive> 427 </directive>
428 428
429 429
430 <directive name="proxy_upload_rate">
431 <syntax><value>rate</value></syntax>
432 <default>0</default>
433 <context>stream</context>
434 <context>server</context>
435 <appeared-in>1.9.3</appeared-in>
436
437 <para>
438 Limits the speed of reading the data from the client.
439 The <value>rate</value> is specified in bytes per second.
440 The zero value disables rate limiting.
441 The limit is set per a connection, so if the client simultaneously opens
442 two connections,
443 the overall rate will be twice as much as the specified limit.
444 </para>
445
446 </directive>
447
448
430 <directive name="proxy_upstream_buffer"> 449 <directive name="proxy_upstream_buffer">
431 <syntax><value>size</value></syntax> 450 <syntax><value>size</value></syntax>
432 <default>16k</default> 451 <default>16k</default>
433 <context>stream</context> 452 <context>stream</context>
434 <context>server</context> 453 <context>server</context>
438 buffer used for reading data from the upstream server. 457 buffer used for reading data from the upstream server.
439 </para> 458 </para>
440 459
441 </directive> 460 </directive>
442 461
443
444 <directive name="proxy_upstream_limit_rate">
445 <syntax><value>rate</value></syntax>
446 <default>0</default>
447 <context>stream</context>
448 <context>server</context>
449 <appeared-in>1.9.3</appeared-in>
450
451 <para>
452 Limits the speed of reading the data from the proxied server.
453 The <value>rate</value> is specified in bytes per second.
454 The zero value disables rate limiting.
455 The limit is set per a connection, so if nginx simultaneously opens
456 two connections to the proxied server,
457 the overall rate will be twice as much as the specified limit.
458 </para>
459
460 </directive>
461
462 </section> 462 </section>
463 463
464 </module> 464 </module>