ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d24525527d834b56e26743d677a41dbb472073b3
rippled/classripple_1_1io__list_1_1work.html
manojsdoshi 46ee4c24ed deploy: c11037fd27
2021-01-21 18:53:50 +00:00

310 lines
18 KiB
HTML
Raw Blame History

<!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">
<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.17"/>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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">
<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="#ripple_1_1io__list_1_1work_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1io__list_1_1work_inherit__map" id="ripple_1_1io__list_1_1work_inherit__map">
<area shape="rect" title=" " alt="" coords="5,272,152,299"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title=" " alt="" coords="207,5,397,61"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title=" " alt="" coords="211,85,393,141"/>
<area shape="rect" href="classripple_1_1BasePeer.html" title=" " alt="" coords="200,166,404,207"/>
<area shape="rect" href="classripple_1_1BasePeer.html" title=" " alt="" coords="203,231,401,273"/>
<area shape="rect" href="classripple_1_1BaseHTTPPeer.html" title="Represents an active connection." alt="" coords="221,297,383,338"/>
<area shape="rect" href="classripple_1_1BasePeer.html" title=" " alt="" coords="203,362,401,403"/>
<area shape="rect" href="classripple_1_1Door.html" title="A listening socket." alt="" coords="213,428,391,455"/>
<area shape="rect" href="classripple_1_1Door_1_1Detector.html" title=" " alt="" coords="220,479,384,521"/>
<area shape="rect" href="classripple_1_1PlainHTTPPeer.html" title=" " alt="" coords="460,13,623,54"/>
<area shape="rect" href="classripple_1_1SSLHTTPPeer.html" title=" " alt="" coords="465,93,618,134"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title=" " alt="" coords="452,159,631,215"/>
<area shape="rect" href="classripple_1_1PlainWSPeer.html" title=" " alt="" coords="679,166,829,207"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title=" " alt="" coords="457,239,625,295"/>
<area shape="rect" href="classripple_1_1SSLWSPeer.html" title=" " alt="" coords="679,246,829,287"/>
<area shape="rect" href="classripple_1_1BaseWSPeer.html" title="Represents an active WebSocket connection." alt="" coords="467,362,616,403"/>
</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="#ripple_1_1io__list_1_1work_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1io__list_1_1work_coll__map" id="ripple_1_1io__list_1_1work_coll__map">
<area shape="rect" title=" " alt="" coords="245,199,392,225"/>
<area shape="rect" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O." alt="" coords="265,109,372,136"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="5,13,176,39"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="201,13,293,39"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/function.html" title=" " alt="" coords="317,5,464,47"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="488,13,576,39"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem: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:a664054f7ccdd28b5fae40faab62bfe10"><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#a664054f7ccdd28b5fae40faab62bfe10">ios</a> ()</td></tr>
<tr class="memdesc:a664054f7ccdd28b5fae40faab62bfe10"><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. <a href="classripple_1_1io__list_1_1work.html#a664054f7ccdd28b5fae40faab62bfe10">More...</a><br /></td></tr>
<tr class="separator:a664054f7ccdd28b5fae40faab62bfe10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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 name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem: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 name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem: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 name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem: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#l00038">38</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa831e509b3e85300654d054c29ab1a30">&#9670;&nbsp;</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#l00048">48</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afab5fbd0d8f81eeea8d7665210db4839">&#9670;&nbsp;</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#l00182">182</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a664054f7ccdd28b5fae40faab62bfe10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a664054f7ccdd28b5fae40faab62bfe10">&#9670;&nbsp;</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#l00060">60</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a588fa17996479affa5d38963d475f74e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a588fa17996479affa5d38963d475f74e">&#9670;&nbsp;</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_1Door.html#ad9c1ad794fb8c538a6c0da924e38f200">ripple::Door&lt; Handler &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_1BaseHTTPPeer.html#af8e177e2e0557c80ca0600852ca7b21e">ripple::BaseHTTPPeer&lt; Handler, PlainHTTPPeer&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, SSLWSPeer&lt; Handler &gt; &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_1Door_1_1Detector.html#a84efe133c94689e911ae79f36b0cac9a">ripple::Door&lt; Handler &gt;::Detector</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, SSLWSPeer&lt; Handler &gt; &gt;</a>, and <a class="el" href="classripple_1_1BasePeer.html#a38c8567daa0bb47b6eed500312d646b3">ripple::BasePeer&lt; Handler, PlainWSPeer&lt; Handler &gt; &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a09a2b003b5f92f63333b86145787c447"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a2b003b5f92f63333b86145787c447">&#9670;&nbsp;</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#l00044">44</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72a5b3899fd35be82c4775a69d61e33e">&#9670;&nbsp;</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#l00045">45</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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink