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

Add note to manual how to submit frames to new stream ID

This commit is contained in:
Tatsuhiro Tsujikawa 2014-05-31 22:01:18 +09:00
parent 88b69bb669
commit 4f7223e89f
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2192,6 +2192,12 @@ int nghttp2_priority_spec_check_default(const nghttp2_priority_spec *pri_spec);
* arbitrary pointer, which can be retrieved later by * arbitrary pointer, which can be retrieved later by
* `nghttp2_session_get_stream_user_data()`. * `nghttp2_session_get_stream_user_data()`.
* *
* This function returns assigned stream ID if it succeeds. But that
* stream is not opened yet. The application must not submit frame to
* that stream ID before
* :member:`nghttp2_session_callbacks.before_frame_send_callback` is
* called for this frame.
*
* This function returns assigned stream ID if it succeeds, or one of * This function returns assigned stream ID if it succeeds, or one of
* the following negative error codes: * the following negative error codes:
* *
@ -2300,6 +2306,12 @@ int nghttp2_submit_response(nghttp2_session *session,
* specify flags directly. For usual HTTP request, * specify flags directly. For usual HTTP request,
* `nghttp2_submit_request()` is useful. * `nghttp2_submit_request()` is useful.
* *
* This function returns assigned stream ID if it succeeds and
* |stream_id| is -1. But that stream is not opened yet. The
* application must not submit frame to that stream ID before
* :member:`nghttp2_session_callbacks.before_frame_send_callback` is
* called for this frame.
*
* This function returns newly assigned stream ID if it succeeds and * This function returns newly assigned stream ID if it succeeds and
* |stream_id| is -1. Otherwise, this function returns 0 if it * |stream_id| is -1. Otherwise, this function returns 0 if it
* succeeds, or one of the following negative error codes: * succeeds, or one of the following negative error codes:
@ -2456,6 +2468,12 @@ int nghttp2_submit_settings(nghttp2_session *session, uint8_t flags,
* access it in :type:`nghttp2_before_frame_send_callback` and * access it in :type:`nghttp2_before_frame_send_callback` and
* :type:`nghttp2_on_frame_send_callback` of this frame. * :type:`nghttp2_on_frame_send_callback` of this frame.
* *
* This function returns assigned promised stream ID if it succeeds.
* But that stream is not opened yet. The application must not submit
* frame to that stream ID before
* :member:`nghttp2_session_callbacks.before_frame_send_callback` is
* called for this frame.
*
* The client side is not allowed to use this function. * The client side is not allowed to use this function.
* *
* This function returns assigned promised stream ID if it succeeds, * This function returns assigned promised stream ID if it succeeds,