Files
rippled/classripple_1_1io__list_1_1work.html
2025-11-04 00:36:48 -08:00

337 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::io_list::work Class 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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1io__list.html">io_list</a></li><li class="navelem"><a class="el" href="classripple_1_1io__list_1_1work.html">work</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classripple_1_1io__list_1_1work-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::io_list::work Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="io__list_8h_source.html">io_list.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::io_list::work:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1io__list_1_1work__inherit__graph.png" border="0" usemap="#aripple_1_1io__list_1_1work_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1io__list_1_1work_inherit__map" id="aripple_1_1io__list_1_1work_inherit__map">
<area shape="rect" title=" " alt="" coords="5,267,152,292"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title=" " alt="" coords="207,5,397,60"/>
<area shape="poly" title=" " alt="" coords="86,253,101,213,125,164,157,114,198,69,214,58,217,62,202,73,162,117,130,167,106,215,91,255"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title=" " alt="" coords="211,84,393,139"/>
<area shape="poly" title=" " alt="" coords="95,254,139,202,167,174,198,149,220,137,223,141,202,154,171,178,142,206,99,257"/>
<area shape="rect" href="classripple_1_1BasePeer.html" title=" " alt="" coords="200,163,404,203"/>
<area shape="poly" title=" " alt="" coords="112,257,199,213,231,201,233,206,201,218,114,262"/>
<area shape="rect" href="classripple_1_1BasePeer.html" title=" " alt="" coords="203,227,401,267"/>
<area shape="poly" title=" " alt="" coords="165,264,202,259,203,264,166,270"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title="Represents an active connection." alt="" coords="221,291,383,331"/>
<area shape="poly" title=" " alt="" coords="166,289,221,297,220,302,165,294"/>
<area shape="rect" href="classripple_1_1BasePeer.html" title=" " alt="" coords="203,355,401,395"/>
<area shape="poly" title=" " alt="" coords="114,297,201,341,233,353,231,358,199,346,112,302"/>
<area shape="rect" href="classripple_1_1Door.html" title="A listening socket." alt="" coords="213,420,391,445"/>
<area shape="poly" title=" " alt="" coords="98,302,141,354,169,382,201,405,230,418,228,422,199,410,166,386,137,358,94,305"/>
<area shape="rect" href="classripple_1_1Door_1_1Detector.html" title=" " alt="" coords="220,470,384,510"/>
<area shape="poly" title=" " alt="" coords="93,304,110,338,133,379,164,420,202,456,222,468,219,472,198,460,160,424,129,382,105,341,88,306"/>
<area shape="rect" href="classripple_1_1PlainHTTPPeer.html" title=" " alt="" coords="460,13,623,53"/>
<area shape="poly" title=" " alt="" coords="411,30,460,30,460,35,411,35"/>
<area shape="rect" href="classripple_1_1SSLHTTPPeer.html" title=" " alt="" coords="465,91,618,131"/>
<area shape="poly" title=" " alt="" coords="407,109,464,109,464,114,407,114"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title=" " alt="" coords="452,269,631,324"/>
<area shape="poly" title=" " alt="" coords="380,348,403,341,460,322,462,327,405,346,381,354"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title=" " alt="" coords="457,348,625,403"/>
<area shape="poly" title=" " alt="" coords="415,373,457,373,457,378,415,378"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title="Represents an active WebSocket connection." alt="" coords="467,427,616,467"/>
<area shape="poly" title=" " alt="" coords="383,397,475,425,473,430,381,402"/>
<area shape="rect" href="classripple_1_1PlainWSPeer.html" title=" " alt="" coords="679,277,829,317"/>
<area shape="poly" title=" " alt="" coords="645,294,679,294,679,299,645,299"/>
<area shape="rect" href="classripple_1_1SSLWSPeer.html" title=" " alt="" coords="679,355,829,395"/>
<area shape="poly" title=" " alt="" coords="639,373,678,373,678,378,639,378"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::io_list::work:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1io__list_1_1work__coll__graph.png" border="0" usemap="#aripple_1_1io__list_1_1work_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1io__list_1_1work_coll__map" id="aripple_1_1io__list_1_1work_coll__map">
<area shape="rect" title=" " alt="" coords="169,196,315,221"/>
<area shape="rect" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O." alt="" coords="189,108,295,133"/>
<area shape="poly" title=" " alt="" coords="245,147,245,195,239,195,239,147"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="5,13,97,38"/>
<area shape="poly" title=" " alt="" coords="88,42,220,105,217,110,86,46"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="122,13,210,38"/>
<area shape="poly" title=" " alt="" coords="186,47,235,106,231,110,182,50"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="234,13,405,38"/>
<area shape="poly" title=" " alt="" coords="303,50,254,110,250,106,299,47"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/function.html" title=" " alt="" coords="429,5,575,45"/>
<area shape="poly" title=" " alt="" coords="438,52,275,110,273,105,436,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa831e509b3e85300654d054c29ab1a30" id="r_aa831e509b3e85300654d054c29ab1a30"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list_1_1work.html#aa831e509b3e85300654d054c29ab1a30">~work</a> ()</td></tr>
<tr class="separator:aa831e509b3e85300654d054c29ab1a30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3982cc79a267f6bec25f27a05f12d9f" id="r_ad3982cc79a267f6bec25f27a05f12d9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1io__list.html">io_list</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list_1_1work.html#ad3982cc79a267f6bec25f27a05f12d9f">ios</a> ()</td></tr>
<tr class="memdesc:ad3982cc79a267f6bec25f27a05f12d9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> associated with the work. <br /></td></tr>
<tr class="separator:ad3982cc79a267f6bec25f27a05f12d9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a588fa17996479affa5d38963d475f74e" id="r_a588fa17996479affa5d38963d475f74e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list_1_1work.html#a588fa17996479affa5d38963d475f74e">close</a> ()=0</td></tr>
<tr class="separator:a588fa17996479affa5d38963d475f74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:afab5fbd0d8f81eeea8d7665210db4839" id="r_afab5fbd0d8f81eeea8d7665210db4839"><td class="memTemplParams" colspan="2">template&lt;class = void&gt; </td></tr>
<tr class="memitem:afab5fbd0d8f81eeea8d7665210db4839"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list_1_1work.html#afab5fbd0d8f81eeea8d7665210db4839">destroy</a> ()</td></tr>
<tr class="separator:afab5fbd0d8f81eeea8d7665210db4839"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a72a5b3899fd35be82c4775a69d61e33e" id="r_a72a5b3899fd35be82c4775a69d61e33e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1io__list.html">io_list</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list_1_1work.html#a72a5b3899fd35be82c4775a69d61e33e">ios_</a> = nullptr</td></tr>
<tr class="separator:a72a5b3899fd35be82c4775a69d61e33e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a09a2b003b5f92f63333b86145787c447" id="r_a09a2b003b5f92f63333b86145787c447"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list_1_1work.html#a09a2b003b5f92f63333b86145787c447">io_list</a></td></tr>
<tr class="separator:a09a2b003b5f92f63333b86145787c447"><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 class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00019">19</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa831e509b3e85300654d054c29ab1a30" name="aa831e509b3e85300654d054c29ab1a30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa831e509b3e85300654d054c29ab1a30">&#9670;&#160;</a></span>~work()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::io_list::work::~work </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00029">29</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afab5fbd0d8f81eeea8d7665210db4839" name="afab5fbd0d8f81eeea8d7665210db4839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afab5fbd0d8f81eeea8d7665210db4839">&#9670;&#160;</a></span>destroy()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class = void&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::io_list::work::destroy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00163">163</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="ad3982cc79a267f6bec25f27a05f12d9f" name="ad3982cc79a267f6bec25f27a05f12d9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3982cc79a267f6bec25f27a05f12d9f">&#9670;&#160;</a></span>ios()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1io__list.html">io_list</a> &amp; ripple::io_list::work::ios </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> associated with the work. </p>
<p>Requirements: The call to <a class="el" href="classripple_1_1io__list.html#ab3e889d40f86fc527ad71c5b3f7c0e91" title="Create associated work if not closed.">io_list::emplace</a> to create the work has already returned. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00041">41</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a588fa17996479affa5d38963d475f74e" name="a588fa17996479affa5d38963d475f74e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a588fa17996479affa5d38963d475f74e">&#9670;&#160;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::io_list::work::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1BaseHTTPPeer.html#af8e177e2e0557c80ca0600852ca7b21e">ripple::BaseHTTPPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#af8e177e2e0557c80ca0600852ca7b21e">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&lt; Handler &gt; &gt;</a>, <a class="el" href="classripple_1_1BaseHTTPPeer.html#af8e177e2e0557c80ca0600852ca7b21e">ripple::BaseHTTPPeer&lt; Handler, SSLHTTPPeer&lt; Handler &gt; &gt;</a>, <a class="el" href="classripple_1_1BasePeer.html#a38c8567daa0bb47b6eed500312d646b3">ripple::BasePeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BasePeer.html#a38c8567daa0bb47b6eed500312d646b3">ripple::BasePeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, <a class="el" href="classripple_1_1BasePeer.html#a38c8567daa0bb47b6eed500312d646b3">ripple::BasePeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a97a9f5f6956b657add9bb7bea1890604">ripple::BaseWSPeer&lt; Handler, Impl &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a97a9f5f6956b657add9bb7bea1890604">ripple::BaseWSPeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>, <a class="el" href="classripple_1_1BaseWSPeer.html#a97a9f5f6956b657add9bb7bea1890604">ripple::BaseWSPeer&lt; Handler, SSLWSPeer&lt; Handler &gt; &gt;</a>, <a class="el" href="classripple_1_1Door_1_1Detector.html#a84efe133c94689e911ae79f36b0cac9a">ripple::Door&lt; Handler &gt;::Detector</a>, and <a class="el" href="classripple_1_1Door.html#ad9c1ad794fb8c538a6c0da924e38f200">ripple::Door&lt; Handler &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a09a2b003b5f92f63333b86145787c447" name="a09a2b003b5f92f63333b86145787c447"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a2b003b5f92f63333b86145787c447">&#9670;&#160;</a></span>io_list</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classripple_1_1io__list.html">io_list</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00025">25</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a72a5b3899fd35be82c4775a69d61e33e" name="a72a5b3899fd35be82c4775a69d61e33e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72a5b3899fd35be82c4775a69d61e33e">&#9670;&#160;</a></span>ios_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1io__list.html">io_list</a>* ripple::io_list::work::ios_ = nullptr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00026">26</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>