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

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2013-08-29 00:29:25 +09:00
parent 45f07abf3a
commit 39d50f9b88
4 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/index.rst
View File

@ -20,5 +20,5 @@ Contents:
Resources
---------
* http://tools.ietf.org/html/draft-ietf-httpbis-http2-04
* http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-01
* http://tools.ietf.org/html/draft-ietf-httpbis-http2-06
* http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-03

11
lib/nghttp2_frame.h
View File

@ -95,8 +95,8 @@ void nghttp2_frame_unpack_frame_hd(nghttp2_frame_hd *hd, const uint8_t* buf);
* Packs HEADERS frame |frame| in wire format and store it in
* |*buf_ptr|. The capacity of |*buf_ptr| is |*buflen_ptr| bytes.
* This function expands |*buf_ptr| as necessary to store frame. When
* expansion occurred, memory previously pointed by |*buf_ptr| may be
* freed. |*buf_ptr| and |*buflen_ptr| are updated accordingly.
* expansion occurred, memory previously pointed by |*buf_ptr| may
* change. |*buf_ptr| and |*buflen_ptr| are updated accordingly.
*
* frame->hd.length is assigned after length is determined during
* packing process.
@ -280,8 +280,8 @@ int nghttp2_frame_unpack_settings_payload(nghttp2_settings_entry **iv_ptr,
* Packs PUSH_PROMISE frame |frame| in wire format and store it in
* |*buf_ptr|. The capacity of |*buf_ptr| is |*buflen_ptr| bytes.
* This function expands |*buf_ptr| as necessary to store frame. When
* expansion occurred, memory previously pointed by |*buf_ptr| may be
* freed. |*buf_ptr| and |*buflen_ptr| are updated accordingly.
* expansion occurred, memory previously pointed by |*buf_ptr| may
* change. |*buf_ptr| and |*buflen_ptr| are updated accordingly.
*
* frame->hd.length is assigned after length is determined during
* packing process.
@ -409,8 +409,7 @@ int nghttp2_frame_unpack_goaway(nghttp2_goaway *frame,
* Packs WINDOW_UPDATE frame |frame| in wire frame format and store it
* in |*buf_ptr|. The capacity of |*buf_ptr| is |*buflen_ptr|
* length. This function expands |*buf_ptr| as necessary to store
* given |frame|. In SPDY/3 spec, WINDOW_UPDATE wire format is always 16
* bytes long.
* given |frame|.
*
* This function returns the size of packed frame if it succeeds, or
* returns one of the following negative error codes:

4
lib/nghttp2_hd.h
View File

@ -161,7 +161,7 @@ void nghttp2_hd_inflate_free(nghttp2_hd_context *inflater);
*
* This function expands |*buf_ptr| as necessary to store the
* result. When expansion occurred, memory previously pointed by
* |*buf_ptr| is freed. |*buf_ptr| and |*buflen_ptr| are updated
* |*buf_ptr| may change. |*buf_ptr| and |*buflen_ptr| are updated
* accordingly.
*
* This function returns the number of bytes outputted if it succeeds,
@ -180,7 +180,7 @@ ssize_t nghttp2_hd_deflate_hd(nghttp2_hd_context *deflater,
/*
* Inflates name/value block stored in |in| with length |inlen|. This
* function performs decompression. The |*nva_ptr| points to the final
* result on succesful decompression. The caller must free |*nva_ptr|
* result on successful decompression. The caller must free |*nva_ptr|
* using nghttp2_nv_array_del().
*
* This function returns the number of name/value pairs in |*nva_ptr|

4
lib/nghttp2_helper.h
View File

@ -63,8 +63,8 @@ uint32_t nghttp2_get_uint32(const uint8_t *data);
* least |min_length| bytes. If |min_length| > |*buflen_ptr|,
* allocates new buffer having at least |min_length| bytes and assigns
* its pointer to |*buf_ptr| and allocated number of bytes to
* |*buflen_ptr|. The memory pointed by |*buf_ptr| previously is
* freed. No memory copy is done between old and new buffer.
* |*buflen_ptr|. The memory pointed by |*buf_ptr| previously may
* change. No memory copy is done between old and new buffer.
* |*buf_ptr| and |*buflen_ptr| are only updated iff this function
* succeeds.
*