mirror of
https://gitea.invidious.io/iv-org/litespeed-quic.git
synced 2024-08-15 00:53:43 +00:00
171 lines
10 KiB
HTML
171 lines
10 KiB
HTML
<!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_stream_if 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 Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
|
|
<li><a href="functions.html"><span>Data 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_stream_if Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The definition of callback functions call by lsquic_stream to process events.
|
|
<a href="structlsquic__stream__if.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="lsquic_8h_source.html">lsquic.h</a>></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:a1eb8c7575d67c7b1c75c472288751adb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="lsquic__types_8h.html#a21c289bcbb4643effba8bb75eeffd8cd">lsquic_conn_ctx_t</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__stream__if.html#a1eb8c7575d67c7b1c75c472288751adb">on_new_conn</a> )(void *stream_if_ctx, <a class="el" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a> *c)</td></tr>
|
|
<tr class="separator:a1eb8c7575d67c7b1c75c472288751adb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdab3bce65931517452d2ddd979596d7"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__stream__if.html#afdab3bce65931517452d2ddd979596d7">on_goaway_received</a> )(<a class="el" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a> *c)</td></tr>
|
|
<tr class="separator:afdab3bce65931517452d2ddd979596d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cdeef736b8f8a5bc5ace5325d96eabb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cdeef736b8f8a5bc5ace5325d96eabb"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>on_conn_closed</b> )(<a class="el" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a> *c)</td></tr>
|
|
<tr class="separator:a6cdeef736b8f8a5bc5ace5325d96eabb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9c28eae8f3bd33d028578e0aef24402"><td class="memItemLeft" align="right" valign="top"><a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlsquic__stream__if.html#aa9c28eae8f3bd33d028578e0aef24402">on_new_stream</a> )(void *stream_if_ctx, <a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s)</td></tr>
|
|
<tr class="separator:aa9c28eae8f3bd33d028578e0aef24402"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae633e333d3c0ab38763dcad781965fa7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae633e333d3c0ab38763dcad781965fa7"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>on_read</b> )(<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, <a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a> *h)</td></tr>
|
|
<tr class="separator:ae633e333d3c0ab38763dcad781965fa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e00c936c67202286f4e859037c0ce3d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e00c936c67202286f4e859037c0ce3d"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>on_write</b> )(<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, <a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a> *h)</td></tr>
|
|
<tr class="separator:a0e00c936c67202286f4e859037c0ce3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5794ca95163b341712af2d265f06bd35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5794ca95163b341712af2d265f06bd35"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>on_close</b> )(<a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s, <a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a> *h)</td></tr>
|
|
<tr class="separator:a5794ca95163b341712af2d265f06bd35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The definition of callback functions call by lsquic_stream to process events. </p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a class="anchor" id="afdab3bce65931517452d2ddd979596d7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void(* lsquic_stream_if::on_goaway_received) (<a class="el" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a> *c)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This is called when our side received GOAWAY frame. After this, new streams should not be created. The callback is optional. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1eb8c7575d67c7b1c75c472288751adb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="lsquic__types_8h.html#a21c289bcbb4643effba8bb75eeffd8cd">lsquic_conn_ctx_t</a>*(* lsquic_stream_if::on_new_conn) (void *stream_if_ctx, <a class="el" href="lsquic__types_8h.html#a7e5d9c467ebef6810d3c5100e4684036">lsquic_conn_t</a> *c)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use <a class="el" href="lsquic_8h.html#a53d1105503b5ab46384451ff4bbd0391">lsquic_conn_get_ctx</a> to get back the context. It is OK for this function to return NULL. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa9c28eae8f3bd33d028578e0aef24402"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="lsquic__types_8h.html#a4012fdeb11382d691dfe5f025206b8f3">lsquic_stream_ctx_t</a>*(* lsquic_stream_if::on_new_stream) (void *stream_if_ctx, <a class="el" href="lsquic__types_8h.html#ad286bcdd799bb3733f1d6568e25c57c6">lsquic_stream_t</a> *s)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If you need to initiate a connection, call lsquic_conn_make_stream(). This will cause `on_new_stream' callback to be called when appropriate (this operation is delayed when maximum number of outgoing streams is reached).</p>
|
|
<p>After `on_close' is called, the stream is no longer accessible. </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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|