Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_spdy_module.xml @ 1051:29de277bf322
Documented the "spdy_chunk_size" directive.
author | Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com> |
---|---|
date | Thu, 23 Jan 2014 11:06:16 +0000 |
parents | 85804d815ed3 |
children | 2ef5a63ce6e2 |
rev | line source |
---|---|
869 | 1 <?xml version="1.0"?> |
2 | |
3 <!-- | |
4 Copyright (C) Nginx, Inc. | |
5 --> | |
6 | |
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
8 | |
9 <module name="Module ngx_http_spdy_module" | |
10 link="/en/docs/http/ngx_http_spdy_module.html" | |
11 lang="en" | |
1051
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
12 rev="4"> |
869 | 13 |
14 <section id="summary"> | |
15 | |
16 <para> | |
17 The <literal>ngx_http_spdy_module</literal> module provides experimental | |
18 support for <link url="http://www.chromium.org/spdy/spdy-protocol">SPDY</link>. | |
19 Currently, | |
20 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2">draft | |
21 2</link> of SPDY protocol is implemented. | |
22 </para> | |
23 | |
24 <para> | |
25 This module is not built by default, it should be enabled with | |
26 the <literal>--with-http_spdy_module</literal> | |
27 configuration parameter. | |
28 </para> | |
29 | |
30 </section> | |
31 | |
32 | |
33 <section id="bugs" name="Known Bugs"> | |
34 | |
35 <para> | |
36 The module is experimental, caveat emptor applies. | |
37 </para> | |
38 | |
39 <para> | |
40 Current implementation of SPDY protocol does not support “server push”. | |
41 </para> | |
42 | |
43 <para> | |
1050
85804d815ed3
The SPDY module now supports "limit_rate".
Valentin Bartenev <vbart@nginx.com>
parents:
966
diff
changeset
|
44 In versions prior to 1.5.9, responses in SPDY connections could not be |
886
ca9a259cb5c8
The SPDY module does not support "limit_rate", not "limit_req".
Valentin Bartenev <vbart@nginx.com>
parents:
869
diff
changeset
|
45 <link doc="ngx_http_core_module.xml" id="limit_rate">rate limited</link>. |
869 | 46 </para> |
47 | |
48 </section> | |
49 | |
50 | |
51 <section id="example" name="Example Configuration"> | |
52 | |
53 <para> | |
54 <example> | |
55 server { | |
56 listen 443 ssl spdy; | |
57 | |
58 ssl_certificate server.crt; | |
59 ssl_certificate_key server.key; | |
60 ... | |
61 } | |
62 </example> | |
63 <note> | |
64 Note that in order to accept both | |
65 <link doc="ngx_http_ssl_module.xml">HTTPS</link> and SPDY connections | |
66 simultaneously on the same port, | |
67 <link url="http://www.openssl.org">OpenSSL</link> library used should support | |
68 “Next Protocol Negotiation” TLS extension, available since OpenSSL | |
69 version 1.0.1. | |
70 </note> | |
71 </para> | |
72 | |
73 </section> | |
74 | |
75 | |
76 <section id="directives" name="Directives"> | |
77 | |
1051
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
78 <directive name="spdy_chunk_size"> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
79 <syntax><value>size</value></syntax> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
80 <default>8k</default> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
81 <context>http</context> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
82 <context>server</context> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
83 <context>location</context> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
84 <appeared-in>1.5.9</appeared-in> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
85 |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
86 <para> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
87 Sets the maximum size of chunks |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
88 into which the response body is |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
89 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2#TOC-Data-frames"> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
90 sliced</link>. |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
91 A too low value results in higher overhead. |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
92 A too high value impairs prioritization due to |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
93 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
94 HOL blocking</link>. |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
95 </para> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
96 |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
97 </directive> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
98 |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
99 |
869 | 100 <directive name="spdy_headers_comp"> |
101 <syntax><value>level</value></syntax> | |
102 <default>0</default> | |
103 <context>http</context> | |
104 <context>server</context> | |
105 | |
106 <para> | |
966 | 107 Sets the header compression <value>level</value> of a response in a range from |
869 | 108 1 (fastest, less compression) to 9 (slowest, best compression). |
966 | 109 The special value 0 turns off the header compression. |
869 | 110 </para> |
111 | |
112 </directive> | |
113 | |
114 </section> | |
115 | |
116 | |
117 <section id="variables" name="Embedded Variables"> | |
118 | |
119 <para> | |
120 The <literal>ngx_http_spdy_module</literal> module | |
121 supports the following embedded variables: | |
122 <list type="tag" compact="no"> | |
123 | |
124 <tag-name id="var_spdy"><var>$spdy</var></tag-name> | |
125 <tag-desc> | |
126 SPDY protocol version for SPDY connections, | |
127 or an empty string otherwise; | |
128 </tag-desc> | |
129 | |
130 <tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var> | |
131 </tag-name> | |
132 <tag-desc> | |
133 request priority for SPDY connections, | |
134 or an empty string otherwise. | |
135 </tag-desc> | |
136 | |
137 </list> | |
138 </para> | |
139 | |
140 </section> | |
141 | |
142 </module> |