From 4176a23d9521c39003dd578b4188bb72d02816bf Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Thu, 28 Nov 2013 23:42:58 +0900 Subject: [PATCH] Update doc --- _sources/apiref.txt | 17 +++++++++++++++++ apiref.html | 18 ++++++++++++++++++ genindex.html | 8 ++++++-- nghttp2.h.html | 22 ++++++++++++++++++++++ objects.inv | Bin 2119 -> 2115 bytes searchindex.js | 2 +- 6 files changed, 64 insertions(+), 3 deletions(-) diff --git a/_sources/apiref.txt b/_sources/apiref.txt index 2a481d82..6688e149 100644 --- a/_sources/apiref.txt +++ b/_sources/apiref.txt @@ -1626,6 +1626,23 @@ Functions :macro:`NGHTTP2_ERR_NOMEM` Out of memory. +.. function:: int nghttp2_submit_response2(nghttp2_session *session, int32_t stream_id, const nghttp2_nv *nva, size_t nvlen, const nghttp2_data_provider *data_prd) + + + Just like `nghttp2_submit_response()`, but this function takes the + *nva*, which is an array of ``nghttp2_nv`` with *nvlen* elements, + as name/value pairs. This function is useful if name/value pairs + are not NULL-terminated strings. + + This function returns 0 if it succeeds, or one of the following + negative error codes: + + :macro:`NGHTTP2_ERR_INVALID_ARGUMENT` + The *pri* is invalid; or the *nva* includes empty name or + name which contains invalid characters. + :macro:`NGHTTP2_ERR_NOMEM` + Out of memory. + .. function:: int nghttp2_submit_headers(nghttp2_session *session, uint8_t flags, int32_t stream_id, int32_t pri, const char **nv, void *stream_user_data) diff --git a/apiref.html b/apiref.html index a48ef0f9..bf775417 100644 --- a/apiref.html +++ b/apiref.html @@ -2094,6 +2094,24 @@ negative error codes:

+
+
+int nghttp2_submit_response2(nghttp2_session *session, int32_t stream_id, const nghttp2_nv *nva, size_t nvlen, const nghttp2_data_provider *data_prd)
+

Just like nghttp2_submit_response(), but this function takes the +nva, which is an array of nghttp2_nv with nvlen elements, +as name/value pairs. This function is useful if name/value pairs +are not NULL-terminated strings.

+

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

+
+
NGHTTP2_ERR_INVALID_ARGUMENT
+
The pri is invalid; or the nva includes empty name or +name which contains invalid characters.
+
NGHTTP2_ERR_NOMEM
+
Out of memory.
+
+
+
int nghttp2_submit_headers(nghttp2_session *session, uint8_t flags, int32_t stream_id, int32_t pri, const char **nv, void *stream_user_data)
diff --git a/genindex.html b/genindex.html index 125a8ec9..42a2c55b 100644 --- a/genindex.html +++ b/genindex.html @@ -520,12 +520,12 @@
nghttp2_on_frame_not_send_callback (C type)
-
-
nghttp2_on_frame_recv_callback (C type)
+
+
nghttp2_on_frame_recv_parse_error_callback (C type)
@@ -943,6 +943,10 @@ +
nghttp2_submit_response2 (C function) +
+ +
nghttp2_submit_rst_stream (C function)
diff --git a/nghttp2.h.html b/nghttp2.h.html index 1192d60f..c3c2c8f8 100644 --- a/nghttp2.h.html +++ b/nghttp2.h.html @@ -1932,6 +1932,28 @@ int32_t stream_id, const char **nv, const nghttp2_data_provider *data_prd); +/** + * @function + * + * Just like `nghttp2_submit_response()`, but this function takes the + * |nva|, which is an array of ``nghttp2_nv`` with |nvlen| elements, + * as name/value pairs. This function is useful if name/value pairs + * are not NULL-terminated strings. + * + * This function returns 0 if it succeeds, or one of the following + * negative error codes: + * + * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT` + * The |pri| is invalid; or the |nva| includes empty name or + * name which contains invalid characters. + * :enum:`NGHTTP2_ERR_NOMEM` + * Out of memory. + */ +int nghttp2_submit_response2(nghttp2_session *session, + int32_t stream_id, + const nghttp2_nv *nva, size_t nvlen, + const nghttp2_data_provider *data_prd); + /** * @function * diff --git a/objects.inv b/objects.inv index bf6bed764115fa07b7cad347b304a695de8437f6..f04ead7d41edec184ea8abffd62526776bc742e9 100644 GIT binary patch delta 2011 zcmV<12PF8%5W^6Vet)G}OOu;85WeSExN7$rsxrsi7$bYA#o*gG9jBHcEh~?qQ zG@|66w*zl-I z*uoS)eLAr8&Z6$uc181O!NPoZ96#9n);{Jn4{XB&`;;DzWq+AHP@a{vV5OFF8dfEz zJD#R&SH?W0Z?FY_qg57#C0p#ip4jP?<%=(iFpG1xZ(jQM;`1ka{p9=G2TEL*n)Wx{ zG7akax=+NSaF_EtYr6fjsyNat=cl+}T6#`cI<-@`Dm`oGFsT^k*@6{?5N8)A$!oa# zS!nQOpNA(#Q-3amPow@ntdvhgH;7A@&SpCyW4FR1zHi!VuUqEpj~1bx`2(XMFish# zhk~-S%->-_`JSg|}lh{63%eKkVHyyh(ghgzG%zp2{8S?_Xsmxh;(paAJ z9AYWLd1&=|ic8SJe-$gr2UxPN(mDpG0tcKzex~d2ZqA1f?Q8o*kX9y-cP|<zx~( zik294CGTho;NDn%A8 z`Hs&pP=6Z^kCwCiXO3Freh3LW1$ANbtM52;quVcV!j)yhAAJr*BsB4Yt?T#>;@OS< zeO^{>LiRe25OI5CVZ`zRYF&ucMqqovcI&u4G3YnqdXT|Xst&Ph$+m&_gpll7BuQu) zy00VN+5}4-+3K-63rn=0Q5Rb=s#L5jeNFYrD1Yen+Z=9bIUX^vD$x33B0WlPKk!kc zCqJ9E;XGq~xb;K`{qtu zIcwc|7K8++cKyzYY{#d%B~X}wOmHiBSRfkTbu0xGi7c+d%EDr}ly>+XXHXXR2{@7( zLVs96_P`v!v#v0+0;1}J4RIXPHhmLd^8h8{!f7av?QF;fTcY&9Bj~(w0hbv0!5Cbt z@qk$Lhb&1M;=sxl%c|0Zt~g4}+^Nxa&@9K<`gBX6%!@n;HeLpc?VL@Yv1e1vKY zdBU^;m*BCf3R{z7k{V5R&-`H}mrHAXw~vlCbbmV}IOs@8rh;@=FC-!5k-IE6~y%UMxDt`jQ51%K;6 zxmq@zV{eq&SyrvUh(-;>x*k~mEbcn9$D-T@tT8mPjhbVAA+ zCFNE5$}7NNfUYZ6mphz7dN7Y9*S$jQCm|SpaROJsv5g8@!$DYlM@x)bTz}%#5rf73 zbwJjI2v%+#8%4Q>wS6C{wD5yRPX?sw^7AQ-NoK){&v0I+P^cW41f zur+WUwgwS&(WQc~g!i@*RzQptfYzNiu>D@lD9?;09DJD$&>v0}b%g>v<+!H*f*X4^ zKB3l{njqE6Oe#I2@Wk|VLVvQpg+u6+Ql&pr{x)|c*p`H5j)ifAZcJ8WJT2G*zRjfC zss*YqPmMjwk!JGYQ4}ccWur^04-IdHTCvT()=S^Qw5)mJjBbU(G-F^405d8;E{UO> zi++k42*AhbK8%w=2LZ8%U=iy50~IzMM=BksG*X*F;YxIU{-uKVjep6xnj7BYb>&<+ zY)C7x`My=tlzx>%SJ@#CBSlO*l5{$kq9SYU=+F8K)h!4x;|1sfnm?Pi7pzwFF<2pI zN8NM)m*WSKsDf4RUC)t5LObV3<1@NZ-gN=6t@1`FJc4N_R865%LQEH+Q#(ZMr9J6V zFPXTC`O$S5Ec3S=n|~;bgf-DCDUfr8L3CtcUa)Sk_-BypqiKag_fW=6uUaWmD$=K3 zY>jOFe%kHtQGwfm7n%+XhOYAaA2kU_P64`7sjn684e=}lGj?%_@urCjXp)NFDh*9T z2f)WPnsM(p0D$6R2AXzVHBaPKuu%){E?VzzxSs9x{j!V!r++(zzr_8~U6tnos5N8_ z71^Wmi@PIIAJi~Cp+W=O?+p)1RsAx-Q>Utb%u&^b1bs+?`(D6f7QQE32I#vDvC)6i zR~``*NG%Y#o&v6~dB+>%5vEks2FXVSbM++RK?y0#Q{3d05Q#%K$PJlC)<4WGLcN3Q zsEPobr{Fymwp5j(K6)A57m)_nofPUl1wMU7UT((rcy5t_67Im9= tiGw;wvAa$6*ycgc9^SQAba6GHXI@e~0d9H%Q-A|Cla7fa{SS9QyT3u!*TMh* delta 2015 zcmV<52O#*v5XTUZet)f6OLL<*5Wdf^aMkX0sM;LoMvRf}onzp!la`L9Ls_W9WVVI1mX_Qzt) zlO|&eTm1BC&+;pa7R?wpWKJXFx=cx;``Kg zznYG1(I7NKA{NEll3!UP_b;02K#P(e(~24SDPuWirG=rhHoi?A?}-E< zLYhH!CEK3HYWqN{StEcy#&mmV@*nSBr?hG-g>gtQ7JpkhHgQ9+mg|ybXnU?SghO0} zf`q||w?b%V&*RtlO|6Zx0>7(E79R~(mb`>$O>n;4yd2XSwDoVps`?I=?3%od^109i z_fgAqnLs-E@X2E^Ocw9){*XX=n?1y}oV4=IH9?z0;Up7>qOI7<7@HK*;fsZ0R`N?)I?+NR}y(dB#*KE&A1P;z*D#gkPY-)3l z7q;Ui>zxQq0H=yC%9NLB{iZ=yI{jdy6ui_ArB}FKNKHr3Gz*!rR`9T(JfZJ78Z;A$ zmVd%*!UVV+wf~hCfO9|%YNiMID@X?z@uf9{Su}{$5IqQSY}XEL;MF4zCjBUCZedDod!V$Ki7;6@AZViC$E-AB`168h{#Q23b68doj!R8_ZLkf^3Grxech z(B+P|3F(FaK8pkgwp>QOFRFts&;rb(*+W}$9eT#gK56u7iG z7(~K{9%hK<41~2AIiW_7oD&Z2TpfaFm--XP(V*d`{}8Pq=VFf1>$5;=9H# zUh9HHs!!qvQtDg#F<0%PH0YV!D+Fv6r9QQMT!NJwtu<aBorNKv85yz<2u=LQg!RjfLxeb)-O2IvrjmIC_7=2B-*vU`=2FIFIMs z;WI8`I{W=^0i)dw%1@|1*MEGMU$MStGB`hj&6@m2&R=gG)%A(En;Icgsc!QUYG^f7 z4kSUDLC2zK6qo0X&b=};#}o=ecFQh?<1xMkIA|46U5C(QDbzyv0$>#7$k5rvX(qqm z_7I$0ZS%_#U1vg`COSQtJkcGnATKqvM_6ij(zL8aHef%buG$%F+<%?bsDp=wNC%!e zLN~>}j1x_MH#zBihC>BcS4&aTff%!%fjXlLQriup)r#InE4|4G(zLR%t_GElZ?Pcz zHb$PF(CuPbPb(V67h{qRMzpvC+wH{FrBiR%*4u_c0^>3AmPA$Xyh8Q{Ke{A>EoNQM zB^rZEL)??7kgbA|mwy*=Sur{O`aQz)QEMJcNJpT7&~M)$Q1bF2i((P4_vCp;zQ&8+ z4|34lcr^S&YW_9O>$aJT)0PB4^FiaH3ol}@sHEFE48yj%3FB9wOk%jNLA|fv-%_A_ zuX;2>_8y1t)b`0|+Dt$sA+0Rhs~vZRYw&Bmn~w5YR>7cbv0In z9w|t~#&v63K`lEF{$OEyuJNAfb>LO~nt6Q4I9Q901_64bT)q1Z1vtf-Y!>lb#rX z+Z#+1{(Q|-lUUUA92C^&E)61E xo720tT0OoI5L4`KbFQjKgD