Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2015-02-20 23:30:57 +09:00
parent e45c523dc7
commit 2fc1dd77d2
1 changed files with 5 additions and 2 deletions

View File

@ -383,7 +383,9 @@ typedef enum {
*/ */
NGHTTP2_NV_FLAG_NONE = 0, NGHTTP2_NV_FLAG_NONE = 0,
/** /**
* Indicates that this name/value pair must not be indexed. * Indicates that this name/value pair must not be indexed ("Literal
* Header Field never Indexed" representation must be used in HPACK
* encoding). Other implementation calls this bit as "sensitive".
*/ */
NGHTTP2_NV_FLAG_NO_INDEX = 0x01 NGHTTP2_NV_FLAG_NO_INDEX = 0x01
} nghttp2_nv_flag; } nghttp2_nv_flag;
@ -1398,7 +1400,8 @@ typedef int (*nghttp2_on_begin_headers_callback)(nghttp2_session *session,
* *
* If :enum:`NGHTTP2_NV_FLAG_NO_INDEX` is set in |flags|, the receiver * If :enum:`NGHTTP2_NV_FLAG_NO_INDEX` is set in |flags|, the receiver
* must not index this name/value pair when forwarding it to the next * must not index this name/value pair when forwarding it to the next
* hop. * hop. More specifically, "Literal Header Field never Indexed"
* representation must be used in HPACK encoding.
* *
* When this callback is invoked, ``frame->hd.type`` is either * When this callback is invoked, ``frame->hd.type`` is either
* :enum:`NGHTTP2_HEADERS` or :enum:`NGHTTP2_PUSH_PROMISE`. After all * :enum:`NGHTTP2_HEADERS` or :enum:`NGHTTP2_PUSH_PROMISE`. After all