Document that calling nghttp2_submit_response to same stream twice is bad idea

2014-12-20 21:53:33 +09:00 · 2014-12-20 21:53:33 +09:00 · e60183313b
parent 7c0a0c495d
commit e60183313b
1 changed files with 6 additions and 0 deletions
--- a/lib/includes/nghttp2/nghttp2.h
+++ b/lib/includes/nghttp2/nghttp2.h
@ -2726,6 +2726,12 @@ int32_t nghttp2_submit_request(nghttp2_session *session,
 *     Out of memory.
 * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
 *     The |stream_id| is 0.
+ *
+ * .. warning::
+ *
+ *   Calling this function twice for the same stream ID may lead to
+ *   program crash.  It is generally considered to a programming error
+ *   to commit response twice.
 */
 int nghttp2_submit_response(nghttp2_session *session, int32_t stream_id,
                            const nghttp2_nv *nva, size_t nvlen,