litespeed-quic/docs/html/globals.html

348 lines
14 KiB
HTML
Raw Normal View History

<!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: Globals</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><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li class="current"><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="navrow3" class="tabs2">
<ul class="tablist">
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Macros</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li class="current"><a href="#index_l"><span>l</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="contents">
<div class="textblock">Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:</div>
<h3><a class="anchor" id="index_l"></a>- l -</h3><ul>
<li>LLTS_CHROMELIKE
: <a class="el" href="lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235a5aa72ace83b5948f4d5a9ed5c72a4c4b">lsquic.h</a>
</li>
<li>LLTS_HHMMSSMS
: <a class="el" href="lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235aa00368e0a7e30628851ab624d6e7575b">lsquic.h</a>
</li>
<li>LLTS_HHMMSSUS
: <a class="el" href="lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235a874a36df2ce02e162104c2345b176185">lsquic.h</a>
</li>
<li>LLTS_NONE
: <a class="el" href="lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235a4bc180853f0f833b9c93bf7080ce2805">lsquic.h</a>
</li>
<li>LLTS_YYYYMMDD_HHMMSSMS
: <a class="el" href="lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235a8754c3fced294cfb146625c586a55a56">lsquic.h</a>
</li>
<li>LSENG_HTTP
: <a class="el" href="lsquic_8h.html#a8f395ac69797c7be8d9d524d464e7ed2">lsquic.h</a>
</li>
<li>LSENG_SERVER
: <a class="el" href="lsquic_8h.html#abaf1fe07c4f99aa36d3d5502bbfc371d">lsquic.h</a>
</li>
<li>lsquic_cid_t
: <a class="el" href="lsquic__types_8h.html#acf675534bad01d31b48d9113feff1bbb">lsquic_types.h</a>
</li>
<li>lsquic_conn_abort()
: <a class="el" href="lsquic_8h.html#a6da1350d78db9a83810a00dcee3e4944">lsquic.h</a>
</li>
<li>lsquic_conn_cancel_pending_streams()
: <a class="el" href="lsquic_8h.html#a8fe1ef20026e5e68a892036005c20a19">lsquic.h</a>
</li>
<li>lsquic_conn_close()
: <a class="el" href="lsquic_8h.html#ad8f2345e0b9f8d19f7b6a1fa4e970aa8">lsquic.h</a>
</li>
<li>lsquic_conn_ctx_t
: <a class="el" href="lsquic__types_8h.html#a21c289bcbb4643effba8bb75eeffd8cd">lsquic_types.h</a>
</li>
<li>lsquic_conn_get_ctx()
: <a class="el" href="lsquic_8h.html#a53d1105503b5ab46384451ff4bbd0391">lsquic.h</a>
</li>
<li>lsquic_conn_get_peer_ctx()
: <a class="el" href="lsquic_8h.html#a8edf1874acb10f4b95abf8894023c3c9">lsquic.h</a>
</li>
<li>lsquic_conn_going_away()
: <a class="el" href="lsquic_8h.html#aff77b794b9ca995245cc9a739b76d197">lsquic.h</a>
</li>
<li>lsquic_conn_id()
: <a class="el" href="lsquic_8h.html#a487bffd57fd7febe4b316be7dc0a3016">lsquic.h</a>
</li>
<li>lsquic_conn_n_pending_streams()
: <a class="el" href="lsquic_8h.html#a33bb7961ffad842a052bcd81202de5b9">lsquic.h</a>
</li>
<li>lsquic_conn_quic_version()
: <a class="el" href="lsquic_8h.html#a2a07e308beb5e1f29ba62597c2a37b2b">lsquic.h</a>
</li>
<li>lsquic_conn_t
: <a class="el" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_types.h</a>
</li>
<li>LSQUIC_DF_HANDSHAKE_TO
: <a class="el" href="lsquic_8h.html#a1e7808ab9863e1ae4b44e7856e75eee8">lsquic.h</a>
</li>
<li>LSQUIC_DF_HONOR_PRST
: <a class="el" href="lsquic_8h.html#a13d1cb05ad19ae5cd016e016d228326c">lsquic.h</a>
</li>
<li>LSQUIC_DF_MAX_HEADER_LIST_SIZE
: <a class="el" href="lsquic_8h.html#a1e1ab46b8acff52f127359bf68a8b297">lsquic.h</a>
</li>
<li>LSQUIC_DF_PACE_PACKETS
: <a class="el" href="lsquic_8h.html#a332b2fcfbbd83bbeb6027a622ec72f69">lsquic.h</a>
</li>
<li>LSQUIC_DF_PENDRW_CHECK
: <a class="el" href="lsquic_8h.html#a472d9508529e22b2be78b48d0fd69529">lsquic.h</a>
</li>
<li>LSQUIC_DF_PROC_TIME_THRESH
: <a class="el" href="lsquic_8h.html#a4a8cbc259dcff01fa93959ca5b2a0a35">lsquic.h</a>
</li>
<li>LSQUIC_DF_PROGRESS_CHECK
: <a class="el" href="lsquic_8h.html#afc995b576f8013a43436201a7adf0221">lsquic.h</a>
</li>
<li>LSQUIC_DF_RW_ONCE
: <a class="el" href="lsquic_8h.html#a5665ba68a62be14aa1332316512ec4fe">lsquic.h</a>
</li>
<li>LSQUIC_DF_SUPPORT_NSTP
: <a class="el" href="lsquic_8h.html#a9e3f5f4a0ecb53f96d2b9249cded3aef">lsquic.h</a>
</li>
<li>LSQUIC_DF_UA
: <a class="el" href="lsquic_8h.html#aeefb2f925217c311af00c92a77e0f191">lsquic.h</a>
</li>
<li>LSQUIC_DF_VERSIONS
: <a class="el" href="lsquic_8h.html#aecb8427433af4e3fa5260fe71c313d8f">lsquic.h</a>
</li>
<li>lsquic_engine_check_settings()
: <a class="el" href="lsquic_8h.html#a827d6567e492bd67c330e2d48047ad49">lsquic.h</a>
</li>
<li>lsquic_engine_connect()
: <a class="el" href="lsquic_8h.html#a5e2335a871f1ab9b66e3c59b442e8cbe">lsquic.h</a>
</li>
<li>lsquic_engine_count_attq()
: <a class="el" href="lsquic_8h.html#aec59af9ee5cb005bef2e828ee8a0a4be">lsquic.h</a>
</li>
<li>lsquic_engine_earliest_adv_tick()
: <a class="el" href="lsquic_8h.html#ac864ff28dcaa1c09ef796a3cdcf83e27">lsquic.h</a>
</li>
<li>lsquic_engine_has_pend_rw()
: <a class="el" href="lsquic_8h.html#a74d8c8f033c2e654fdb3487a2bf55d8a">lsquic.h</a>
</li>
<li>lsquic_engine_has_unsent_packets()
: <a class="el" href="lsquic_8h.html#a9d5d9609ca70350117994e2e2e934a22">lsquic.h</a>
</li>
<li>lsquic_engine_new()
: <a class="el" href="lsquic_8h.html#afa6f69c943be0a943f28699af6ae1000">lsquic.h</a>
</li>
<li>lsquic_engine_packet_in()
: <a class="el" href="lsquic_8h.html#adb3d3d822e9a8217d90acbf29594ae40">lsquic.h</a>
</li>
<li>lsquic_engine_proc_all()
: <a class="el" href="lsquic_8h.html#a60427549acdb608cc360173d817393e3">lsquic.h</a>
</li>
<li>lsquic_engine_process_conns_to_tick()
: <a class="el" href="lsquic_8h.html#aefc66717813306c208483cccbb90ab9a">lsquic.h</a>
</li>
<li>lsquic_engine_process_conns_with_incoming()
: <a class="el" href="lsquic_8h.html#aefe24851a36ebe16289a6fa3c5a1c8cc">lsquic.h</a>
</li>
<li>lsquic_engine_process_conns_with_pend_rw()
: <a class="el" href="lsquic_8h.html#aae156a499af8ae01ca6f4fa307da86c6">lsquic.h</a>
</li>
<li>lsquic_engine_quic_versions()
: <a class="el" href="lsquic_8h.html#abebdca40ce630ad8272752da926d7a24">lsquic.h</a>
</li>
<li>lsquic_engine_send_unsent_packets()
: <a class="el" href="lsquic_8h.html#a88a2040cc4b0e575b2fa2affe8597697">lsquic.h</a>
</li>
<li>lsquic_engine_t
: <a class="el" href="lsquic__types_8h.html#a41d83b8270d6f12d2812203a7614b55f">lsquic_types.h</a>
</li>
<li>lsquic_global_cleanup()
: <a class="el" href="lsquic_8h.html#a06b9ac9ba933a060b72975640b2d79a3">lsquic.h</a>
</li>
<li>LSQUIC_GLOBAL_CLIENT
: <a class="el" href="lsquic_8h.html#add59f38ae0a3bea39bd3c5c86b70c63c">lsquic.h</a>
</li>
<li>lsquic_global_init()
: <a class="el" href="lsquic_8h.html#a754a3d611e8c6f9a1daeb7b06c00af88">lsquic.h</a>
</li>
<li>LSQUIC_GLOBAL_SERVER
: <a class="el" href="lsquic_8h.html#a632ff4c3837f60fae3436db6e5f3e039">lsquic.h</a>
</li>
<li>lsquic_http_header_t
: <a class="el" href="lsquic_8h.html#a822627a87eb003fd9e2e56ebded5b3f3">lsquic.h</a>
</li>
<li>lsquic_http_headers_t
: <a class="el" href="lsquic__types_8h.html#a91f399fbcccaf01b47ca209c5c170ba2">lsquic_types.h</a>
</li>
<li>lsquic_logger_init()
: <a class="el" href="lsquic_8h.html#a5059cabdc84335f56870c8bc7a1235e2">lsquic.h</a>
</li>
<li>lsquic_logger_lopt()
: <a class="el" href="lsquic_8h.html#af8c718a3780425357d070419106e4bc8">lsquic.h</a>
</li>
<li>lsquic_logger_timestamp_style
: <a class="el" href="lsquic_8h.html#ac4584806627d352797a2e0cfae2e6235">lsquic.h</a>
</li>
<li>LSQUIC_MIN_FCW
: <a class="el" href="lsquic_8h.html#a6fd9104d1ffa8c391dede0a714a5919b">lsquic.h</a>
</li>
<li>lsquic_packets_out_f
: <a class="el" href="lsquic_8h.html#aade9ff8d34cbcb33cd04a41377797fcf">lsquic.h</a>
</li>
<li>lsquic_set_log_level()
: <a class="el" href="lsquic_8h.html#a337f6adcc4ec9328e0f293d6128ee376">lsquic.h</a>
</li>
<li>lsquic_str2ver()
: <a class="el" href="lsquic_8h.html#a8fef45d333b115d996080bb254077d8d">lsquic.h</a>
</li>
<li>lsquic_stream_conn()
: <a class="el" href="lsquic_8h.html#a177184b3d7178dda5a3e95e539230b2b">lsquic.h</a>
</li>
<li>lsquic_stream_ctx_t
: <a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_types.h</a>
</li>
Latest changes - [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.
2017-10-31 13:35:58 +00:00
<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>
<li>lsquic_stream_id()
: <a class="el" href="lsquic_8h.html#a534523d663336969494d6a3721a63640">lsquic.h</a>
</li>
<li>lsquic_stream_is_pushed()
: <a class="el" href="lsquic_8h.html#a199b551bc87bb77814ab4ce58abcdff9">lsquic.h</a>
</li>
<li>lsquic_stream_priority()
: <a class="el" href="lsquic_8h.html#aa45f5d45b56f5a0d7f881dbccebc5fd8">lsquic.h</a>
</li>
<li>lsquic_stream_push_info()
: <a class="el" href="lsquic_8h.html#ae0b8525f7dac119f6122af564d0e17fd">lsquic.h</a>
</li>
<li>lsquic_stream_refuse_push()
: <a class="el" href="lsquic_8h.html#ada61e01ced7a7db11e5c503409c565be">lsquic.h</a>
</li>
<li>lsquic_stream_set_priority()
: <a class="el" href="lsquic_8h.html#aa5e0ddfd53a44561248a286caacbd114">lsquic.h</a>
</li>
<li>lsquic_stream_shutdown()
: <a class="el" href="lsquic_8h.html#a7fee61cc609a4b274a4de2b41db6a9e4">lsquic.h</a>
</li>
<li>lsquic_stream_t
: <a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_types.h</a>
</li>
<li>lsquic_stream_write()
: <a class="el" href="lsquic_8h.html#a1071b7be4f2f28c5fedf957aa6309f9a">lsquic.h</a>
</li>
Latest changes - [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.
2017-10-31 13:35:58 +00:00
<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>
</li>
<li>lsquic_version
: <a class="el" href="lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4db">lsquic.h</a>
</li>
<li>LSQVER_035
: <a class="el" href="lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4dba1956abef5d785f45310599e4fcd39c32">lsquic.h</a>
</li>
<li>LSQVER_037
: <a class="el" href="lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4dba5c2aa78b22ea462ae839566e19a87ea7">lsquic.h</a>
</li>
<li>LSQVER_038
: <a class="el" href="lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4dba2d39809298e0c7866b21fc7932504966">lsquic.h</a>
</li>
<li>LSQVER_039
: <a class="el" href="lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4dbaa9b8bed8ca169e8a3762308cbf0f3af3">lsquic.h</a>
</li>
<li>LSQVER_041
: <a class="el" href="lsquic_8h.html#a2633ae9ee8d564f4c499f6eb0913d4dbac673a00564784af03b3b9cb747ed8af3">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>