From 4dda3f2eae69f53144537668903a840d24f0e25d Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Fri, 27 Mar 2015 01:12:57 +0900 Subject: [PATCH] Update doc --- apiref.html | 38 ++++-- asio_http2.h.html | 10 +- asio_http2_client.h.html | 10 +- asio_http2_server.h.html | 10 +- building-android-binary.html | 10 +- contribute.html | 10 +- genindex.html | 29 +++- h2load-howto.html | 10 +- h2load.1.html | 17 ++- index.html | 14 +- libnghttp2_asio.html | 10 +- nghttp.1.html | 18 ++- nghttp2.h.html | 34 +++-- nghttp2ver.h.html | 14 +- nghttpd.1.html | 18 ++- nghttpx-howto.html | 10 +- nghttpx.1.html | 10 +- objects.inv | Bin 4029 -> 4012 bytes package_README.html | 254 ++++++++++++++++++----------------- py-modindex.html | 10 +- python-apiref.html | 10 +- search.html | 10 +- searchindex.js | 2 +- tutorial-client.html | 10 +- tutorial-hpack.html | 10 +- tutorial-server.html | 10 +- 26 files changed, 326 insertions(+), 262 deletions(-) diff --git a/apiref.html b/apiref.html index 40758559..1e7d038d 100644 --- a/apiref.html +++ b/apiref.html @@ -7,7 +7,7 @@ - API Reference — nghttp2 0.7.8-DEV documentation + API Reference — nghttp2 0.7.10-DEV documentation @@ -28,7 +28,7 @@ - + @@ -66,8 +66,8 @@
  • Development Status
  • Public Test Server
  • Requirements
    • -
  • Build from git
    • -
  • Building documentation
    • +
  • Building from git
    • +
  • Building the documentation
  • Unit tests
  • Integration tests
  • Client, Server and Proxy programs
    • @@ -288,6 +288,10 @@ application callback). This is because these illegal header fields are floating around in existing internet and resetting stream just because of this may break many web sites. This is especially true if we forward to or translate from HTTP/1 traffic.

    +

    For "http" or "https" URIs, ":path" pseudo header fields must start +with "/". The only exception is OPTIONS request, in that case, "*" is +allowed in ":path" pseudo header field to represent system-wide +OPTIONS request.

    With the above validations, nghttp2 library guarantees that header field name passed to nghttp2_on_header_callback() is not empty. Also required pseudo headers are all present and not empty.

    @@ -1182,27 +1186,33 @@ instance implements (since age ==1)

    uint8_t *name
    -

    The name byte string, which is not necessarily NULL -terminated.

    +

    The name byte string. If this struct is presented from library +(e.g., nghttp2_on_frame_recv_callback), name is +guaranteed to be NULL-terminated. When application is +constructing this struct, name is not required to be +NULL-terminated.

    uint8_t *value
    -

    The value byte string, which is not necessarily NULL -terminated.

    +

    The value byte string. If this struct is presented from +library (e.g., nghttp2_on_frame_recv_callback), value +is guaranteed to be NULL-terminated. When application is +constructing this struct, value is not required to be +NULL-terminated.

    size_t namelen
    -

    The length of the name.

    +

    The length of the name, excluding terminating NULL.

    size_t valuelen
    -

    The length of the value.

    +

    The length of the value, excluding terminating NULL.

    @@ -2015,7 +2025,11 @@ error has been detected, nghttp2_on_frame_recv_callback for the frame will not be invoked.

    -

    The value may be NULL if the valuelen is 0.

    +

    Both name and value are guaranteed to be NULL-terminated. The +namelen and valuelen do not include terminal NULL. If +nghttp2_option_set_no_http_messaging() is used with nonzero +value, NULL character may be included in name or value before +terminating NULL.

    Please note that unless nghttp2_option_set_no_http_messaging() is used, nghttp2 library does perform validation against the name and the value using nghttp2_check_header_name() and @@ -3912,7 +3926,7 @@ always succeeds.

    @@ -65,8 +65,8 @@
  • Development Status
  • Public Test Server
  • Requirements
    • -
  • Build from git
    • -
  • Building documentation
    • +
  • Building from git
    • +
  • Building the documentation
  • Unit tests
  • Integration tests
  • Client, Server and Proxy programs
    • @@ -719,6 +719,17 @@
    +
    + --hexdump +
    + +
    + +
    command line option, [1] +
    + +
    +
    --http2-bridge
    @@ -1233,7 +1244,7 @@
    -
    command line option +
    command line option, [1]
    @@ -1793,6 +1804,10 @@ +
    --hexdump, [1] +
    + +
    --http2-bridge
    @@ -2001,7 +2016,7 @@ -
    -d, --data=<FILE> +
    -d, --data=<FILE>, [1]
    @@ -3619,7 +3634,7 @@ @@ -64,8 +64,8 @@
  • Development Status
  • Public Test Server
  • Requirements
    • -
  • Build from git
    • -
  • Building documentation
    • +
  • Building from git
    • +
  • Building the documentation
  • Unit tests
  • Integration tests
  • Client, Server and Proxy programs
    • @@ -255,7 +255,7 @@