iv-org-mirror/litespeed-quic
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/litespeed-quic.git synced 2024-08-15 00:53:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Latest changes

Browse source 
- [API Change] Sendfile-like functionality is gone.  The stream no
  longer opens files and deals with file descriptors.  (Among other
  things, this makes the code more portable.)  Three writing functions
  are provided:

    lsquic_stream_write
    lsquic_stream_writev
    lsquic_stream_writef    (NEW)

  lsquic_stream_writef() is given an abstract reader that has function
  pointers for size() and read() functions which the user can implement.
  This is the most flexible way.  lsquic_stream_write() and
  lsquic_stream_writev() are now both implemented as wrappers around
  lsquic_stream_writef().

- [OPTIMIZATION] When writing to stream, be it within or without the
  on_write() callback, place data directly into packet buffer,
  bypassing auxiliary data structures.  This reduces amount of memory
  required, for the amount of data that can be written is limited
  by the congestion window.

  To support writes outside the on_write() callback, we keep N
  outgoing packet buffers per connection which can be written to
  by any stream.  One half of these are reserved for the highest
  priority stream(s), the other half for all other streams.  This way,
  low-priority streams cannot write instead of high-priority streams
  and, on the other hand, low-priority streams get a chance to send
  their packets out.

  The algorithm is as follows:

  - When user writes to stream outside of the callback:
    - If this is the highest priority stream, place it onto the
      reserved N/2 queue or fail.
        (The actual size of this queue is dynamic -- MAX(N/2, CWND) --
         rather than N/2, allowing high-priority streams to write as
         much as can be sent.)
    - If the stream is not the highest priority, try to place the
      data onto the reserved N/2 queue or fail.
  - When tick occurs *and* more packets can be scheduled:
    - Transfer packets from the high N/2 queue to the scheduled
      queue.
    - If more scheduling is allowed:
      - Call on_write callbacks for highest-priority streams,
        placing resulting packets directly onto the scheduled queue.
    - If more scheduling is allowed:
      - Transfer packets from the low N/2 queue to the scheduled
        queue.
    - If more scheduling is allowed:
      - Call on_write callbacks for non-highest-priority streams,
        placing resulting packets directly onto the scheduled queue

  The number N is currently 20, but it could be varied based on
  resource usage.

- If stream is created due to incoming headers, make headers readable
  from on_new.

- Outgoing packets are no longer marked non-writeable to prevent placing
  more than one STREAM frame from the same stream into a single packet.
  This property is maintained via code flow and an explicit check.
  Packets for stream data are allocated using a special function.

- STREAM frame elision is cheaper, as we only perform it if a reset
  stream has outgoing packets referencing it.

- lsquic_packet_out_t is smaller, as stream_rec elements are now
  inside a union.
This commit is contained in:
Dmitri Tikhonov 2017-10-31 09:35:58 -04:00
parent 0ae3fccd17
commit c51ce3387f
94 changed files with 4769 additions and 3321 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/html/annotated.html
View file

@ -94,7 +94,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlsquic__logger__if.html" target="_self">lsquic_logger_if</a></td><td class="desc"></td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlsquic__out__spec.html" target="_self">lsquic_out_spec</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlsquic__packout__mem__if.html" target="_self">lsquic_packout_mem_if</a></td><td class="desc"></td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlsquic__stream__if.html" target="_self">lsquic_stream_if</a></td><td class="desc">The definition of callback functions call by lsquic_stream to process events </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlsquic__reader.html" target="_self">lsquic_reader</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlsquic__stream__if.html" target="_self">lsquic_stream_if</a></td><td class="desc">The definition of callback functions call by lsquic_stream to process events </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->

8
docs/html/classes.html
View file

@ -88,10 +88,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="qindex"><a class="qindex" href="#letter_L">L</a></div>
<table class="classindex">
<tr><td rowspan="2" valign="bottom"><a name="letter_l"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;l&#160;&#160;</div></td></tr></table>
</td><td valign="top"><a class="el" href="structlsquic__engine__settings.html">lsquic_engine_settings</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__http__headers.html">lsquic_http_headers</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__out__spec.html">lsquic_out_spec</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__stream__if.html">lsquic_stream_if</a>&#160;&#160;&#160;</td></tr>
<tr><td valign="top"><a class="el" href="structlsquic__http__header.html">lsquic_http_header</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__logger__if.html">lsquic_logger_if</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__packout__mem__if.html">lsquic_packout_mem_if</a>&#160;&#160;&#160;</td><td></td></tr>
<tr><td valign="top"><a class="el" href="structlsquic__engine__api.html">lsquic_engine_api</a>&#160;&#160;&#160;</td><td></td><td></td><td></td><td></td></tr>
<tr><td></td><td></td><td></td><td></td><td></td></tr>
</td><td valign="top"><a class="el" href="structlsquic__engine__settings.html">lsquic_engine_settings</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__logger__if.html">lsquic_logger_if</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__reader.html">lsquic_reader</a>&#160;&#160;&#160;</td></tr>
<tr><td valign="top"><a class="el" href="structlsquic__http__header.html">lsquic_http_header</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__out__spec.html">lsquic_out_spec</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__stream__if.html">lsquic_stream_if</a>&#160;&#160;&#160;</td></tr>
<tr><td valign="top"><a class="el" href="structlsquic__engine__api.html">lsquic_engine_api</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__http__headers.html">lsquic_http_headers</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structlsquic__packout__mem__if.html">lsquic_packout_mem_if</a>&#160;&#160;&#160;</td><td></td></tr>
<tr><td></td><td></td><td></td><td></td></tr>
</table>
<div class="qindex"><a class="qindex" href="#letter_L">L</a></div>
</div><!-- contents -->

6
docs/html/functions.html
View file

@ -151,6 +151,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>es_versions
: <a class="el" href="structlsquic__engine__settings.html#a9dca1ee29ab43ca9454b6b0a8d5e2799">lsquic_engine_settings</a>
</li>
<li>lsqr_read
: <a class="el" href="structlsquic__reader.html#ae6a68ebf2a1fb77160b0bac599d42790">lsquic_reader</a>
</li>
<li>lsqr_size
: <a class="el" href="structlsquic__reader.html#aaf6c91ecaf35ca6faa39dde9ea401f17">lsquic_reader</a>
</li>
<li>on_goaway_received
: <a class="el" href="structlsquic__stream__if.html#afdab3bce65931517452d2ddd979596d7">lsquic_stream_if</a>
</li>

6
docs/html/functions_vars.html
View file

@ -151,6 +151,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>es_versions
: <a class="el" href="structlsquic__engine__settings.html#a9dca1ee29ab43ca9454b6b0a8d5e2799">lsquic_engine_settings</a>
</li>
<li>lsqr_read
: <a class="el" href="structlsquic__reader.html#ae6a68ebf2a1fb77160b0bac599d42790">lsquic_reader</a>
</li>
<li>lsqr_size
: <a class="el" href="structlsquic__reader.html#aaf6c91ecaf35ca6faa39dde9ea401f17">lsquic_reader</a>
</li>
<li>on_goaway_received
: <a class="el" href="structlsquic__stream__if.html#afdab3bce65931517452d2ddd979596d7">lsquic_stream_if</a>
</li>

13
docs/html/globals.html
View file

@ -278,6 +278,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>lsquic_stream_ctx_t
: <a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_types.h</a>
</li>
<li>lsquic_stream_flush()
: <a class="el" href="lsquic_8h.html#abcf25d8301c4a2796ea13e6e306a33a9">lsquic.h</a>
</li>
<li>lsquic_stream_get_ctx()
: <a class="el" href="lsquic_8h.html#a26335cffe38e49a6e87d94967371150d">lsquic.h</a>
</li>
@ -296,9 +299,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>lsquic_stream_refuse_push()
: <a class="el" href="lsquic_8h.html#ada61e01ced7a7db11e5c503409c565be">lsquic.h</a>
</li>
<li>lsquic_stream_sendfile()
: <a class="el" href="lsquic_8h.html#a1700c950ace4e560d225b474a5e44d58">lsquic.h</a>
</li>
<li>lsquic_stream_set_priority()
: <a class="el" href="lsquic_8h.html#aa5e0ddfd53a44561248a286caacbd114">lsquic.h</a>
</li>
@ -311,11 +311,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>lsquic_stream_write()
: <a class="el" href="lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a">lsquic.h</a>
</li>
<li>lsquic_stream_write_avail()
: <a class="el" href="lsquic_8h.html#a97229544d7aaf6c5dcd5e071613f9c8f">lsquic.h</a>
</li>
<li>lsquic_stream_write_file()
: <a class="el" href="lsquic_8h.html#af5b85bb360eb8316fd663d7c5bc149c9">lsquic.h</a>
<li>lsquic_stream_writef()
: <a class="el" href="lsquic_8h.html#a49f11caabdf3638d3a3217ebdd21c3af">lsquic.h</a>
</li>
<li>LSQUIC_SUPPORTED_VERSIONS
: <a class="el" href="lsquic_8h.html#a0420e68d347462080cf2e583b77d61a0">lsquic.h</a>

13
docs/html/globals_func.html
View file

@ -188,6 +188,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>lsquic_stream_conn()
: <a class="el" href="lsquic_8h.html#a177184b3d7178dda5a3e95e539230b2b">lsquic.h</a>
</li>
<li>lsquic_stream_flush()
: <a class="el" href="lsquic_8h.html#abcf25d8301c4a2796ea13e6e306a33a9">lsquic.h</a>
</li>
<li>lsquic_stream_get_ctx()
: <a class="el" href="lsquic_8h.html#a26335cffe38e49a6e87d94967371150d">lsquic.h</a>
</li>
@ -206,9 +209,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>lsquic_stream_refuse_push()
: <a class="el" href="lsquic_8h.html#ada61e01ced7a7db11e5c503409c565be">lsquic.h</a>
</li>
<li>lsquic_stream_sendfile()
: <a class="el" href="lsquic_8h.html#a1700c950ace4e560d225b474a5e44d58">lsquic.h</a>
</li>
<li>lsquic_stream_set_priority()
: <a class="el" href="lsquic_8h.html#aa5e0ddfd53a44561248a286caacbd114">lsquic.h</a>
</li>
@ -218,11 +218,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>lsquic_stream_write()
: <a class="el" href="lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a">lsquic.h</a>
</li>
<li>lsquic_stream_write_avail()
: <a class="el" href="lsquic_8h.html#a97229544d7aaf6c5dcd5e071613f9c8f">lsquic.h</a>
</li>
<li>lsquic_stream_write_file()
: <a class="el" href="lsquic_8h.html#af5b85bb360eb8316fd663d7c5bc149c9">lsquic.h</a>
<li>lsquic_stream_writef()
: <a class="el" href="lsquic_8h.html#a49f11caabdf3638d3a3217ebdd21c3af">lsquic.h</a>
</li>
</ul>
</div><!-- contents -->

113
docs/html/lsquic_8h.html
View file

@ -123,6 +123,8 @@ Data Structures</h2></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__engine__api.html">lsquic_engine_api</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__reader.html">lsquic_reader</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__http__header.html">lsquic_http_header</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__http__headers.html">lsquic_http_headers</a></td></tr>
@ -302,19 +304,14 @@ ssize_t&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_stream_read
<tr class="memitem:a96da64e3694d9b79038ec7ada318bb4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96da64e3694d9b79038ec7ada318bb4f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_stream_wantwrite</b> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, int is_want)</td></tr>
<tr class="separator:a96da64e3694d9b79038ec7ada318bb4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97229544d7aaf6c5dcd5e071613f9c8f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lsquic_8h.html#a97229544d7aaf6c5dcd5e071613f9c8f">lsquic_stream_write_avail</a> (const <a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s)</td></tr>
<tr class="separator:a97229544d7aaf6c5dcd5e071613f9c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1071b7be4f2f28c5fedf957aa6309f9a"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a">lsquic_stream_write</a> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, const void *buf, size_t len)</td></tr>
<tr class="separator:a1071b7be4f2f28c5fedf957aa6309f9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5b85bb360eb8316fd663d7c5bc149c9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lsquic_8h.html#af5b85bb360eb8316fd663d7c5bc149c9">lsquic_stream_write_file</a> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, const char *filename)</td></tr>
<tr class="separator:af5b85bb360eb8316fd663d7c5bc149c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a715b914c55b5e534cf75713353eb1589"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a715b914c55b5e534cf75713353eb1589"></a>
ssize_t&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_stream_writev</b> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, const struct iovec *vec, int count)</td></tr>
<tr class="separator:a715b914c55b5e534cf75713353eb1589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1700c950ace4e560d225b474a5e44d58"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lsquic_8h.html#a1700c950ace4e560d225b474a5e44d58">lsquic_stream_sendfile</a> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, int fdSrc, off_t off, size_t size)</td></tr>
<tr class="separator:a1700c950ace4e560d225b474a5e44d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcf25d8301c4a2796ea13e6e306a33a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcf25d8301c4a2796ea13e6e306a33a9"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_stream_flush</b> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s)</td></tr>
<tr class="memitem:a49f11caabdf3638d3a3217ebdd21c3af"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lsquic_8h.html#a49f11caabdf3638d3a3217ebdd21c3af">lsquic_stream_writef</a> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *, struct <a class="el" href="structlsquic__reader.html">lsquic_reader</a> *)</td></tr>
<tr class="separator:a49f11caabdf3638d3a3217ebdd21c3af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcf25d8301c4a2796ea13e6e306a33a9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lsquic_8h.html#abcf25d8301c4a2796ea13e6e306a33a9">lsquic_stream_flush</a> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s)</td></tr>
<tr class="separator:abcf25d8301c4a2796ea13e6e306a33a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae523cf75e48b86f5c4510b429b332acb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae523cf75e48b86f5c4510b429b332acb"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_stream_send_headers</b> (<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, const <a class="el" href="lsquic__types_8h.html#a91f399fbcccaf01b47ca209c5c170ba2">lsquic_http_headers_t</a> *h, int eos)</td></tr>
@ -1399,6 +1396,30 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_conn_get_sockad
</div><div class="memdoc">
<p>Get a pointer to the connection object. Use it with lsquic_conn_* functions. </p>
</div>
</div>
<a class="anchor" id="abcf25d8301c4a2796ea13e6e306a33a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lsquic_stream_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush any buffered data. This triggers packetizing even a single byte into a separate frame. Flushing a closed stream is an error.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success </td></tr>
<tr><td class="paramname">-1</td><td>Failure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a26335cffe38e49a6e87d94967371150d"></a>
@ -1540,45 +1561,6 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_conn_get_sockad
<p>No need to call lsquic_stream_close() after this. on_close will be called.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="lsquic_8h.html#a199b551bc87bb77814ab4ce58abcdff9">lsquic_stream_is_pushed</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1700c950ace4e560d225b474a5e44d58"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lsquic_stream_sendfile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fdSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t&#160;</td>
<td class="paramname"><em>off</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns 0 if `fdSrc' was queued for writing, -1 on error. This function queues at most `size' bytes to be written. If the file shrinks, fewer bytes are written. </p>
</div>
</div>
<a class="anchor" id="aa5e0ddfd53a44561248a286caacbd114"></a>
@ -1671,42 +1653,25 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_conn_get_sockad
</tr>
</table>
</div><div class="memdoc">
<p>Write `len' bytes to the stream. Returns number of bytes written, which may be smaller that `len'. Use <a class="el" href="lsquic_8h.html#a97229544d7aaf6c5dcd5e071613f9c8f">lsquic_stream_write_avail()</a> to find out maximum size of `len'. </p>
<p>Write `len' bytes to the stream. Returns number of bytes written, which may be smaller that `len'. </p>
</div>
</div>
<a class="anchor" id="a97229544d7aaf6c5dcd5e071613f9c8f"></a>
<a class="anchor" id="a49f11caabdf3638d3a3217ebdd21c3af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t lsquic_stream_write_avail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return maximum number of bytes <a class="el" href="lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a">lsquic_stream_write()</a> will write. This call is useful if you don't want to perform your own buffering. </p>
</div>
</div>
<a class="anchor" id="af5b85bb360eb8316fd663d7c5bc149c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lsquic_stream_write_file </td>
<td class="memname">ssize_t lsquic_stream_writef </td>
<td>(</td>
<td class="paramtype"><a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>&#160;</td>
<td class="paramtype">struct <a class="el" href="structlsquic__reader.html">lsquic_reader</a> *&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
@ -1715,7 +1680,13 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>lsquic_conn_get_sockad
</tr>
</table>
</div><div class="memdoc">
<p>Returns 0 if `filename' was queued for writing, -1 on error. This function queues the size of the file as it was when the function was called. The stream will write at most this number of bytes to the peer. If the file grows, appended data is not used. </p>
<p>Write to stream using <a class="el" href="structlsquic__reader.html">lsquic_reader</a>. This is the most generic of the write functions &ndash; <a class="el" href="lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a">lsquic_stream_write()</a> and lsquic_stream_writev() utilize the same mechanism.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">Number</td><td>of bytes written or -1 on error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>

26
docs/html/lsquic_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/lsquic__types_8h_source.html
View file

@ -91,7 +91,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<a href="lsquic__types_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (c) 2017 LiteSpeed Technologies Inc. See LICENSE. */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#ifndef __LSQUIC_TYPES_H__</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#define __LSQUIC_TYPES_H__</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#acf675534bad01d31b48d9113feff1bbb"> 15</a></span>&#160;<span class="keyword">typedef</span> uint64_t <a class="code" href="lsquic__types_8h.html#acf675534bad01d31b48d9113feff1bbb">lsquic_cid_t</a>;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#a41d83b8270d6f12d2812203a7614b55f"> 18</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>lsquic_engine <a class="code" href="lsquic__types_8h.html#a41d83b8270d6f12d2812203a7614b55f">lsquic_engine_t</a>;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036"> 21</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>lsquic_conn <a class="code" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a>;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#a21c289bcbb4643effba8bb75eeffd8cd"> 24</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>lsquic_conn_ctx <a class="code" href="lsquic__types_8h.html#a21c289bcbb4643effba8bb75eeffd8cd">lsquic_conn_ctx_t</a>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6"> 27</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>lsquic_stream <a class="code" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3"> 30</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>lsquic_stream_ctx <a class="code" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="lsquic__types_8h.html#a91f399fbcccaf01b47ca209c5c170ba2"> 33</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structlsquic__http__headers.html">lsquic_http_headers</a> <a class="code" href="structlsquic__http__headers.html">lsquic_http_headers_t</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="lsquic__types_8h_html_acf675534bad01d31b48d9113feff1bbb"><div class="ttname"><a href="lsquic__types_8h.html#acf675534bad01d31b48d9113feff1bbb">lsquic_cid_t</a></div><div class="ttdeci">uint64_t lsquic_cid_t</div><div class="ttdef"><b>Definition:</b> lsquic_types.h:15</div></div>
<div class="ttc" id="lsquic__types_8h_html_a7e5d9c467ebef6810d3c5100e4684036"><div class="ttname"><a href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a></div><div class="ttdeci">struct lsquic_conn lsquic_conn_t</div><div class="ttdef"><b>Definition:</b> lsquic_types.h:21</div></div>
<div class="ttc" id="lsquic__types_8h_html_a41d83b8270d6f12d2812203a7614b55f"><div class="ttname"><a href="lsquic__types_8h.html#a41d83b8270d6f12d2812203a7614b55f">lsquic_engine_t</a></div><div class="ttdeci">struct lsquic_engine lsquic_engine_t</div><div class="ttdef"><b>Definition:</b> lsquic_types.h:18</div></div>
<div class="ttc" id="structlsquic__http__headers_html"><div class="ttname"><a href="structlsquic__http__headers.html">lsquic_http_headers</a></div><div class="ttdef"><b>Definition:</b> lsquic.h:641</div></div>
<div class="ttc" id="structlsquic__http__headers_html"><div class="ttname"><a href="structlsquic__http__headers.html">lsquic_http_headers</a></div><div class="ttdef"><b>Definition:</b> lsquic.h:656</div></div>
<div class="ttc" id="lsquic__types_8h_html_a21c289bcbb4643effba8bb75eeffd8cd"><div class="ttname"><a href="lsquic__types_8h.html#a21c289bcbb4643effba8bb75eeffd8cd">lsquic_conn_ctx_t</a></div><div class="ttdeci">struct lsquic_conn_ctx lsquic_conn_ctx_t</div><div class="ttdef"><b>Definition:</b> lsquic_types.h:24</div></div>
<div class="ttc" id="lsquic__types_8h_html_a4012fdeb11382d691dfe5f025206b8f3"><div class="ttname"><a href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a></div><div class="ttdeci">struct lsquic_stream_ctx lsquic_stream_ctx_t</div><div class="ttdef"><b>Definition:</b> lsquic_types.h:30</div></div>
<div class="ttc" id="lsquic__types_8h_html_ad286bcdd799bb3733f1d6568e25c57c6"><div class="ttname"><a href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a></div><div class="ttdeci">struct lsquic_stream lsquic_stream_t</div><div class="ttdef"><b>Definition:</b> lsquic_types.h:27</div></div>

8
docs/html/search/all_1.js
View file

@ -7,6 +7,8 @@ var searchData=
['llts_5fyyyymmdd_5fhhmmssms',['LLTS_YYYYMMDD_HHMMSSMS',['../lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235a8754c3fced294cfb146625c586a55a56',1,'lsquic.h']]],
['lseng_5fhttp',['LSENG_HTTP',['../lsquic_8h.html#a8f395ac69797c7be8d9d524d464e7ed2',1,'lsquic.h']]],
['lseng_5fserver',['LSENG_SERVER',['../lsquic_8h.html#abaf1fe07c4f99aa36d3d5502bbfc371d',1,'lsquic.h']]],
['lsqr_5fread',['lsqr_read',['../structlsquic__reader.html#ae6a68ebf2a1fb77160b0bac599d42790',1,'lsquic_reader']]],
['lsqr_5fsize',['lsqr_size',['../structlsquic__reader.html#aaf6c91ecaf35ca6faa39dde9ea401f17',1,'lsquic_reader']]],
['lsquic_2eh',['lsquic.h',['../lsquic_8h.html',1,'']]],
['lsquic_5fcid_5ft',['lsquic_cid_t',['../lsquic__types_8h.html#acf675534bad01d31b48d9113feff1bbb',1,'lsquic_types.h']]],
['lsquic_5fconn_5fabort',['lsquic_conn_abort',['../lsquic_8h.html#a6da1350d78db9a83810a00dcee3e4944',1,'lsquic.h']]],
@ -64,10 +66,12 @@ var searchData=
['lsquic_5fout_5fspec',['lsquic_out_spec',['../structlsquic__out__spec.html',1,'']]],
['lsquic_5fpackets_5fout_5ff',['lsquic_packets_out_f',['../lsquic_8h.html#aade9ff8d34cbcb33cd04a41377797fcf',1,'lsquic.h']]],
['lsquic_5fpackout_5fmem_5fif',['lsquic_packout_mem_if',['../structlsquic__packout__mem__if.html',1,'']]],
['lsquic_5freader',['lsquic_reader',['../structlsquic__reader.html',1,'']]],
['lsquic_5fset_5flog_5flevel',['lsquic_set_log_level',['../lsquic_8h.html#a337f6adcc4ec9328e0f293d6128ee376',1,'lsquic.h']]],
['lsquic_5fstr2ver',['lsquic_str2ver',['../lsquic_8h.html#a8fef45d333b115d996080bb254077d8d',1,'lsquic.h']]],
['lsquic_5fstream_5fconn',['lsquic_stream_conn',['../lsquic_8h.html#a177184b3d7178dda5a3e95e539230b2b',1,'lsquic.h']]],
['lsquic_5fstream_5fctx_5ft',['lsquic_stream_ctx_t',['../lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3',1,'lsquic_types.h']]],
['lsquic_5fstream_5fflush',['lsquic_stream_flush',['../lsquic_8h.html#abcf25d8301c4a2796ea13e6e306a33a9',1,'lsquic.h']]],
['lsquic_5fstream_5fget_5fctx',['lsquic_stream_get_ctx',['../lsquic_8h.html#a26335cffe38e49a6e87d94967371150d',1,'lsquic.h']]],
['lsquic_5fstream_5fid',['lsquic_stream_id',['../lsquic_8h.html#a534523d663336969494d6a3721a63640',1,'lsquic.h']]],
['lsquic_5fstream_5fif',['lsquic_stream_if',['../structlsquic__stream__if.html',1,'']]],
@ -75,13 +79,11 @@ var searchData=
['lsquic_5fstream_5fpriority',['lsquic_stream_priority',['../lsquic_8h.html#aa45f5d45b56f5a0d7f881dbccebc5fd8',1,'lsquic.h']]],
['lsquic_5fstream_5fpush_5finfo',['lsquic_stream_push_info',['../lsquic_8h.html#ae0b8525f7dac119f6122af564d0e17fd',1,'lsquic.h']]],
['lsquic_5fstream_5frefuse_5fpush',['lsquic_stream_refuse_push',['../lsquic_8h.html#ada61e01ced7a7db11e5c503409c565be',1,'lsquic.h']]],
['lsquic_5fstream_5fsendfile',['lsquic_stream_sendfile',['../lsquic_8h.html#a1700c950ace4e560d225b474a5e44d58',1,'lsquic.h']]],
['lsquic_5fstream_5fset_5fpriority',['lsquic_stream_set_priority',['../lsquic_8h.html#aa5e0ddfd53a44561248a286caacbd114',1,'lsquic.h']]],
['lsquic_5fstream_5fshutdown',['lsquic_stream_shutdown',['../lsquic_8h.html#a7fee61cc609a4b274a4de2b41db6a9e4',1,'lsquic.h']]],
['lsquic_5fstream_5ft',['lsquic_stream_t',['../lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6',1,'lsquic_types.h']]],
['lsquic_5fstream_5fwrite',['lsquic_stream_write',['../lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a',1,'lsquic.h']]],
['lsquic_5fstream_5fwrite_5favail',['lsquic_stream_write_avail',['../lsquic_8h.html#a97229544d7aaf6c5dcd5e071613f9c8f',1,'lsquic.h']]],
['lsquic_5fstream_5fwrite_5ffile',['lsquic_stream_write_file',['../lsquic_8h.html#af5b85bb360eb8316fd663d7c5bc149c9',1,'lsquic.h']]],
['lsquic_5fstream_5fwritef',['lsquic_stream_writef',['../lsquic_8h.html#a49f11caabdf3638d3a3217ebdd21c3af',1,'lsquic.h']]],
['lsquic_5fsupported_5fversions',['LSQUIC_SUPPORTED_VERSIONS',['../lsquic_8h.html#a0420e68d347462080cf2e583b77d61a0',1,'lsquic.h']]],
['lsquic_5ftypes_2eh',['lsquic_types.h',['../lsquic__types_8h.html',1,'']]],
['lsquic_5fversion',['lsquic_version',['../lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4db',1,'lsquic.h']]],

1
docs/html/search/classes_0.js
View file

@ -7,5 +7,6 @@ var searchData=
['lsquic_5flogger_5fif',['lsquic_logger_if',['../structlsquic__logger__if.html',1,'']]],
['lsquic_5fout_5fspec',['lsquic_out_spec',['../structlsquic__out__spec.html',1,'']]],
['lsquic_5fpackout_5fmem_5fif',['lsquic_packout_mem_if',['../structlsquic__packout__mem__if.html',1,'']]],
['lsquic_5freader',['lsquic_reader',['../structlsquic__reader.html',1,'']]],
['lsquic_5fstream_5fif',['lsquic_stream_if',['../structlsquic__stream__if.html',1,'']]]
];

5
docs/html/search/functions_0.js
View file

@ -30,16 +30,15 @@ var searchData=
['lsquic_5fset_5flog_5flevel',['lsquic_set_log_level',['../lsquic_8h.html#a337f6adcc4ec9328e0f293d6128ee376',1,'lsquic.h']]],
['lsquic_5fstr2ver',['lsquic_str2ver',['../lsquic_8h.html#a8fef45d333b115d996080bb254077d8d',1,'lsquic.h']]],
['lsquic_5fstream_5fconn',['lsquic_stream_conn',['../lsquic_8h.html#a177184b3d7178dda5a3e95e539230b2b',1,'lsquic.h']]],
['lsquic_5fstream_5fflush',['lsquic_stream_flush',['../lsquic_8h.html#abcf25d8301c4a2796ea13e6e306a33a9',1,'lsquic.h']]],
['lsquic_5fstream_5fget_5fctx',['lsquic_stream_get_ctx',['../lsquic_8h.html#a26335cffe38e49a6e87d94967371150d',1,'lsquic.h']]],
['lsquic_5fstream_5fid',['lsquic_stream_id',['../lsquic_8h.html#a534523d663336969494d6a3721a63640',1,'lsquic.h']]],
['lsquic_5fstream_5fis_5fpushed',['lsquic_stream_is_pushed',['../lsquic_8h.html#a199b551bc87bb77814ab4ce58abcdff9',1,'lsquic.h']]],
['lsquic_5fstream_5fpriority',['lsquic_stream_priority',['../lsquic_8h.html#aa45f5d45b56f5a0d7f881dbccebc5fd8',1,'lsquic.h']]],
['lsquic_5fstream_5fpush_5finfo',['lsquic_stream_push_info',['../lsquic_8h.html#ae0b8525f7dac119f6122af564d0e17fd',1,'lsquic.h']]],
['lsquic_5fstream_5frefuse_5fpush',['lsquic_stream_refuse_push',['../lsquic_8h.html#ada61e01ced7a7db11e5c503409c565be',1,'lsquic.h']]],
['lsquic_5fstream_5fsendfile',['lsquic_stream_sendfile',['../lsquic_8h.html#a1700c950ace4e560d225b474a5e44d58',1,'lsquic.h']]],
['lsquic_5fstream_5fset_5fpriority',['lsquic_stream_set_priority',['../lsquic_8h.html#aa5e0ddfd53a44561248a286caacbd114',1,'lsquic.h']]],
['lsquic_5fstream_5fshutdown',['lsquic_stream_shutdown',['../lsquic_8h.html#a7fee61cc609a4b274a4de2b41db6a9e4',1,'lsquic.h']]],
['lsquic_5fstream_5fwrite',['lsquic_stream_write',['../lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a',1,'lsquic.h']]],
['lsquic_5fstream_5fwrite_5favail',['lsquic_stream_write_avail',['../lsquic_8h.html#a97229544d7aaf6c5dcd5e071613f9c8f',1,'lsquic.h']]],
['lsquic_5fstream_5fwrite_5ffile',['lsquic_stream_write_file',['../lsquic_8h.html#af5b85bb360eb8316fd663d7c5bc149c9',1,'lsquic.h']]]
['lsquic_5fstream_5fwritef',['lsquic_stream_writef',['../lsquic_8h.html#a49f11caabdf3638d3a3217ebdd21c3af',1,'lsquic.h']]]
];

2
docs/html/search/searchdata.js
View file

@ -4,7 +4,7 @@ var indexSectionsWithContent =
1: "l",
2: "l",
3: "l",
4: "eo",
4: "elo",
5: "l",
6: "l",
7: "l",

5
docs/html/search/variables_1.js
View file

@ -1,6 +1,5 @@
var searchData=
[
['on_5fgoaway_5freceived',['on_goaway_received',['../structlsquic__stream__if.html#afdab3bce65931517452d2ddd979596d7',1,'lsquic_stream_if']]],
['on_5fnew_5fconn',['on_new_conn',['../structlsquic__stream__if.html#a1eb8c7575d67c7b1c75c472288751adb',1,'lsquic_stream_if']]],
['on_5fnew_5fstream',['on_new_stream',['../structlsquic__stream__if.html#aa9c28eae8f3bd33d028578e0aef24402',1,'lsquic_stream_if']]]
['lsqr_5fread',['lsqr_read',['../structlsquic__reader.html#ae6a68ebf2a1fb77160b0bac599d42790',1,'lsquic_reader']]],
['lsqr_5fsize',['lsqr_size',['../structlsquic__reader.html#aaf6c91ecaf35ca6faa39dde9ea401f17',1,'lsquic_reader']]]
];

26
docs/html/search/variables_2.html Normal file
View file

@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html><head><title></title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<link rel="stylesheet" type="text/css" href="search.css"/>
<script type="text/javascript" src="variables_2.js"></script>
<script type="text/javascript" src="search.js"></script>
</head>
<body class="SRPage">
<div id="SRIndex">
<div class="SRStatus" id="Loading">Loading...</div>
<div id="SRResults"></div>
<script type="text/javascript"><!--
createResults();
--></script>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
<script type="text/javascript"><!--
document.getElementById("Loading").style.display="none";
document.getElementById("NoMatches").style.display="none";
var searchResults = new SearchResults("searchResults");
searchResults.Search();
--></script>
</div>
</body>
</html>

6
docs/html/search/variables_2.js Normal file
View file

@ -0,0 +1,6 @@
var searchData=
[
['on_5fgoaway_5freceived',['on_goaway_received',['../structlsquic__stream__if.html#afdab3bce65931517452d2ddd979596d7',1,'lsquic_stream_if']]],
['on_5fnew_5fconn',['on_new_conn',['../structlsquic__stream__if.html#a1eb8c7575d67c7b1c75c472288751adb',1,'lsquic_stream_if']]],
['on_5fnew_5fstream',['on_new_stream',['../structlsquic__stream__if.html#aa9c28eae8f3bd33d028578e0aef24402',1,'lsquic_stream_if']]]
];

143
docs/html/structlsquic__reader.html Normal file
View file

@ -0,0 +1,143 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>LiteSpeed QUIC Library: lsquic_reader Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LiteSpeed QUIC Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">lsquic_reader Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="lsquic_8h_source.html">lsquic.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae6a68ebf2a1fb77160b0bac599d42790"><td class="memItemLeft" align="right" valign="top">size_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__reader.html#ae6a68ebf2a1fb77160b0bac599d42790">lsqr_read</a> )(void *lsqr_ctx, void *buf, size_t count)</td></tr>
<tr class="separator:ae6a68ebf2a1fb77160b0bac599d42790"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf6c91ecaf35ca6faa39dde9ea401f17"><td class="memItemLeft" align="right" valign="top">size_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__reader.html#aaf6c91ecaf35ca6faa39dde9ea401f17">lsqr_size</a> )(void *lsqr_ctx)</td></tr>
<tr class="separator:aaf6c91ecaf35ca6faa39dde9ea401f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8720320475c026e839eb86b535b213ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8720320475c026e839eb86b535b213ff"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>lsqr_ctx</b></td></tr>
<tr class="separator:a8720320475c026e839eb86b535b213ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used as argument to <a class="el" href="lsquic_8h.html#a49f11caabdf3638d3a3217ebdd21c3af">lsquic_stream_writef()</a> </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ae6a68ebf2a1fb77160b0bac599d42790"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t(* lsquic_reader::lsqr_read) (void *lsqr_ctx, void *buf, size_t count)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Not a ssize_t because the read function is not supposed to return an error. If an error occurs in the read function (for example, when reading from a file fails), it is supposed to deal with the error itself. </p>
</div>
</div>
<a class="anchor" id="aaf6c91ecaf35ca6faa39dde9ea401f17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t(* lsquic_reader::lsqr_size) (void *lsqr_ctx)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return number of bytes remaining in the reader. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="lsquic_8h_source.html">lsquic.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>