From 66368e9bc5700647b90cff2f7a1efd2a54c02f55 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 17 Aug 2014 21:29:24 +0900 Subject: [PATCH] Update doc --- apiref.html | 24 ++++++++++++++---------- nghttp2.h.html | 24 ++++++++++++++---------- 2 files changed, 28 insertions(+), 20 deletions(-) diff --git a/apiref.html b/apiref.html index ec5bdb9d..106da994 100644 --- a/apiref.html +++ b/apiref.html @@ -2609,13 +2609,11 @@ reached.

Warning

-

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 WINDOW_UPDATE frame using -nghttp2_submit_window_update() to that stream ID before +

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 nghttp2_session_callbacks.before_frame_send_callback is -called for this frame. Other types of frames can be submitted to -the returned stream ID.

+called for this frame.

@@ -2715,11 +2713,9 @@ reached.

Warning

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 WINDOW_UPDATE frame using -nghttp2_submit_window_update() to that stream ID before +application must not submit frame to that stream ID before nghttp2_session_callbacks.before_frame_send_callback is -called for this frame. Other types of frames can be submitted to -the returned stream ID.

+called for this frame.

@@ -2855,6 +2851,14 @@ reached.
NGHTTP2_ERR_INVALID_ARGUMENT
The stream_id is 0.
+
+

Warning

+

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 +nghttp2_session_callbacks.before_frame_send_callback is +called for this frame.

+
diff --git a/nghttp2.h.html b/nghttp2.h.html index 132c590c..53aaaa26 100644 --- a/nghttp2.h.html +++ b/nghttp2.h.html @@ -2433,13 +2433,11 @@ * * .. warning:: * - * 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 WINDOW_UPDATE frame using - * `nghttp2_submit_window_update()` to that stream ID before + * 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. Other types of frames can be submitted to - * the returned stream ID. + * called for this frame. * */ int32_t nghttp2_submit_request(nghttp2_session *session, @@ -2563,11 +2561,9 @@ * * 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 WINDOW_UPDATE frame using - * `nghttp2_submit_window_update()` to that stream ID before + * application must not submit frame to that stream ID before * :member:`nghttp2_session_callbacks.before_frame_send_callback` is - * called for this frame. Other types of frames can be submitted to - * the returned stream ID. + * called for this frame. * */ int32_t nghttp2_submit_headers(nghttp2_session *session, uint8_t flags, @@ -2736,6 +2732,14 @@ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT` * The |stream_id| is 0. * + * .. warning:: + * + * 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. + * */ int32_t nghttp2_submit_push_promise(nghttp2_session *session, uint8_t flags, int32_t stream_id,