Imported Upstream version 1.0.0
[platform/upstream/nghttp2.git] / doc / nghttp2_session_get_stream_remote_window_size.rst
1
2 nghttp2_session_get_stream_remote_window_size
3 =============================================
4
5 Synopsis
6 --------
7
8 *#include <nghttp2/nghttp2.h>*
9
10 .. function:: int32_t nghttp2_session_get_stream_remote_window_size(nghttp2_session *session, int32_t stream_id)
11
12     
13     Returns the remote window size for a given stream *stream_id*.
14     
15     This is the amount of flow-controlled payload (e.g., DATA) that the
16     local endpoint can send without stream level WINDOW_UPDATE.  There
17     is also connection level flow control, so the effective size of
18     payload that the local endpoint can actually send is
19     min(`nghttp2_session_get_stream_remote_window_size()`,
20     `nghttp2_session_get_remote_window_size()`).
21     
22     This function returns -1 if it fails.