diff --git a/apiref.html b/apiref.html index 768a312d..d7105b96 100644 --- a/apiref.html +++ b/apiref.html @@ -88,7 +88,7 @@
nghttpd is static web server. It is single threaded and +
nghttpd is a static web server. It is single threaded and multiplexes connections using non-blocking socket.
By default, it uses SSL/TLS connection. Use --no-tls option to disable it.
-nghttpd only accept the HTTP/2.0 connection via NPN/ALPN or direct +
nghttpd only accepts the HTTP/2.0 connection via NPN/ALPN or direct HTTP/2.0 connection. No HTTP Upgrade is supported.
-p option allows users to configure server push.
Just like nghttp, it has verbose output mode for framing @@ -475,7 +475,7 @@ IPv6: listen on port 8080
The nghttpx is a multi-threaded reverse proxy for +
nghttpx is a multi-threaded reverse proxy for h2-10, SPDY and HTTP/1.1. It has several operation modes:
The interesting mode at the moment is the default mode. It works like -a reverse proxy and listens h2-10, SPDY and HTTP/1.1 and +a reverse proxy and listens for h2-10, SPDY and HTTP/1.1 and can be deployed SSL/TLS terminator for existing web server.
The default mode, --http2-proxy and --http2-bridge modes use SSL/TLS in the frontend connection by default. To disable SSL/TLS, use @@ -530,9 +530,9 @@ HTTP/2.0 through HTTP Upgrade.
The --http2-bridge, --client and --client-proxy modes use SSL/TLS in the backend connection by deafult. To disable SSL/TLS, use --backend-no-tls option.
-The nghttpx supports configuration file. See --conf option and +
nghttpx supports configuration file. See --conf option and sample configuration file nghttpx.conf.sample.
-The nghttpx does not support server push.
+nghttpx does not support server push.
In the default mode, (without any of --http2-proxy, --http2-bridge, --client-proxy and --client options), nghttpx works as reverse proxy to the backend server:
@@ -559,7 +559,7 @@ create proxy.pac script like this:SERVERADDR and PORT is the hostname/address and port of the machine nghttpx is running. Please note that Chrome requires valid certificate for secure proxy.
-Then run chrome with the following arguments:
+Then run Chrome with the following arguments:
$ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn
The Client is needs to be configured to use nghttpx as forward +
The Client needs to be configured to use nghttpx as forward proxy. The frontend HTTP/1.1 connection can be upgraded to HTTP/2.0 through HTTP Upgrade. With the above configuration, one can use HTTP/1.1 client to access and test their HTTP/2.0 servers.
@@ -588,10 +588,10 @@ the backend is HTTP/2.0 Web server:The frontend HTTP/1.1 connection can be upgraded to HTTP/2.0 through HTTP Upgrade.
For the operation modes which talk to the backend in HTTP/2.0 over -SSL/TLS, the backend connections can be tunneled though HTTP +SSL/TLS, the backend connections can be tunneled through HTTP proxy. The proxy is specified using --backend-http-proxy-uri option. The following figure illustrates the example of ---http2-bridge and --backend-http-proxy-uri option to talk to +--http2-bridge and --backend-http-proxy-uri options to talk to the outside HTTP/2.0 proxy through HTTP proxy:
Client <-- (HTTP/2.0, SPDY, HTTP/1.1) --> nghttpx <-- (HTTP/2.0) --
@@ -628,16 +628,19 @@ traffic: 141100 bytes total, 840 bytes headers, 116000 bytes data
The above example issued total 1000 requests, using 10 concurrent -clients (thus 10 HTTP/2 sessions), and maximum 10 streams per client.
+clients (thus 10 HTTP/2 sessions), and maximum 10 streams per client. +With -t option, h2load will use multiple native threads to +avoid saturating single core on client side.Warning
-Don’t use this tool against the publicly available server. That -is considered as DOS attack.
+Don’t use this tool against publicly available servers. That +is considered a DOS attack. Please only use against your private +servers.
The src directory contains HPACK tools. The deflatehd is +
The src directory contains HPACK tools. The deflatehd is a command-line header compression tool. The inflatehd is command-line header decompression tool. Both tools read input from stdin and write output to stdout. The errors are written to @@ -700,7 +703,7 @@ value is an array of JSON object, which has at least following keys:
Examples:
{
@@ -764,8 +767,8 @@ value is an array of JSON object, which has at least following keys:
The output can be used as the input for inflatehd and
deflatehd.
With -d option, the extra header_table key is added and its
-associated value includes the state of dyanmic header table after the
-corresponding header set was processed. The value includes at least
+associated value includes the state of dynamic header table after the
+corresponding header set was processed. The value includes at least the
following keys:
Example:
@@ -1034,7 +1037,7 @@ block.The output can be used as the input for deflatehd and inflatehd.
With -d option, the extra header_table key is added and its -associated value includes the state of dyanmic header table after the +associated value includes the state of dynamic header table after the corresponding header set was processed. The format is the same as deflatehd.
The BaseRequestHandler class is used to handle the HTTP/2 -stream. By default, it does not nothing. It must be subclassed to +stream. By default, it does nothing. It must be subclassed to handle each event callback method.
The first callback method invoked is on_headers(). It is called -when HEADERS frame, which includes request header fields, is arrived.
+when HEADERS frame, which includes request header fields, has arrived.If request has request body, on_data(data) is invoked for each chunk of received data.
When whole request is received, on_request_done() is invoked.
@@ -1089,7 +1092,7 @@ used before send_response()Contains a tuple of the form (host, port) referring to the client’s address.