Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
N
nghttp2
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
nghttp2
Commits
d9bb3448
Commit
d9bb3448
authored
Sep 10, 2016
by
Tatsuhiro Tsujikawa
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update man pages
parent
d508a0c7
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
119 additions
and
34 deletions
+119
-34
doc/h2load.1
doc/h2load.1
+1
-1
doc/nghttp.1
doc/nghttp.1
+1
-1
doc/nghttpd.1
doc/nghttpd.1
+1
-1
doc/nghttpx.1
doc/nghttpx.1
+61
-16
doc/nghttpx.1.rst
doc/nghttpx.1.rst
+55
-15
No files found.
doc/h2load.1
View file @
d9bb3448
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "H2LOAD" "1" "
Aug 25, 2016" "1.14.0
" "nghttp2"
.TH "H2LOAD" "1" "
Sep 10, 2016" "1.15.0-DEV
" "nghttp2"
.SH NAME
.SH NAME
h2load \- HTTP/2 benchmarking tool
h2load \- HTTP/2 benchmarking tool
.
.
...
...
doc/nghttp.1
View file @
d9bb3448
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTP" "1" "
Aug 25, 2016" "1.14.0
" "nghttp2"
.TH "NGHTTP" "1" "
Sep 10, 2016" "1.15.0-DEV
" "nghttp2"
.SH NAME
.SH NAME
nghttp \- HTTP/2 client
nghttp \- HTTP/2 client
.
.
...
...
doc/nghttpd.1
View file @
d9bb3448
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTPD" "1" "
Aug 25, 2016" "1.14.0
" "nghttp2"
.TH "NGHTTPD" "1" "
Sep 10, 2016" "1.15.0-DEV
" "nghttp2"
.SH NAME
.SH NAME
nghttpd \- HTTP/2 server
nghttpd \- HTTP/2 server
.
.
...
...
doc/nghttpx.1
View file @
d9bb3448
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTPX" "1" "
Aug 25, 2016" "1.14.0
" "nghttp2"
.TH "NGHTTPX" "1" "
Sep 10, 2016" "1.15.0-DEV
" "nghttp2"
.SH NAME
.SH NAME
nghttpx \- HTTP/2 proxy
nghttpx \- HTTP/2 proxy
.
.
...
@@ -800,37 +800,36 @@ Default: \fB100\fP
...
@@ -800,37 +800,36 @@ Default: \fB100\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-frontend\-http2\-window\-bits=<N>
.B \-\-frontend\-http2\-window\-size=<SIZE>
Sets the per\-stream initial window size of HTTP/2 SPDY
Sets the per\-stream initial window size of HTTP/2 and
frontend connection. For HTTP/2, the size is 2**<N>\-1.
SPDY frontend connection.
For SPDY, the size is 2**<N>.
.sp
.sp
Default: \fB
16
\fP
Default: \fB
65535
\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-frontend\-http2\-connection\-window\-
bits=<N
>
.B \-\-frontend\-http2\-connection\-window\-
size=<SIZE
>
Sets the per\-connection window size of HTTP/2 and SPDY
Sets the per\-connection window size of HTTP/2 and SPDY
frontend
connection. For HTTP/2, the size is
frontend
connection. For SPDY connection, the value
2**<N>\-1. For SPDY, the size is 2**<N>
.
less than 64KiB is rounded up to 64KiB
.
.sp
.sp
Default: \fB
16
\fP
Default: \fB
65535
\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-backend\-http2\-window\-
bits=<N
>
.B \-\-backend\-http2\-window\-
size=<SIZE
>
Sets the initial window size of HTTP/2 backend
Sets the initial window size of HTTP/2 backend
connection
to 2**<N>\-1
.
connection.
.sp
.sp
Default: \fB
16
\fP
Default: \fB
65535
\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-backend\-http2\-connection\-window\-
bits=<N
>
.B \-\-backend\-http2\-connection\-window\-
size=<SIZE
>
Sets the per\-connection window size of HTTP/2 backend
Sets the per\-connection window size of HTTP/2 backend
connection
to 2**<N>\-1
.
connection.
.sp
.sp
Default: \fB
30
\fP
Default: \fB
2147483647
\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
...
@@ -856,6 +855,33 @@ backend session is relayed to frontend, and server push
...
@@ -856,6 +855,33 @@ backend session is relayed to frontend, and server push
via Link header field is also supported. SPDY frontend
via Link header field is also supported. SPDY frontend
does not support server push.
does not support server push.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-optimize\-write\-buffer\-size
(Experimental) Enable write buffer size optimization in
frontend HTTP/2 TLS connection. This optimization aims
to reduce write buffer size so that it only contains
bytes which can send immediately. This makes server
more responsive to prioritized HTTP/2 stream because the
buffering of lower priority stream is reduced. This
option is only effective on recent Linux platform.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-optimize\-window\-size
(Experimental) Automatically tune connection level
window size of frontend HTTP/2 TLS connection. If this
feature is enabled, connection window size starts with
the default window size, 65535 bytes. nghttpx
automatically adjusts connection window size based on
TCP receiving window size. The maximum window size is
capped by the value specified by
\fI\%\-\-frontend\-http2\-connection\-window\-size\fP\&. Since the
stream is subject to stream level window size, it should
be adjusted using \fI\%\-\-frontend\-http2\-window\-size\fP option as
well. This option is only effective on recent Linux
platform.
.UNINDENT
.SS Mode
.SS Mode
.INDENT 0.0
.INDENT 0.0
.TP
.TP
...
@@ -1129,6 +1155,20 @@ originally generates HTTP error status code <CODE>.
...
@@ -1129,6 +1155,20 @@ originally generates HTTP error status code <CODE>.
HTTP status code. If error status code comes from
HTTP status code. If error status code comes from
backend server, the custom error pages are not used.
backend server, the custom error pages are not used.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-server\-name=<NAME>
Change server response header field value to <NAME>.
.sp
Default: \fBnghttpx nghttp2/1.15.0\-DEV\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-server\-rewrite
Don\(aqt rewrite server header field in default mode. When
\fI\%\-\-http2\-proxy\fP is used, these headers will not be altered
regardless of this option.
.UNINDENT
.SS API
.SS API
.INDENT 0.0
.INDENT 0.0
.TP
.TP
...
@@ -1538,6 +1578,11 @@ connection from client.
...
@@ -1538,6 +1578,11 @@ connection from client.
.B attribute [R] tls_used
.B attribute [R] tls_used
Return true if TLS is used on the connection.
Return true if TLS is used on the connection.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B attribute [R] tls_sni
Return the TLS SNI value which client sent in this connection.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
...
...
doc/nghttpx.1.rst
View file @
d9bb3448
...
@@ -729,35 +729,34 @@ HTTP/2 and SPDY
...
@@ -729,35 +729,34 @@ HTTP/2 and SPDY
Default: ``100``
Default: ``100``
.. option:: --frontend-http2-window-
bits=<N
>
.. option:: --frontend-http2-window-
size=<SIZE
>
Sets the per-stream initial window size of HTTP/2 SPDY
Sets the per-stream initial window size of HTTP/2 and
frontend connection. For HTTP/2, the size is 2\*\*<N>-1.
SPDY frontend connection.
For SPDY, the size is 2\*\*<N>.
Default: ``
16
``
Default: ``
65535
``
.. option:: --frontend-http2-connection-window-
bits=<N
>
.. option:: --frontend-http2-connection-window-
size=<SIZE
>
Sets the per-connection window size of HTTP/2 and SPDY
Sets the per-connection window size of HTTP/2 and SPDY
frontend
connection. For HTTP/2, the size is
frontend
connection. For SPDY connection, the value
2**<N>-1. For SPDY, the size is 2\*\*<N>
.
less than 64KiB is rounded up to 64KiB
.
Default: ``
16
``
Default: ``
65535
``
.. option:: --backend-http2-window-
bits=<N
>
.. option:: --backend-http2-window-
size=<SIZE
>
Sets the initial window size of HTTP/2 backend
Sets the initial window size of HTTP/2 backend
connection
to 2\*\*<N>-1
.
connection.
Default: ``
16
``
Default: ``
65535
``
.. option:: --backend-http2-connection-window-
bits=<N
>
.. option:: --backend-http2-connection-window-
size=<SIZE
>
Sets the per-connection window size of HTTP/2 backend
Sets the per-connection window size of HTTP/2 backend
connection
to 2\*\*<N>-1
.
connection.
Default: ``
30
``
Default: ``
2147483647
``
.. option:: --http2-no-cookie-crumbling
.. option:: --http2-no-cookie-crumbling
...
@@ -780,6 +779,31 @@ HTTP/2 and SPDY
...
@@ -780,6 +779,31 @@ HTTP/2 and SPDY
via Link header field is also supported. SPDY frontend
via Link header field is also supported. SPDY frontend
does not support server push.
does not support server push.
.. option:: --frontend-http2-optimize-write-buffer-size
(Experimental) Enable write buffer size optimization in
frontend HTTP/2 TLS connection. This optimization aims
to reduce write buffer size so that it only contains
bytes which can send immediately. This makes server
more responsive to prioritized HTTP/2 stream because the
buffering of lower priority stream is reduced. This
option is only effective on recent Linux platform.
.. option:: --frontend-http2-optimize-window-size
(Experimental) Automatically tune connection level
window size of frontend HTTP/2 TLS connection. If this
feature is enabled, connection window size starts with
the default window size, 65535 bytes. nghttpx
automatically adjusts connection window size based on
TCP receiving window size. The maximum window size is
capped by the value specified by
:option:`--frontend-http2-connection-window-size`\. Since the
stream is subject to stream level window size, it should
be adjusted using :option:`--frontend-http2-window-size` option as
well. This option is only effective on recent Linux
platform.
Mode
Mode
~~~~
~~~~
...
@@ -1019,6 +1043,18 @@ HTTP
...
@@ -1019,6 +1043,18 @@ HTTP
HTTP status code. If error status code comes from
HTTP status code. If error status code comes from
backend server, the custom error pages are not used.
backend server, the custom error pages are not used.
.. option:: --server-name=<NAME>
Change server response header field value to <NAME>.
Default: ``nghttpx nghttp2/1.15.0-DEV``
.. option:: --no-server-rewrite
Don't rewrite server header field in default mode. When
:option:`--http2-proxy` is used, these headers will not be altered
regardless of this option.
API
API
~~~
~~~
...
@@ -1409,6 +1445,10 @@ respectively.
...
@@ -1409,6 +1445,10 @@ respectively.
Return true if TLS is used on the connection.
Return true if TLS is used on the connection.
.. rb:attr_reader:: tls_sni
Return the TLS SNI value which client sent in this connection.
.. rb:class:: Request
.. rb:class:: Request
Object to represent request from client. The modification to
Object to represent request from client. The modification to
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment