Correct misspellings in document
This commit is contained in:
parent
a8625e15f0
commit
132719f752
|
@ -13,7 +13,7 @@ An HPACK encoder and decoder are available as a public API.
|
||||||
|
|
||||||
An experimental high level C++ library is also available.
|
An experimental high level C++ library is also available.
|
||||||
|
|
||||||
We have Python bindings of this libary, but we do not have full
|
We have Python bindings of this library, but we do not have full
|
||||||
code coverage yet.
|
code coverage yet.
|
||||||
|
|
||||||
Development Status
|
Development Status
|
||||||
|
@ -490,7 +490,7 @@ disabled in the frontend and incoming HTTP/1.1 connections can be
|
||||||
upgraded to HTTP/2 through HTTP Upgrade.
|
upgraded to HTTP/2 through HTTP Upgrade.
|
||||||
|
|
||||||
The ``--http2-bridge``, ``--client`` and ``--client-proxy`` modes use
|
The ``--http2-bridge``, ``--client`` and ``--client-proxy`` modes use
|
||||||
SSL/TLS in the backend connection by deafult. To disable SSL/TLS, use
|
SSL/TLS in the backend connection by default. To disable SSL/TLS, use
|
||||||
the ``--backend-no-tls`` option.
|
the ``--backend-no-tls`` option.
|
||||||
|
|
||||||
``nghttpx`` supports a configuration file. See the ``--conf`` option and
|
``nghttpx`` supports a configuration file. See the ``--conf`` option and
|
||||||
|
@ -785,7 +785,7 @@ max_deflate_size
|
||||||
The maximum header table size the encoder uses. This can be smaller
|
The maximum header table size the encoder uses. This can be smaller
|
||||||
than ``max_size``. In this case, the encoder only uses up to first
|
than ``max_size``. In this case, the encoder only uses up to first
|
||||||
``max_deflate_size`` buffer. Since the header table size is still
|
``max_deflate_size`` buffer. Since the header table size is still
|
||||||
``max_size``, the encoder has to keep track of entries ouside the
|
``max_size``, the encoder has to keep track of entries outside the
|
||||||
``max_deflate_size`` but inside the ``max_size`` and make sure
|
``max_deflate_size`` but inside the ``max_size`` and make sure
|
||||||
that they are no longer referenced.
|
that they are no longer referenced.
|
||||||
|
|
||||||
|
|
|
@ -71,7 +71,7 @@ Default: \fB1\fP
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
.B \-i, \-\-input\-file=<FILE>
|
.B \-i, \-\-input\-file=<FILE>
|
||||||
Path of a file with multiple URIs are seperated by EOLs.
|
Path of a file with multiple URIs are separated by EOLs.
|
||||||
This option will disable URIs getting from command\-line.
|
This option will disable URIs getting from command\-line.
|
||||||
If \(aq\-\(aq is given as <FILE>, URIs will be read from stdin.
|
If \(aq\-\(aq is given as <FILE>, URIs will be read from stdin.
|
||||||
URIs are used in this order for each client. All URIs
|
URIs are used in this order for each client. All URIs
|
||||||
|
|
|
@ -46,7 +46,7 @@ OPTIONS
|
||||||
|
|
||||||
.. option:: -i, --input-file=<FILE>
|
.. option:: -i, --input-file=<FILE>
|
||||||
|
|
||||||
Path of a file with multiple URIs are seperated by EOLs.
|
Path of a file with multiple URIs are separated by EOLs.
|
||||||
This option will disable URIs getting from command-line.
|
This option will disable URIs getting from command-line.
|
||||||
If '-' is given as <FILE>, URIs will be read from stdin.
|
If '-' is given as <FILE>, URIs will be read from stdin.
|
||||||
URIs are used in this order for each client. All URIs
|
URIs are used in this order for each client. All URIs
|
||||||
|
|
|
@ -812,7 +812,7 @@ argument in the configuration file. Specify \fByes\fP as an argument
|
||||||
ignored.
|
ignored.
|
||||||
.sp
|
.sp
|
||||||
To specify private key and certificate file which are given as
|
To specify private key and certificate file which are given as
|
||||||
positional arguments in commnad\-line, use \fBprivate\-key\-file\fP and
|
positional arguments in command\-line, use \fBprivate\-key\-file\fP and
|
||||||
\fBcertificate\-file\fP\&.
|
\fBcertificate\-file\fP\&.
|
||||||
.sp
|
.sp
|
||||||
\fI\%\-\-conf\fP option cannot be used in the configuration file and
|
\fI\%\-\-conf\fP option cannot be used in the configuration file and
|
||||||
|
|
|
@ -727,7 +727,7 @@ FILES
|
||||||
ignored.
|
ignored.
|
||||||
|
|
||||||
To specify private key and certificate file which are given as
|
To specify private key and certificate file which are given as
|
||||||
positional arguments in commnad-line, use ``private-key-file`` and
|
positional arguments in command-line, use ``private-key-file`` and
|
||||||
``certificate-file``.
|
``certificate-file``.
|
||||||
|
|
||||||
:option:`--conf` option cannot be used in the configuration file and
|
:option:`--conf` option cannot be used in the configuration file and
|
||||||
|
|
|
@ -87,5 +87,5 @@ If multiple URIs are specified, they are used in round robin manner.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Please note that h2load uses sheme, host and port in the first URI
|
Please note that h2load uses scheme, host and port in the first URI
|
||||||
and ignores those parts in the rest of the URIs.
|
and ignores those parts in the rest of the URIs.
|
||||||
|
|
|
@ -80,7 +80,7 @@ status code, in the above example, which is 200. The second argument,
|
||||||
which is omitted in the above example, is additional header fields to
|
which is omitted in the above example, is additional header fields to
|
||||||
send.
|
send.
|
||||||
|
|
||||||
``nghttp2::asio_http2::server::response::end`` sends responde body.
|
``nghttp2::asio_http2::server::response::end`` sends response body.
|
||||||
In the above example, we send string "hello, world".
|
In the above example, we send string "hello, world".
|
||||||
|
|
||||||
The life time of req and res object ends after the callback set by
|
The life time of req and res object ends after the callback set by
|
||||||
|
@ -277,7 +277,7 @@ response header fields and response body to the console screen:
|
||||||
``boost::asio::io_service`` object and remote server address. When
|
``boost::asio::io_service`` object and remote server address. When
|
||||||
connection is made, the callback function passed to
|
connection is made, the callback function passed to
|
||||||
``nghttp2::asio_http2::client::on_connect`` is invoked with connected
|
``nghttp2::asio_http2::client::on_connect`` is invoked with connected
|
||||||
address as its paramter. After this callback call, use
|
address as its parameter. After this callback call, use
|
||||||
``nghttp2::asio_http2::session::submit`` to send request to the
|
``nghttp2::asio_http2::session::submit`` to send request to the
|
||||||
server. You can submit multiple requests at once without waiting for
|
server. You can submit multiple requests at once without waiting for
|
||||||
the completion of previous request.
|
the completion of previous request.
|
||||||
|
|
|
@ -21,7 +21,7 @@ SSL/TLS, the frontend also supports SPDY protocol.
|
||||||
By default, this mode's frontend connection is encrypted using
|
By default, this mode's frontend connection is encrypted using
|
||||||
SSL/TLS. So server's private key and certificate must be supplied to
|
SSL/TLS. So server's private key and certificate must be supplied to
|
||||||
the command line (or through configuration file). In this case, the
|
the command line (or through configuration file). In this case, the
|
||||||
fontend protocol selection will is done via ALPN or NPN.
|
frontend protocol selection will is done via ALPN or NPN.
|
||||||
|
|
||||||
With ``--frontend-no-tls`` option, user can turn off SSL/TLS in
|
With ``--frontend-no-tls`` option, user can turn off SSL/TLS in
|
||||||
frontend connection. In this case, SPDY protocol is not available
|
frontend connection. In this case, SPDY protocol is not available
|
||||||
|
@ -243,7 +243,7 @@ Read/write rate limit
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
nghttpx supports transfer rate limiting on frontend connections. You
|
nghttpx supports transfer rate limiting on frontend connections. You
|
||||||
can do rate limit per frontend connection for reading and writeing
|
can do rate limit per frontend connection for reading and writing
|
||||||
individually.
|
individually.
|
||||||
|
|
||||||
To perform rate limit for reading, use ``--read-rate`` and
|
To perform rate limit for reading, use ``--read-rate`` and
|
||||||
|
|
|
@ -267,7 +267,7 @@ HTTP/2 servers
|
||||||
(byte string could be ``None``), :py:data:`DATA_EOF` must be
|
(byte string could be ``None``), :py:data:`DATA_EOF` must be
|
||||||
returned as flag. If there is no data available right now, but
|
returned as flag. If there is no data available right now, but
|
||||||
additional data are anticipated, return tuple (``None``,
|
additional data are anticipated, return tuple (``None``,
|
||||||
:py:data:`DATA_DEFERRD`). When data arrived, call
|
:py:data:`DATA_DEFERRED`). When data arrived, call
|
||||||
:py:meth:`resume()` and restart response body transmission.
|
:py:meth:`resume()` and restart response body transmission.
|
||||||
|
|
||||||
Only the body generator can pause response body generation;
|
Only the body generator can pause response body generation;
|
||||||
|
|
|
@ -65,11 +65,11 @@ its stream specific data in ``http2_stream_data`` structure and the
|
||||||
defined as follows::
|
defined as follows::
|
||||||
|
|
||||||
typedef struct {
|
typedef struct {
|
||||||
/* The NULL-terminated URI string to retreive. */
|
/* The NULL-terminated URI string to retrieve. */
|
||||||
const char *uri;
|
const char *uri;
|
||||||
/* Parsed result of the |uri| */
|
/* Parsed result of the |uri| */
|
||||||
struct http_parser_url *u;
|
struct http_parser_url *u;
|
||||||
/* The authroity portion of the |uri|, not NULL-terminated */
|
/* The authority portion of the |uri|, not NULL-terminated */
|
||||||
char *authority;
|
char *authority;
|
||||||
/* The path portion of the |uri|, including query, not
|
/* The path portion of the |uri|, including query, not
|
||||||
NULL-terminated */
|
NULL-terminated */
|
||||||
|
@ -204,7 +204,7 @@ transmission of client connection header is done in
|
||||||
}
|
}
|
||||||
|
|
||||||
Here we specify SETTINGS_MAX_CONCURRENT_STREAMS to 100, which is
|
Here we specify SETTINGS_MAX_CONCURRENT_STREAMS to 100, which is
|
||||||
really not needed for this tiny example progoram, but we are
|
really not needed for this tiny example program, but we are
|
||||||
demonstrating the use of SETTINGS frame. To queue the SETTINGS frame
|
demonstrating the use of SETTINGS frame. To queue the SETTINGS frame
|
||||||
for the transmission, we use `nghttp2_submit_settings()`. Note that
|
for the transmission, we use `nghttp2_submit_settings()`. Note that
|
||||||
`nghttp2_submit_settings()` function only queues the frame and not
|
`nghttp2_submit_settings()` function only queues the frame and not
|
||||||
|
@ -388,7 +388,7 @@ After all name/value pairs are emitted for a frame,
|
||||||
}
|
}
|
||||||
|
|
||||||
In this tutorial, we are just interested in the HTTP response
|
In this tutorial, we are just interested in the HTTP response
|
||||||
HEADERS. We check te frame type and its category (it should be
|
HEADERS. We check the frame type and its category (it should be
|
||||||
:macro:`NGHTTP2_HCAT_RESPONSE` for HTTP response HEADERS). Also check
|
:macro:`NGHTTP2_HCAT_RESPONSE` for HTTP response HEADERS). Also check
|
||||||
its stream ID.
|
its stream ID.
|
||||||
|
|
||||||
|
@ -407,7 +407,7 @@ of data is received from the remote peer::
|
||||||
}
|
}
|
||||||
|
|
||||||
In our case, a chunk of data is response body. After checking stream
|
In our case, a chunk of data is response body. After checking stream
|
||||||
ID, we just write the recieved data to the stdout. Note that the
|
ID, we just write the received data to the stdout. Note that the
|
||||||
output in the terminal may be corrupted if the response body contains
|
output in the terminal may be corrupted if the response body contains
|
||||||
some binary data.
|
some binary data.
|
||||||
|
|
||||||
|
|
|
@ -51,7 +51,7 @@ bound of encoded result, use `nghttp2_hd_deflate_bound()` function::
|
||||||
size_t nghttp2_hd_deflate_bound(nghttp2_hd_deflater *deflater,
|
size_t nghttp2_hd_deflate_bound(nghttp2_hd_deflater *deflater,
|
||||||
const nghttp2_nv *nva, size_t nvlen);
|
const nghttp2_nv *nva, size_t nvlen);
|
||||||
|
|
||||||
Pass this function with the same paramters *deflater*, *nva* and
|
Pass this function with the same parameters *deflater*, *nva* and
|
||||||
*nvlen* which will be passed to `nghttp2_hd_deflate_hd()`.
|
*nvlen* which will be passed to `nghttp2_hd_deflate_hd()`.
|
||||||
|
|
||||||
The subsequent call of `nghttp2_hd_deflate_hd()` will use current
|
The subsequent call of `nghttp2_hd_deflate_hd()` will use current
|
||||||
|
|
Loading…
Reference in New Issue