ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1io__list.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

517 lines
28 KiB
HTML
Raw Permalink 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" 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 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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<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="classripple_1_1io__list-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::io_list Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Manages a set of objects performing asynchronous I/O.
<a href="classripple_1_1io__list.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="io__list_8h_source.html">io_list.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::io_list:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1io__list__coll__graph.png" border="0" usemap="#aripple_1_1io__list_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1io__list_coll__map" id="aripple_1_1io__list_coll__map">
<area shape="rect" title="Manages a set of objects performing asynchronous I/O." alt="" coords="189,108,295,133"/>
<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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><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">work</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ae90512448cc310a11d19a393bf8e48a2" id="r_ae90512448cc310a11d19a393bf8e48a2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#ae90512448cc310a11d19a393bf8e48a2">io_list</a> ()=default</td></tr>
<tr class="separator:ae90512448cc310a11d19a393bf8e48a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cb772fed064a6110d900c4df36f95d0" id="r_a7cb772fed064a6110d900c4df36f95d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a7cb772fed064a6110d900c4df36f95d0">~io_list</a> ()</td></tr>
<tr class="memdesc:a7cb772fed064a6110d900c4df36f95d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the list. <br /></td></tr>
<tr class="separator:a7cb772fed064a6110d900c4df36f95d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89110a8de8058662a49b373db261138b" id="r_a89110a8de8058662a49b373db261138b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a89110a8de8058662a49b373db261138b">closed</a> () const</td></tr>
<tr class="memdesc:a89110a8de8058662a49b373db261138b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return <code>true</code> if the list is closed. <br /></td></tr>
<tr class="separator:a89110a8de8058662a49b373db261138b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3e889d40f86fc527ad71c5b3f7c0e91" id="r_ab3e889d40f86fc527ad71c5b3f7c0e91"><td class="memTemplParams" colspan="2">template&lt;class T , class... Args&gt; </td></tr>
<tr class="memitem:ab3e889d40f86fc527ad71c5b3f7c0e91"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#ab3e889d40f86fc527ad71c5b3f7c0e91">emplace</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:ab3e889d40f86fc527ad71c5b3f7c0e91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create associated work if not closed. <br /></td></tr>
<tr class="separator:ab3e889d40f86fc527ad71c5b3f7c0e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af29e7fa0f5f6ce48c17d09c04cb6c66f" id="r_af29e7fa0f5f6ce48c17d09c04cb6c66f"><td class="memTemplParams" colspan="2">template&lt;class Finisher &gt; </td></tr>
<tr class="memitem:af29e7fa0f5f6ce48c17d09c04cb6c66f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#af29e7fa0f5f6ce48c17d09c04cb6c66f">close</a> (Finisher &amp;&amp;f)</td></tr>
<tr class="memdesc:af29e7fa0f5f6ce48c17d09c04cb6c66f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel active I/O. <br /></td></tr>
<tr class="separator:af29e7fa0f5f6ce48c17d09c04cb6c66f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a400fa8b9aa03428e1fcfb85cbbef7e50" id="r_a400fa8b9aa03428e1fcfb85cbbef7e50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a400fa8b9aa03428e1fcfb85cbbef7e50">close</a> ()</td></tr>
<tr class="separator:a400fa8b9aa03428e1fcfb85cbbef7e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a915367fce86c5c48cdcf1fff7f8db1af" id="r_a915367fce86c5c48cdcf1fff7f8db1af"><td class="memTemplParams" colspan="2">template&lt;class = void&gt; </td></tr>
<tr class="memitem:a915367fce86c5c48cdcf1fff7f8db1af"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a915367fce86c5c48cdcf1fff7f8db1af">join</a> ()</td></tr>
<tr class="memdesc:a915367fce86c5c48cdcf1fff7f8db1af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block until the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> stops. <br /></td></tr>
<tr class="separator:a915367fce86c5c48cdcf1fff7f8db1af"><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:a386e801303524be0aeaa71fc09efc8d9" id="r_a386e801303524be0aeaa71fc09efc8d9"><td class="memTemplParams" colspan="2">template&lt;class = void&gt; </td></tr>
<tr class="memitem:a386e801303524be0aeaa71fc09efc8d9"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a386e801303524be0aeaa71fc09efc8d9">destroy</a> ()</td></tr>
<tr class="separator:a386e801303524be0aeaa71fc09efc8d9"><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:a75973f7aec010c70ecca9ed10353c1af" id="r_a75973f7aec010c70ecca9ed10353c1af"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a75973f7aec010c70ecca9ed10353c1af">m_</a></td></tr>
<tr class="separator:a75973f7aec010c70ecca9ed10353c1af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5456492974af3655b707975ce21607e9" id="r_a5456492974af3655b707975ce21607e9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a5456492974af3655b707975ce21607e9">n_</a> = 0</td></tr>
<tr class="separator:a5456492974af3655b707975ce21607e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb6fed49c10cdfd4a7e3cf232c436e1b" id="r_afb6fed49c10cdfd4a7e3cf232c436e1b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#afb6fed49c10cdfd4a7e3cf232c436e1b">closed_</a> = false</td></tr>
<tr class="separator:afb6fed49c10cdfd4a7e3cf232c436e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3f04eaa3c7185aaac34a28655a7972e" id="r_ae3f04eaa3c7185aaac34a28655a7972e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#ae3f04eaa3c7185aaac34a28655a7972e">cv_</a></td></tr>
<tr class="separator:ae3f04eaa3c7185aaac34a28655a7972e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b990ea25b58ca174f973c76f7bde205" id="r_a9b990ea25b58ca174f973c76f7bde205"><td class="memItemLeft" align="right" valign="top">boost::container::flat_map&lt; <a class="el" href="classripple_1_1io__list_1_1work.html">work</a> *, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html">std::weak_ptr</a>&lt; <a class="el" href="classripple_1_1io__list_1_1work.html">work</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#a9b990ea25b58ca174f973c76f7bde205">map_</a></td></tr>
<tr class="separator:a9b990ea25b58ca174f973c76f7bde205"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2d110eae45584b04e6f2fb5c89d402d" id="r_ad2d110eae45584b04e6f2fb5c89d402d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(void)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1io__list.html#ad2d110eae45584b04e6f2fb5c89d402d">f_</a></td></tr>
<tr class="separator:ad2d110eae45584b04e6f2fb5c89d402d"><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>Manages a set of objects performing asynchronous I/O. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00016">16</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="ae90512448cc310a11d19a393bf8e48a2" name="ae90512448cc310a11d19a393bf8e48a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90512448cc310a11d19a393bf8e48a2">&#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">ripple::io_list::io_list </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7cb772fed064a6110d900c4df36f95d0" name="a7cb772fed064a6110d900c4df36f95d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cb772fed064a6110d900c4df36f95d0">&#9670;&#160;</a></span>~io_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::io_list::~io_list </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the list. </p>
<p>Effects: Closes the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> if it was not previously closed. No finisher is invoked in this case.</p>
<p>Blocks until all work is destroyed. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00073">73</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="a386e801303524be0aeaa71fc09efc8d9" name="a386e801303524be0aeaa71fc09efc8d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a386e801303524be0aeaa71fc09efc8d9">&#9670;&#160;</a></span>destroy()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::io_list::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#l00183">183</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a89110a8de8058662a49b373db261138b" name="a89110a8de8058662a49b373db261138b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89110a8de8058662a49b373db261138b">&#9670;&#160;</a></span>closed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::io_list::closed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return <code>true</code> if the list is closed. </p>
<p>Thread Safety: Undefined result if called concurrently with <a class="el" href="classripple_1_1io__list.html#a400fa8b9aa03428e1fcfb85cbbef7e50">close()</a>. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00085">85</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="ab3e889d40f86fc527ad71c5b3f7c0e91" name="ab3e889d40f86fc527ad71c5b3f7c0e91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3e889d40f86fc527ad71c5b3f7c0e91">&#9670;&#160;</a></span>emplace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class... Args&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; T &gt; ripple::io_list::emplace </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create associated work if not closed. </p>
<p>Requirements: <code><a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_base_of.html">std::is_base_of_v</a>&lt;work, T&gt; == true</code></p>
<p>Thread Safety: May be called concurrently.</p>
<p>Effects: Atomically creates, inserts, and returns new work T, or returns nullptr if the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> is closed,</p>
<p>If the call succeeds and returns a new object, it is guaranteed that a subsequent call to close will invoke <a class="el" href="classripple_1_1io__list_1_1work.html#a588fa17996479affa5d38963d475f74e">work::close</a> on the object. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00191">191</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="af29e7fa0f5f6ce48c17d09c04cb6c66f" name="af29e7fa0f5f6ce48c17d09c04cb6c66f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af29e7fa0f5f6ce48c17d09c04cb6c66f">&#9670;&#160;</a></span>close() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Finisher &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ripple::io_list::close </td>
<td>(</td>
<td class="paramtype">Finisher &amp;&amp;&#160;</td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel active I/O. </p>
<p>Thread Safety: May not be called concurrently.</p>
<p>Effects: Associated work is closed.</p>
<p>Finisher if provided, will be called when all associated work is destroyed. The finisher may be called from a foreign thread, or within the call to this function.</p>
<p>Only the first call to close will set the finisher.</p>
<p>No effect after the first call. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00216">216</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a400fa8b9aa03428e1fcfb85cbbef7e50" name="a400fa8b9aa03428e1fcfb85cbbef7e50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a400fa8b9aa03428e1fcfb85cbbef7e50">&#9670;&#160;</a></span>close() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::io_list::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00135">135</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a915367fce86c5c48cdcf1fff7f8db1af" name="a915367fce86c5c48cdcf1fff7f8db1af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a915367fce86c5c48cdcf1fff7f8db1af">&#9670;&#160;</a></span>join()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ripple::io_list::join </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Block until the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> stops. </p>
<p>Effects: The caller is blocked until the <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> is closed and all associated work is destroyed.</p>
<p>Thread safety: May be called concurrently.</p>
<p>Preconditions: No call to io_context::run on any io_context used by work objects associated with this <a class="el" href="classripple_1_1io__list.html" title="Manages a set of objects performing asynchronous I/O.">io_list</a> exists in the caller's call stack. </p>
<p class="definition">Definition at line <a class="el" href="io__list_8h_source.html#l00240">240</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="a75973f7aec010c70ecca9ed10353c1af" name="a75973f7aec010c70ecca9ed10353c1af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75973f7aec010c70ecca9ed10353c1af">&#9670;&#160;</a></span>m_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a> ripple::io_list::m_</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#l00055">55</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a5456492974af3655b707975ce21607e9" name="a5456492974af3655b707975ce21607e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5456492974af3655b707975ce21607e9">&#9670;&#160;</a></span>n_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::io_list::n_ = 0</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#l00056">56</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="afb6fed49c10cdfd4a7e3cf232c436e1b" name="afb6fed49c10cdfd4a7e3cf232c436e1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb6fed49c10cdfd4a7e3cf232c436e1b">&#9670;&#160;</a></span>closed_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::io_list::closed_ = false</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#l00057">57</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="ae3f04eaa3c7185aaac34a28655a7972e" name="ae3f04eaa3c7185aaac34a28655a7972e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3f04eaa3c7185aaac34a28655a7972e">&#9670;&#160;</a></span>cv_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a> ripple::io_list::cv_</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#l00058">58</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="a9b990ea25b58ca174f973c76f7bde205" name="a9b990ea25b58ca174f973c76f7bde205"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b990ea25b58ca174f973c76f7bde205">&#9670;&#160;</a></span>map_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_map&lt;<a class="el" href="classripple_1_1io__list_1_1work.html">work</a>*, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html">std::weak_ptr</a>&lt;<a class="el" href="classripple_1_1io__list_1_1work.html">work</a>&gt; &gt; ripple::io_list::map_</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#l00059">59</a> of file <a class="el" href="io__list_8h_source.html">io_list.h</a>.</p>
</div>
</div>
<a id="ad2d110eae45584b04e6f2fb5c89d402d" name="ad2d110eae45584b04e6f2fb5c89d402d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2d110eae45584b04e6f2fb5c89d402d">&#9670;&#160;</a></span>f_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;void(void)&gt; ripple::io_list::f_</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#l00060">60</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>
Reference in New Issue View Git Blame Copy Permalink