From e201e08a45cdbf3997e26f1d5830dd50eb9b7135 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Wed, 30 Oct 2013 01:04:28 +0900 Subject: [PATCH] Update doc --- _sources/apiref.txt | 54 ++++++++++++++++++++++++++++++++++++ apiref.html | 52 ++++++++++++++++++++++++++++++++++ genindex.html | 20 ++++++++++++-- nghttp2.h.html | 66 ++++++++++++++++++++++++++++++++++++++++++++ objects.inv | Bin 2004 -> 2034 bytes searchindex.js | 2 +- 6 files changed, 191 insertions(+), 3 deletions(-) diff --git a/_sources/apiref.txt b/_sources/apiref.txt index 22c49191..7dc5599d 100644 --- a/_sources/apiref.txt +++ b/_sources/apiref.txt @@ -1354,6 +1354,60 @@ Functions Returns the number of frames in the outbound queue. This does not include the deferred DATA frames. +.. function:: int32_t nghttp2_session_get_stream_effective_recv_data_length (nghttp2_session *session, int32_t stream_id) + + + Returns the number of DATA payload in bytes received without + WINDOW_UPDATE transmission for the stream *stream_id*. The local + (receive) window size can be adjusted by + `nghttp2_submit_window_update()`. This function takes into account + that and returns effective data length. In particular, if the + local window size is reduced by submitting negative + window_size_increment with `nghttp2_submit_window_update()`, this + function returns the number of bytes less than actually received. + + If flow control is disabled for that stream, this function returns + 0. + + This function returns -1 if it fails. + +.. function:: int32_t nghttp2_session_get_stream_effective_local_window_size (nghttp2_session *session, int32_t stream_id) + + + Returns the local (receive) window size for the stream + *stream_id*. The local window size can be adjusted by + `nghttp2_submit_window_update()`. This function takes into account + that and returns effective window size. + + This function returns -1 if it fails. + +.. function:: int32_t nghttp2_session_get_effective_recv_data_length (nghttp2_session *session) + + + Returns the number of DATA payload in bytes received without + WINDOW_UPDATE transmission for a connection. The local (receive) + window size can be adjusted by + `nghttp2_submit_window_update()`. This function takes into account + that and returns effective data length. In particular, if the local + window size is reduced by submitting negative window_size_increment + with `nghttp2_submit_window_update()`, this function returns the + number of bytes less than actually received. + + If flow control is disabled for a connection, this function returns + 0. + + This function returns -1 if it fails. + +.. function:: int32_t nghttp2_session_get_effective_local_window_size (nghttp2_session *session) + + + Returns the local (receive) window size for a connection. The local + window size can be adjusted by + `nghttp2_submit_window_update()`. This function takes into account + that and returns effective window size. + + This function returns -1 if it fails. + .. function:: int nghttp2_session_fail_session(nghttp2_session *session, nghttp2_error_code error_code) diff --git a/apiref.html b/apiref.html index 9b3f5d87..1d52679f 100644 --- a/apiref.html +++ b/apiref.html @@ -1820,6 +1820,58 @@ size_t nghttp2_session_get_outbound_queue_size( +
+
+int32_t nghttp2_session_get_stream_effective_recv_data_length(nghttp2_session *session, int32_t stream_id)
+

Returns the number of DATA payload in bytes received without +WINDOW_UPDATE transmission for the stream stream_id. The local +(receive) window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective data length. In particular, if the +local window size is reduced by submitting negative +window_size_increment with nghttp2_submit_window_update(), this +function returns the number of bytes less than actually received.

+

If flow control is disabled for that stream, this function returns +0.

+

This function returns -1 if it fails.

+
+ +
+
+int32_t nghttp2_session_get_stream_effective_local_window_size(nghttp2_session *session, int32_t stream_id)
+

Returns the local (receive) window size for the stream +stream_id. The local window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective window size.

+

This function returns -1 if it fails.

+
+ +
+
+int32_t nghttp2_session_get_effective_recv_data_length(nghttp2_session *session)
+

Returns the number of DATA payload in bytes received without +WINDOW_UPDATE transmission for a connection. The local (receive) +window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective data length. In particular, if the local +window size is reduced by submitting negative window_size_increment +with nghttp2_submit_window_update(), this function returns the +number of bytes less than actually received.

+

If flow control is disabled for a connection, this function returns +0.

+

This function returns -1 if it fails.

+
+ +
+
+int32_t nghttp2_session_get_effective_local_window_size(nghttp2_session *session)
+

Returns the local (receive) window size for a connection. The local +window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective window size.

+

This function returns -1 if it fails.

+
+
int nghttp2_session_fail_session(nghttp2_session *session, nghttp2_error_code error_code)
diff --git a/genindex.html b/genindex.html index b35ba598..c2318b42 100644 --- a/genindex.html +++ b/genindex.html @@ -500,8 +500,6 @@
nghttp2_nv_compare_name (C function)
-
-
nghttp2_on_data_chunk_recv_callback (C type)
@@ -510,6 +508,8 @@
nghttp2_on_data_recv_callback (C type)
+
+
nghttp2_on_data_send_callback (C type)
@@ -751,10 +751,26 @@ +
nghttp2_session_get_effective_local_window_size (C function) +
+ + +
nghttp2_session_get_effective_recv_data_length (C function) +
+ +
nghttp2_session_get_outbound_queue_size (C function)
+
nghttp2_session_get_stream_effective_local_window_size (C function) +
+ + +
nghttp2_session_get_stream_effective_recv_data_length (C function) +
+ +
nghttp2_session_get_stream_user_data (C function)
diff --git a/nghttp2.h.html b/nghttp2.h.html index afc7ee77..eb9ea880 100644 --- a/nghttp2.h.html +++ b/nghttp2.h.html @@ -1606,6 +1606,72 @@ */ size_t nghttp2_session_get_outbound_queue_size(nghttp2_session *session); +/** + * @function + * + * Returns the number of DATA payload in bytes received without + * WINDOW_UPDATE transmission for the stream |stream_id|. The local + * (receive) window size can be adjusted by + * `nghttp2_submit_window_update()`. This function takes into account + * that and returns effective data length. In particular, if the + * local window size is reduced by submitting negative + * window_size_increment with `nghttp2_submit_window_update()`, this + * function returns the number of bytes less than actually received. + * + * If flow control is disabled for that stream, this function returns + * 0. + * + * This function returns -1 if it fails. + */ +int32_t nghttp2_session_get_stream_effective_recv_data_length +(nghttp2_session *session, int32_t stream_id); + +/** + * @function + * + * Returns the local (receive) window size for the stream + * |stream_id|. The local window size can be adjusted by + * `nghttp2_submit_window_update()`. This function takes into account + * that and returns effective window size. + * + * This function returns -1 if it fails. + */ +int32_t nghttp2_session_get_stream_effective_local_window_size +(nghttp2_session *session, int32_t stream_id); + +/** + * @function + * + * Returns the number of DATA payload in bytes received without + * WINDOW_UPDATE transmission for a connection. The local (receive) + * window size can be adjusted by + * `nghttp2_submit_window_update()`. This function takes into account + * that and returns effective data length. In particular, if the local + * window size is reduced by submitting negative window_size_increment + * with `nghttp2_submit_window_update()`, this function returns the + * number of bytes less than actually received. + * + * If flow control is disabled for a connection, this function returns + * 0. + * + * This function returns -1 if it fails. + */ +int32_t nghttp2_session_get_effective_recv_data_length +(nghttp2_session *session); + +/** + * @function + * + * Returns the local (receive) window size for a connection. The local + * window size can be adjusted by + * `nghttp2_submit_window_update()`. This function takes into account + * that and returns effective window size. + * + * This function returns -1 if it fails. + */ +int32_t nghttp2_session_get_effective_local_window_size +(nghttp2_session *session); + /** * @function * diff --git a/objects.inv b/objects.inv index fbd6bbee920012a15e63a6b21c8b4cd5c50d4d86..7ea84ada5d9e4473ecab10a92857d249fcb7cca9 100644 GIT binary patch delta 1928 zcmV;32Y2|?5AqL?fPc%9n>ZBR=PO(_vkg^~Wp=cY-PG_J9_e&8DjH;)3I@W%PUq|A zidRG1L04quvMqshALpKPrE?x9SgnxSaH;jQQR@X^(tSHOs@)ai3uLWCpnQr;SwN!(z({>T7b6lMo_7m}Z z#A-&ySpLCi{N#IH6bDRVb$zgtC|FDAb~Sxj-&0eg|R#b6ql$b)iqSk+=;d%1IS3?-^A}a80p+iqcpFW z)Q9ndVQ>FkV-|7z0MKS&E-WtkwoOgddWIG53?2R$u@3=6 z`~i+@`+qiKtf_uoho)VsU7_OTSK1T+K@68~Cl zwJ4LkOzKyOn%`}I9cI6J@D4uN9L(GEPd4P2K~ z@-B@$*&2bP{oGj^*}(@2=cjL2BWTcQa?2$2;K815`Z7McoKog6DrS zN=97wTgEof8=&V%QPpZcu=XVZ8z}H9Ie#P`vVL_uwePR;ri^%^gqXs0Q{a8wBzE9S zi+E-HnxF&u$qoz+OY~=4Q0c!_$u9-~6P4@?tB}E#l2r}h2{#$8uuP1r6w5evW7NU3 zav;u|7?A5~VEC)_;mZEQd(w^Lsl?J+R?lGgn#Q< z8M**AaU*5T8MCuajbTy`_{I^%S=%s@Y&0Q<-y`dCKr-%otNPR>{{_npw3`6H+l$jQ z@lITCSoPWl$z5}!z=_y9tfj=;9)=Gk#R^Ob)r=)(NPPm*S3wEUn^{oPkM&7{^uFUC z2$&tb2ybZphMhI5MZ!M%Jv!C44}U26s-t3lt6E!PAO^Z*2i#hdkK-e&Y2MT?c>^5m zN5dM{mOGq5M#78~u%kh&N4_!oYzHoug2 z?2_SEJbL>bHWe!oL~B+}fcx04?my#>Z#w_UwQ3ebrnKtGE~whS+^rYP@2Lwq{hRE2 zmS5K%ZT0ZooyQ;>D6&n+yr{*1G;#|eeomJnAtc{k^wz{elS*zNY#XbOw~E7hQKMZs z%)5qJ-Ksj|QQG_rI>fgEM}H>*^^l=mX#&NUX6!0gvhkUE2$OW8_Yv>loL^q;%V^&u z#;>2lirl#juAsK--%3R7TuRG@?=8EQM$2i7RziD^jg_uY%PhJnj%652GSJyhm(diJ zS$kW3QlF`6K!Rz{KkdG_0CD7370@E- zU8_S}1v|6gZdHx(hU>82t(z!`^1ECU%xr-=JTf^VTmrPq5XO7Ro93`eIynxIJ7JZ( zrBHw|-nd^8zNWc|j}I@zChtuXccx1K86fdI30mIDhAY4TlYgp76YP+5O)vUad*~ep z7RTP=^#=h^bes%{5c_YsgRuPM%A_Q<&NB$C1{uLCjzDI2BZPT(2OPb}z^6~h3%J<+ z&27z>VicHr)%?02@)q{|-l|krZ&KkX_H9dvvyN1b#I3)MDqO>)`H5i)5T<8v1q4uc O;;^u!{{cLBBmvxtXT#_K delta 1897 zcmV-v2bTEq57ZBkfPcwyqeu|F_g5%l=4v9^$G%}vvWa0E7Q5Y-3JfKQXao$4)b6jJ zEH;BIQCaGfLlz~na(Ve)Rvq#<$zt|vRn_sgG<;*}>h9~Rc)vUJUnu+fkp8tY^SDXb zO6ULjvSZnWMZ`5eShbk64#}=^{g7YMm=Bk z$twDG2%|DzeO-k`QnGEg`0v%-mu$DM>*AgkO|_>*nIDphDcLb)8DGQ>Z>(Hcl^vC1 zm^KXaY{jZ7$uk;-Y5EpMKPv@3Y|HS#XqMOTbrz4`E&bkfmrq31h)dVD=`8GVSm6=h z*R4lySmvt_27jTR{sZHniq&*(iVZRX1 zM_4nuu4K`1>b5IZEe0VD>ySqKCj0s6=Y&yhtx)zcCSq$tCzcP&7f02flH^D~Xoykb&$Q?ZmqHO<(sn!`?=M|leCwoMk*@D}8j`}}z@ z?DaplY(bn%fN&Xv0}DvLZBtXVUcthRp~DxWrx8KnKj65wZzG;H)$g~#So3yBYI=fJ zlb>i)K!5GCWxo$A_biNASwV9MvEB$QFK`^&^@&EGiR(eh%j71p+MPLp_k`Hl`IZEg zqp7}%_|>i$+rpJE#haRM|2H0LD?wrF#!w%rx>yCHe>>yWhV2mznU)&az#j-BcN-<& z^~EmrDUy(_$ee!BEzN$xW^TnEN&H9LRi+y9;ykvbUp?S`k z#buJ0N&PO-lRMvFYZY?U^@rTBY@ezIXCv4I*}%iRv-_@XNU$knOXQ`%Lx4l7&k?vx zn~Jc6uGPm@A|kurNkNlrn?lynm`U`l4O9=tJwvp4*iruJP<>=b2qz8x6w+AT*MY@O zNPioyM5o)fY?GMS2B-!e!2+}L!Syh1f|%t>%QpBTRApFCsWNhFie$CLQP#6KDocQ$Vc;XoFB` zx)HcUf)wspP4lLH%NsD@zlJq{)yZ#$D}U~mwhbHyC^%Bmw8{&dbxa^*6iDM6S_6<1 zr56jr1?~H)yeT6Nf%CWBq8t+-gJ}|9(V_?uFxAw`_%T5z=8GK|8kYXg7^2dD;xUGO zL?t_b6*7a2l2r}tn)?(7xfAaz#WMb!VTl;0N2)adwj4_H;R6)88W=KCuwvzrm46`O zPB;hjGB^!K)E0#Lv!s{f;i~%>n1GO262s+u>oOrE&sqvNq4h`B959L7={5{p1I5^h zOLG|EAZJ0-ZUW6m4FI`%-q$Bh;AqRj&@=6hgpRaZJOSlo(m+JOB^#i@8a^dQWpmD-L~XrO4kZJ|Q`Pr4 zca8D{#~|^eA3n%;iPxqomK3*@&{hwubZiTy9;U5$8%s#6Stmlcs>_h`*?$!FZ6EC) z@hZuqfX=cZ^JQv_Gv&UH8=wFP1~fxE;2O58`>(jH?jj|b)Yp%iq{lDW5!HZ~nXq7e z&mV4`Zd^SK5^fGwHrdZCKmF-(Ql3E;H4Hxq!44ruON$ymthkwtaLXhlDqNmthudh}5)Mx4dApp%1}E@{R+l<6XbHA%D#1e)gXwNA%Qo zkk}P&ZqoB7{A{K_W$A7JpvfSsiae{3ZSUIk2dwP1Y>P;oSSoyYP$5}>_*4X^BPJPy z@W?nmn6*LM;m(m59tc_g2z1z<)FnpfWDs%$ZCTYw!x#XHj{z1NJO5i0=cUN1#I$zsTJXSnujsYHrdLb zohPFi@IdqA=+`L(mVE-8!IGH{*C*hFBp<}yAhy1EH9}DMonqp`%CjH3gRp0EcW^H= z7V3!uW&|RC#xNOH;f_Cs>qk$4PhZ@d2HNrrwRgn)_!p63{S7