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

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2015-04-24 00:05:10 +09:00
parent c925c32233
commit 6b0b8ea7d5
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1510,8 +1510,8 @@ typedef int (*nghttp2_on_stream_close_callback)(nghttp2_session *session,
* different error code is desirable, use * different error code is desirable, use
* `nghttp2_submit_rst_stream()` with a desired error code and then * `nghttp2_submit_rst_stream()` with a desired error code and then
* return :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE`. Again, use * return :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE`. Again, use
* `frame->push_promise.promised_stream_id` as stream_id parameter in * ``frame->push_promise.promised_stream_id`` as stream_id parameter
* `nghttp2_submit_rst_stream()` if frame is PUSH_PROMISE. * in `nghttp2_submit_rst_stream()` if frame is PUSH_PROMISE.
* *
* The implementation of this function must return 0 if it succeeds. * The implementation of this function must return 0 if it succeeds.
* It can return :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE` to * It can return :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE` to
@ -1574,12 +1574,15 @@ typedef int (*nghttp2_on_begin_headers_callback)(nghttp2_session *session,
* included in the input bytes. * included in the input bytes.
* *
* Returning :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE` will close * Returning :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE` will close
* the stream by issuing RST_STREAM with * the stream (promised stream if frame is PUSH_PROMISE) by issuing
* :enum:`NGHTTP2_INTERNAL_ERROR`. In this case, * RST_STREAM with :enum:`NGHTTP2_INTERNAL_ERROR`. In this case,
* :type:`nghttp2_on_header_callback` and
* :type:`nghttp2_on_frame_recv_callback` will not be invoked. If a * :type:`nghttp2_on_frame_recv_callback` will not be invoked. If a
* different error code is desirable, use * different error code is desirable, use
* `nghttp2_submit_rst_stream()` with a desired error code and then * `nghttp2_submit_rst_stream()` with a desired error code and then
* return :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE`. * return :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE`. Again, use
* ``frame->push_promise.promised_stream_id`` as stream_id parameter
* in `nghttp2_submit_rst_stream()` if frame is PUSH_PROMISE.
* *
* The implementation of this function must return 0 if it succeeds. * The implementation of this function must return 0 if it succeeds.
* It may return :enum:`NGHTTP2_ERR_PAUSE` or * It may return :enum:`NGHTTP2_ERR_PAUSE` or