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-09-28 18:14:01 +09:00
parent 21d76dcc75
commit f30a238e41
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1409,7 +1409,13 @@ int nghttp2_session_recv(nghttp2_session *session);
* `nghttp2_session_recv()`.
*
* In the current implementation, this function always tries to
* processes all input data unless an error occurs.
* processes all input data unless either an error occurs or
* :enum:`NGHTTP2_ERR_PAUSE` is returned from
* :member:`nghttp2_session_callbacks.on_frame_recv_callback` or
* :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.
* If :enum:`NGHTTP2_ERR_PAUSE` is used, the return value includes the
* number of bytes which was used to produce the data or frame for the
* callback.
*
* This function returns the number of processed bytes, or one of the
* following negative error codes:
@ -1430,6 +1436,10 @@ ssize_t nghttp2_session_mem_recv(nghttp2_session *session,
* :member:`nghttp2_session_callbacks.on_frame_recv_callback` or
* :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.
*
* This function frees resources associated with paused frames. It
* may also call additional callbacks, such as
* :member:`nghttp2_session_callbacks.on_stream_close_callback`.
*
* If this function succeeds, the application can call
* `nghttp2_session_mem_recv()` again.
*