Imported Upstream version 1.0.0
[platform/upstream/nghttp2.git] / doc / nghttp2_session_get_stream_effective_recv_data_length.rst
1
2 nghttp2_session_get_stream_effective_recv_data_length
3 =====================================================
4
5 Synopsis
6 --------
7
8 *#include <nghttp2/nghttp2.h>*
9
10 .. function:: int32_t nghttp2_session_get_stream_effective_recv_data_length( nghttp2_session *session, int32_t stream_id)
11
12     
13     Returns the number of DATA payload in bytes received without
14     WINDOW_UPDATE transmission for the stream *stream_id*.  The local
15     (receive) window size can be adjusted by
16     `nghttp2_submit_window_update()`.  This function takes into account
17     that and returns effective data length.  In particular, if the
18     local window size is reduced by submitting negative
19     window_size_increment with `nghttp2_submit_window_update()`, this
20     function returns the number of bytes less than actually received.
21     
22     This function returns -1 if it fails.