Add warning

This commit is contained in:
Tatsuhiro Tsujikawa 2016-02-04 23:27:22 +09:00
parent ff22862b9d
commit 00e722f02c
1 changed files with 8 additions and 0 deletions

View File

@ -1608,6 +1608,14 @@ typedef int (*nghttp2_on_begin_headers_callback)(nghttp2_session *session,
* *
* To set this callback to :type:`nghttp2_session_callbacks`, use * To set this callback to :type:`nghttp2_session_callbacks`, use
* `nghttp2_session_callbacks_set_on_header_callback()`. * `nghttp2_session_callbacks_set_on_header_callback()`.
*
* .. warning::
*
* Application should properly limit the total buffer size to store
* incoming header fields. Without it, peer may send large number
* of header fields or large header fields to cause out of memory in
* local endpoint. Due to how HPACK works, peer can do this
* effectively without using much memory on their own.
*/ */
typedef int (*nghttp2_on_header_callback)(nghttp2_session *session, typedef int (*nghttp2_on_header_callback)(nghttp2_session *session,
const nghttp2_frame *frame, const nghttp2_frame *frame,