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

More doc about HPACK decoding API

This commit is contained in:
Tatsuhiro Tsujikawa 2016-08-11 11:46:48 +09:00
parent 7dfd6ab1ad
commit 4c381611a1
2 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/sources/tutorial-hpack.rst
View File

@ -78,15 +78,16 @@ header data. To initialize the object, use
int nghttp2_hd_inflate_new(nghttp2_hd_inflater **inflater_ptr); int nghttp2_hd_inflate_new(nghttp2_hd_inflater **inflater_ptr);
To inflate header data, use `nghttp2_hd_inflate_hd()`:: To inflate header data, use `nghttp2_hd_inflate_hd2()`::
ssize_t nghttp2_hd_inflate_hd(nghttp2_hd_inflater *inflater, ssize_t nghttp2_hd_inflate_hd2(nghttp2_hd_inflater *inflater,
nghttp2_nv *nv_out, int *inflate_flags, nghttp2_nv *nv_out, int *inflate_flags,
uint8_t *in, size_t inlen, int in_final); const uint8_t *in, size_t inlen,
int in_final);
`nghttp2_hd_inflate_hd()` reads a stream of bytes and outputs a single `nghttp2_hd_inflate_hd2()` reads a stream of bytes and outputs a
header field at a time. Multiple calls are normally required to read a single header field at a time. Multiple calls are normally required to
full stream of bytes and output all of the header fields. read a full stream of bytes and output all of the header fields.
The *inflater* is the inflater object initialized above. The *nv_out* The *inflater* is the inflater object initialized above. The *nv_out*
is a pointer to a :type:`nghttp2_nv` into which one header field may is a pointer to a :type:`nghttp2_nv` into which one header field may
@ -118,7 +119,7 @@ If *in_final* is zero and the :macro:`NGHTTP2_HD_INFLATE_EMIT` flag is
not set, it indicates that all given data was processed. The caller not set, it indicates that all given data was processed. The caller
is required to pass additional data. is required to pass additional data.
Example usage of `nghttp2_hd_inflate_hd()` is shown in the Example usage of `nghttp2_hd_inflate_hd2()` is shown in the
`inflate_header_block()` function in `deflate.c`_. `inflate_header_block()` function in `deflate.c`_.
Finally, to delete a :type:`nghttp2_hd_inflater` object, use Finally, to delete a :type:`nghttp2_hd_inflater` object, use

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

@ -4768,10 +4768,14 @@ NGHTTP2_EXTERN ssize_t nghttp2_hd_inflate_hd(nghttp2_hd_inflater *inflater,
* *
* 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. If that happens, all given input
* processed successfully. Then the application must call * data (|inlen| bytes) are processed successfully. Then the
* `nghttp2_hd_inflate_end_headers()` to prepare for the next header * application must call `nghttp2_hd_inflate_end_headers()` to prepare
* block input. * for the next header block input.
*
* In other words, if |in_final| is nonzero, and this function returns
* |inlen|, you can assert that :enum:`NGHTTP2_HD_INFLATE_FINAL` is
* set in |*inflate_flags|.
* *
* 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