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