walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2014-02-01 19:46:59 +09:00
parent 8be17f077a
commit 8c0730c281
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/includes/nghttp2/nghttp2.h
View File

@ -1104,6 +1104,20 @@ typedef int (*nghttp2_on_begin_headers_callback)
* The |name| may be ``NULL`` if the |namelen| is 0. The same thing * The |name| may be ``NULL`` if the |namelen| is 0. The same thing
* can be said about the |value|. * can be said about the |value|.
* *
* Please note that nghttp2 library does not perform any validity
* check against the |name| and the |value|. For example, the
* |namelen| could be 0, and/or the |value| contains ``0x0a`` or
* ``0x0d``. The application must check them if it matters. The
* helper function `nghttp2_check_header_name()` and
* `nghttp2_check_header_value()` provide simple validation against
* HTTP2 header field construction rule.
*
* One more thing to note is that the |value| may contain ``NULL``
* (``0x00``) characters. It is used to concatenate header values
* which share the same header field name. The application should
* split these values if it wants to get individual value. This
* concatenation is used in order to keep the ordering of headers.
*
* If the application uses `nghttp2_session_mem_recv()`, it can return * If the application uses `nghttp2_session_mem_recv()`, it can return
* :enum:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()` * :enum:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`
* return without processing further input bytes. The memory pointed * return without processing further input bytes. The memory pointed