From 3aba7fdd8364eac936e77490cba6afe0e119e8c0 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sat, 14 Sep 2013 19:44:21 +0900 Subject: [PATCH] Update doc --- _sources/apiref.txt | 18 ++++++++++++++++++ apiref.html | 20 ++++++++++++++++++++ genindex.html | 8 ++++++-- nghttp2.h.html | 20 +++++++++++++++++++- objects.inv | Bin 1917 -> 1926 bytes searchindex.js | 2 +- 6 files changed, 64 insertions(+), 4 deletions(-) diff --git a/_sources/apiref.txt b/_sources/apiref.txt index 64bd5700..b3c52b4a 100644 --- a/_sources/apiref.txt +++ b/_sources/apiref.txt @@ -411,6 +411,20 @@ Enums connection automatically. If this option is set, the application is responsible for sending WINDOW_UPDATE with stream ID 0 using `nghttp2_submit_window_update`. + .. macro:: NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS + + (``3``) + This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of + remote endpoint as if it is received in SETTINGS frame. Without + specifying this option, before the local endpoint receives + SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote + endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may + cause problem if local endpoint submits lots of requests + initially and sending them at once to the remote peer may lead to + the rejection of some requests. Specifying this option to the + sensible value, say 100, may avoid this kind of issue. This value + will be overwritten if the local endpoint receives + SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint. @@ -1059,6 +1073,10 @@ Functions sending WINDOW_UPDATE using `nghttp2_submit_window_update`. This option defaults to 0. + :macro:`NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS` + The *optval* must be a pointer to ``ssize_t``. It is an error + if *\*optval* is 0 or negative. + This function returns 0 if it succeeds, or one of the following negative error codes: diff --git a/apiref.html b/apiref.html index 8ef29c4f..59d14269 100644 --- a/apiref.html +++ b/apiref.html @@ -657,6 +657,23 @@ is responsible for sending WINDOW_UPDATE with stream ID 0 using nghttp2_submit_window_update().

+
+
+NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMSΒΆ
+

(3) +This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of +remote endpoint as if it is received in SETTINGS frame. Without +specifying this option, before the local endpoint receives +SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote +endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may +cause problem if local endpoint submits lots of requests +initially and sending them at once to the remote peer may lead to +the rejection of some requests. Specifying this option to the +sensible value, say 100, may avoid this kind of issue. This value +will be overwritten if the local endpoint receives +SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint.

+
+ @@ -1492,6 +1509,9 @@ nonzero, the library will not send WINDOW_UPDATE for connection automatically. Therefore, the application is responsible for sending WINDOW_UPDATE using nghttp2_submit_window_update(). This option defaults to 0. +
NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS
+
The optval must be a pointer to ssize_t. It is an error +if *optval is 0 or negative.

This function returns 0 if it succeeds, or one of the following negative error codes:

diff --git a/genindex.html b/genindex.html index b22b6394..7c733e00 100644 --- a/genindex.html +++ b/genindex.html @@ -480,12 +480,12 @@
nghttp2_nv_compare_name (C function)
- -
nghttp2_on_data_chunk_recv_callback (C type)
+
+
nghttp2_on_data_recv_callback (C type)
@@ -539,6 +539,10 @@ +
NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS (C macro) +
+ +
nghttp2_pack_settings_payload (C function)
diff --git a/nghttp2.h.html b/nghttp2.h.html index a1482c1b..db014279 100644 --- a/nghttp2.h.html +++ b/nghttp2.h.html @@ -1258,7 +1258,21 @@ * is responsible for sending WINDOW_UPDATE with stream ID 0 using * `nghttp2_submit_window_update`. */ - NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE = 2 + NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE = 2, + /** + * This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of + * remote endpoint as if it is received in SETTINGS frame. Without + * specifying this option, before the local endpoint receives + * SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote + * endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may + * cause problem if local endpoint submits lots of requests + * initially and sending them at once to the remote peer may lead to + * the rejection of some requests. Specifying this option to the + * sensible value, say 100, may avoid this kind of issue. This value + * will be overwritten if the local endpoint receives + * SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint. + */ + NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS = 3 } nghttp2_opt; /** @@ -1286,6 +1300,10 @@ * sending WINDOW_UPDATE using * `nghttp2_submit_window_update`. This option defaults to 0. * + * :enum:`NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS` + * The |optval| must be a pointer to ``ssize_t``. It is an error + * if |*optval| is 0 or negative. + * * This function returns 0 if it succeeds, or one of the following * negative error codes: * diff --git a/objects.inv b/objects.inv index f6fdbf3b8a7a7fbd5325c891c359487bc0281ee4..d85a4718a0d01fd04d042d0098be3dc473f98b70 100644 GIT binary patch delta 1818 zcmV+#2j%$v4u%hqfq#>mI1s+)SGa2T8mcnK+!!N!s9<1uWHPy^FvvC)41|ZB$*i^sAXqT2OD8j>ZVf(*sncFU~gFX9Tu3tRQet)9Gaj0&7RSjLEuBUor z5q>@fVUaC9ErL8Q*sk6D_u}JZ&&p9ZgnE`m4b@rC?MnBDs>+{edQwh7QZv4k9k;BQ zSzEHQjI)%6L6U5P@JFe@hg}gI8BMbazD}dzySd*R-}r^78gb~-+SrKOmaMAcbYD`I zR>eDPsNQonbAN(vdc-kRgCAu%2qoH%P7UjoxE|s*gY*RpPh-jdaI1b_UY7@&7uhi` znUbComOiZgD5wG&9_sYR%_W5DUm5C}+LpOSh}y`h93sr`E)AWS9+=cL$o$O;-}5zdY4?J=%EUw=PqR#s22Wml(R1-hNH8MvMJ zPQ8sHi1XQ>y%*?B@S+tYFvi4iw7Ir0TBfMu5OqU!4HcDlJhL?o4U?>7D7U=)TEfDL zrtDY6gQUvB>;YwVF86F$%P)_JAhtCiX9~K-0-fzxo`tzd>z!xFB-xqPIYcU}jv z!CQCY(y&~jp`mj?HSzBg&(qDdOE>B_M8<+u^i?-C>y^6tcZ?1?KLKB_*gh)|P&*UO zf}Im&7J}!LKM0n$dd-VCE8^-MjfF}l{$nY3%YSxR!8%`ki12`?I$rNYrsYx9;DkfN zGCWw!Q>*7#h6G_kW(#g*ZZRC-?0?5OjniEMjwF}zRsac@>-W~>W|m0pL$D#Pqno;? z14A6q6}3-#Aj8CR4OQ=_);zVP7M z=q@%3^_*CB*8T>Zw|{U785*{drRGfITRJZcB@K?min}s{?yZgO5Vwg5 zEH7_DuE{j8)3!{P$WbR{7s+&7$FvetU$%|TBpCJ~^HX=;rP4>#fxJY4ibnN;&34s! z$1r?b!!?)Ml;204Ok8uX?j)>BRv?(vw2ANNmZN)bxS2(3zyB=)r0bsagn!EJ^Nd=s zzauATSg6wFv`%0brlpMYD z3T>Hw-#JLDrc6T)Yo-IX0NNg;`}1g* z>n7pyTyy`Wg!fHLSUESmrGK^3AU5uOO4PhV$D_@kGMBFNeGx=VE^sE2&Vw8(Le`f0 zs=iUxfI!jSfK{6wx;SZ$#s0_$U%(h~T|<3&Kd~TIy+hk}j699o$wZ zd_$!hhO|R!`~8G2KdA{*d+dQ;aD?TjRsB7(X?<20J3;6c0Fy7n}4(CAn}D{<-vQBi3n_eAU5J|+LRL_58({a;!1Q^8lHWI*u~O} zt_OArcswx_JHza-T@Z;aQ9*K(^>-cf`f&8(>>$&J=+d(6L>=v(Bh+zUe2=~&UpiuY z2DiykD)k~70?kV*>^sQG^F66f(kK;B7LLDH;lStm=pX5hVR%^Xs>H z3M85NM!P4M?HOkJ@pXUQJ;x*n=zI{Bl|4r&2OrqFPP)1 zt~T3#Ir`fynSGl1X_)a{v-$7Y$I+gpt*$lZS{5@@do{Hy-XDr0{mkN%a`K~+S4;Wv zg=Z6MbDrm660@xzMKAvLXRgpMyUagw7AFP$I}ZB)O?_{8<3~+hXf~T$>kV+*oEJqH z?{miEB736^#eZAMCr;2!SF=sksE)F1K#3b$XNL8pIWBOUUiyr0PeaMyxmC9>E%O6Q zv*Z}&T!~K+kMGug;1@pI9?JOV)g^@LUmEI)Z7g#Ih+50390KIKb3@lmmrQD!+T7JG zvoo@xnZQx|#DDeQ#9GX9a=9Yo{!!ssmSk+31ehC_FMr3dAbtHRd0u>`ExR(_7NpxL zn~~dz@6_2SAe>Kr_7>1<@WKib7-M8OR$p6)mT}avHFeGO1%%2Qp4pg&ZKEXTkXxR= z7V&MtV*b0RKvE>z0T0bFQFZe#m zfKWRDXTi=-g#g53W z?M^Aov|Oed6+2m=bdVNTdDyirLxNp_siks>%Dh-~+W!et7RI}XyiP7ZE-8K>*YB)b znOTAd^vDFRqno;`6P+Az8w`6xc}#1qt>M6Nra6dAq~JuUvu3qP%59^NNHwM1SGjB> zP=9tOxM>MF_>~*R;R%so6w@(^TA5*?E$Igo!iOi|B=8&vVC-L~azSx06v)-ql*%jb zq$u&A&c70Jbi=bXod3wMZgD`bDNn~Mh)RM5KwZ<2wof7HK%t}L;%0}@DlrmH=N=i^ z?1HF+o}VXWwyi2VUnb4mWWpg4vM3DRsecs#fDUV3rT;aAJ^jh@j0MVsN90avf6K!^ zoaESM{7AQu2`d@TOOm?MDHc}-+E>!)5O&3wI@8O=T3A~EJLn>_2>Zad*i&8IGwr($ zx$s;y=b8a5w6<+Z#=?s>tIvVV9Eb6oK`DNkRtxsG32hn*irgW4JprsB`?m9@<1Gz{?j zSJ;(n2Vq&OzW-dp`^HtNoPQf$lT_)DG;Cf-VsO1WSL<6zyP_i{83knV zr0Q}YAU7pXN#ZkUN`L*gC=n6T?m!fASDnNWF()_^S{#YqN6njG3A-q5XggGAz~e+u z>