Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2016-08-21 19:17:51 +09:00
parent 3e0d73c01d
commit 759f6c0b39
1 changed files with 8 additions and 7 deletions

View File

@ -3023,10 +3023,10 @@ nghttp2_session_get_stream_effective_local_window_size(nghttp2_session *session,
/**
* @function
*
* Returns the amount of data that the remote endpoint can send
* without receiving stream level WINDOW_UPDATE frame. It is also
* subject to the connection level flow control. So the actual amount
* of data to send is
* Returns the amount of flow-controlled payload (e.g., DATA) that the
* remote endpoint can send without receiving stream level
* WINDOW_UPDATE frame. It is also subject to the connection level
* flow control. So the actual amount of data to send is
* min(`nghttp2_session_get_stream_local_window_size()`,
* `nghttp2_session_get_local_window_size()`).
*
@ -3076,9 +3076,10 @@ nghttp2_session_get_effective_local_window_size(nghttp2_session *session);
/**
* @function
*
* Returns the amount of data that the remote endpoint can send
* without receiving connection level WINDOW_UPDATE frame. Note that
* each stream is still subject to the stream level flow control (see
* Returns the amount of flow-controlled payload (e.g., DATA) that the
* remote endpoint can send without receiving connection level
* WINDOW_UPDATE frame. Note that each stream is still subject to the
* stream level flow control (see
* `nghttp2_session_get_stream_local_window_size()`).
*
* This function returns -1 if it fails.