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-05-06 18:08:41 +09:00
parent 8289943a58
commit 7b7b0ebcca
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2893,7 +2893,7 @@ void nghttp2_hd_inflate_del(nghttp2_hd_inflater *inflater);
/** /**
* @function * @function
* *
* Changes header table size in the |inflater|. This may trigger * Changes header table size in the |inflater|. This may trigger
* eviction in the dynamic table. * eviction in the dynamic table.
* *
* The |settings_hd_table_bufsize_max| should be the value transmitted * The |settings_hd_table_bufsize_max| should be the value transmitted
@ -2931,25 +2931,25 @@ typedef enum {
/** /**
* @function * @function
* *
* Inflates name/value block stored in |in| with length |inlen|. This * Inflates name/value block stored in |in| with length |inlen|. This
* function performs decompression. For each successful emission of * function performs decompression. For each successful emission of
* header name/value pair, :enum:`NGHTTP2_HD_INFLATE_EMIT` is set in * header name/value pair, :enum:`NGHTTP2_HD_INFLATE_EMIT` is set in
* |*inflate_flags| and name/value pair is assigned to the |nv_out| * |*inflate_flags| and name/value pair is assigned to the |nv_out|
* and the function returns. The caller must not free the members of * and the function returns. The caller must not free the members of
* |nv_out|. * |nv_out|.
* *
* The |nv_out| may include pointers to the memory region in the * The |nv_out| may include pointers to the memory region in the |in|.
* |in|. The caller must retain the |in| while the |nv_out| is used. * The caller must retain the |in| while the |nv_out| is used.
* *
* The application should call this function repeatedly until the * The application should call this function repeatedly until the
* ``(*inflate_flags) & NGHTTP2_HD_INFLATE_FINAL`` is nonzero and * ``(*inflate_flags) & NGHTTP2_HD_INFLATE_FINAL`` is nonzero and
* return value is non-negative. This means the all input values are * return value is non-negative. This means the all input values are
* processed successfully. Then the application must call * processed successfully. Then the application must call
* `nghttp2_hd_inflate_end_headers()` to prepare for the next header * `nghttp2_hd_inflate_end_headers()` to prepare for the next header
* block input. * block input.
* *
* The caller can feed complete compressed header block. It also can * The caller can feed complete compressed header block. It also can
* feed it in several chunks. The caller must set |in_final| to * feed it in several chunks. The caller must set |in_final| to
* nonzero if the given input is the last block of the compressed * nonzero if the given input is the last block of the compressed
* header. * header.
* *