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

715 lines
39 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: beast::io_latency_probe&lt; Clock &gt; Class Template 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="namespacebeast.html">beast</a></li><li class="navelem"><a class="el" href="classbeast_1_1io__latency__probe.html">io_latency_probe</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-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classbeast_1_1io__latency__probe-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">beast::io_latency_probe&lt; Clock &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Measures handler latency on an io_context queue.
<a href="classbeast_1_1io__latency__probe.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for beast::io_latency_probe&lt; Clock &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classbeast_1_1io__latency__probe__coll__graph.png" border="0" usemap="#abeast_1_1io__latency__probe_3_01Clock_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="abeast_1_1io__latency__probe_3_01Clock_01_4_coll__map" id="abeast_1_1io__latency__probe_3_01Clock_01_4_coll__map">
<area shape="rect" title="Measures handler latency on an io_context queue." alt="" coords="200,93,377,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="5,5,164,31"/>
<area shape="poly" title=" " alt="" coords="123,34,249,91,246,96,121,39"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/condition_variable_any.html" title=" " alt="" coords="188,5,389,31"/>
<area shape="poly" title=" " alt="" coords="291,44,291,93,286,93,286,44"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="414,5,502,31"/>
<area shape="poly" title=" " alt="" coords="426,40,324,95,322,91,424,35"/>
</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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbeast_1_1io__latency__probe_1_1sample__op.html">sample_op</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:ac0e358f4a3a4671f79406fc47c2e4fb3" id="r_ac0e358f4a3a4671f79406fc47c2e4fb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#ac0e358f4a3a4671f79406fc47c2e4fb3">io_latency_probe</a> (<a class="el" href="classbeast_1_1io__latency__probe.html#a686c16ebff88519c5a04a9be08b86b04">duration</a> const &amp;period, boost::asio::io_context &amp;ios)</td></tr>
<tr class="separator:ac0e358f4a3a4671f79406fc47c2e4fb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa96df10dfc2d320b6a87e168cb55f729" id="r_aa96df10dfc2d320b6a87e168cb55f729"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#aa96df10dfc2d320b6a87e168cb55f729">~io_latency_probe</a> ()</td></tr>
<tr class="separator:aa96df10dfc2d320b6a87e168cb55f729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a583609000bb804d60aa7404f8d01762b" id="r_a583609000bb804d60aa7404f8d01762b"><td class="memTemplParams" colspan="2">template&lt;class Handler &gt; </td></tr>
<tr class="memitem:a583609000bb804d60aa7404f8d01762b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a583609000bb804d60aa7404f8d01762b">sample_one</a> (Handler &amp;&amp;handler)</td></tr>
<tr class="memdesc:a583609000bb804d60aa7404f8d01762b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Measure one sample of i/o latency. <br /></td></tr>
<tr class="separator:a583609000bb804d60aa7404f8d01762b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d31e25fc6af4e3ed0ff85c82e0a5599" id="r_a0d31e25fc6af4e3ed0ff85c82e0a5599"><td class="memTemplParams" colspan="2">template&lt;class Handler &gt; </td></tr>
<tr class="memitem:a0d31e25fc6af4e3ed0ff85c82e0a5599"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a0d31e25fc6af4e3ed0ff85c82e0a5599">sample</a> (Handler &amp;&amp;handler)</td></tr>
<tr class="memdesc:a0d31e25fc6af4e3ed0ff85c82e0a5599"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate continuous i/o latency sampling. <br /></td></tr>
<tr class="separator:a0d31e25fc6af4e3ed0ff85c82e0a5599"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:aa588798e305a23b3ce4b7e4d8afa9c0f" id="r_aa588798e305a23b3ce4b7e4d8afa9c0f"><td class="memItemLeft" align="right" valign="top">boost::asio::io_context &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#aa588798e305a23b3ce4b7e4d8afa9c0f">get_io_context</a> ()</td></tr>
<tr class="memdesc:aa588798e305a23b3ce4b7e4d8afa9c0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the io_context associated with the latency probe. <br /></td></tr>
<tr class="separator:aa588798e305a23b3ce4b7e4d8afa9c0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d616ba99914b172233dd64dc68ada34" id="r_a3d616ba99914b172233dd64dc68ada34"><td class="memItemLeft" align="right" valign="top">boost::asio::io_context const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a3d616ba99914b172233dd64dc68ada34">get_io_context</a> () const</td></tr>
<tr class="separator:a3d616ba99914b172233dd64dc68ada34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a3aacab2155a327714b711dc3dbc8c69c" id="r_a3aacab2155a327714b711dc3dbc8c69c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a3aacab2155a327714b711dc3dbc8c69c">cancel</a> ()</td></tr>
<tr class="memdesc:a3aacab2155a327714b711dc3dbc8c69c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel all pending i/o. <br /></td></tr>
<tr class="separator:a3aacab2155a327714b711dc3dbc8c69c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adaee7525295db67f85573a6b73eff113" id="r_adaee7525295db67f85573a6b73eff113"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#adaee7525295db67f85573a6b73eff113">cancel_async</a> ()</td></tr>
<tr class="separator:adaee7525295db67f85573a6b73eff113"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a686c16ebff88519c5a04a9be08b86b04" id="r_a686c16ebff88519c5a04a9be08b86b04"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a686c16ebff88519c5a04a9be08b86b04">duration</a> = typename Clock::duration</td></tr>
<tr class="separator:a686c16ebff88519c5a04a9be08b86b04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3e7ad1c48054c4e9363aa7a4d69bc1d" id="r_af3e7ad1c48054c4e9363aa7a4d69bc1d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#af3e7ad1c48054c4e9363aa7a4d69bc1d">time_point</a> = typename Clock::time_point</td></tr>
<tr class="separator:af3e7ad1c48054c4e9363aa7a4d69bc1d"><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:abb9c67df3d6e343c2712618752c6ad5f" id="r_abb9c67df3d6e343c2712618752c6ad5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#abb9c67df3d6e343c2712618752c6ad5f">cancel</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a>&lt; decltype(<a class="el" href="classbeast_1_1io__latency__probe.html#a29c18ff449978ef74989fce7dc4d8bae">m_mutex</a>)&gt; &amp;lock, bool wait)</td></tr>
<tr class="separator:abb9c67df3d6e343c2712618752c6ad5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ad793e4145f2062fcbe2a2c25dde6c4" id="r_a4ad793e4145f2062fcbe2a2c25dde6c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a4ad793e4145f2062fcbe2a2c25dde6c4">addref</a> ()</td></tr>
<tr class="separator:a4ad793e4145f2062fcbe2a2c25dde6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f82fe723caebead49ca8bdf479ebc22" id="r_a7f82fe723caebead49ca8bdf479ebc22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a7f82fe723caebead49ca8bdf479ebc22">release</a> ()</td></tr>
<tr class="separator:a7f82fe723caebead49ca8bdf479ebc22"><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:a29c18ff449978ef74989fce7dc4d8bae" id="r_a29c18ff449978ef74989fce7dc4d8bae"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a29c18ff449978ef74989fce7dc4d8bae">m_mutex</a></td></tr>
<tr class="separator:a29c18ff449978ef74989fce7dc4d8bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcfd188c27ce5224fd41dc8cf0e2d659" id="r_abcfd188c27ce5224fd41dc8cf0e2d659"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable_any.html">std::condition_variable_any</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#abcfd188c27ce5224fd41dc8cf0e2d659">m_cond</a></td></tr>
<tr class="separator:abcfd188c27ce5224fd41dc8cf0e2d659"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a783c2279e0f950923ffdbdd8997ce8c3" id="r_a783c2279e0f950923ffdbdd8997ce8c3"><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="classbeast_1_1io__latency__probe.html#a783c2279e0f950923ffdbdd8997ce8c3">m_count</a></td></tr>
<tr class="separator:a783c2279e0f950923ffdbdd8997ce8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e42d183a6ff580915cb318ce995870b" id="r_a0e42d183a6ff580915cb318ce995870b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1io__latency__probe.html#a686c16ebff88519c5a04a9be08b86b04">duration</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a0e42d183a6ff580915cb318ce995870b">m_period</a></td></tr>
<tr class="separator:a0e42d183a6ff580915cb318ce995870b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae383624a03cc91e1c9f71d67a931958" id="r_aae383624a03cc91e1c9f71d67a931958"><td class="memItemLeft" align="right" valign="top">boost::asio::io_context &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#aae383624a03cc91e1c9f71d67a931958">m_ios</a></td></tr>
<tr class="separator:aae383624a03cc91e1c9f71d67a931958"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36fc1e9d3fa836e6f8913643eed50707" id="r_a36fc1e9d3fa836e6f8913643eed50707"><td class="memItemLeft" align="right" valign="top">boost::asio::basic_waitable_timer&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#a36fc1e9d3fa836e6f8913643eed50707">m_timer</a></td></tr>
<tr class="separator:a36fc1e9d3fa836e6f8913643eed50707"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc81df0e2b1263891edacabf50bc9477" id="r_afc81df0e2b1263891edacabf50bc9477"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1io__latency__probe.html#afc81df0e2b1263891edacabf50bc9477">m_cancel</a></td></tr>
<tr class="separator:afc81df0e2b1263891edacabf50bc9477"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class Clock&gt;<br />
class beast::io_latency_probe&lt; Clock &gt;</div><p>Measures handler latency on an io_context queue. </p>
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00019">19</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a686c16ebff88519c5a04a9be08b86b04" name="a686c16ebff88519c5a04a9be08b86b04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a686c16ebff88519c5a04a9be08b86b04">&#9670;&#160;</a></span>duration</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::duration = typename Clock::duration</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__latency__probe_8h_source.html#l00022">22</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="af3e7ad1c48054c4e9363aa7a4d69bc1d" name="af3e7ad1c48054c4e9363aa7a4d69bc1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3e7ad1c48054c4e9363aa7a4d69bc1d">&#9670;&#160;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::time_point = typename Clock::time_point</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__latency__probe_8h_source.html#l00023">23</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac0e358f4a3a4671f79406fc47c2e4fb3" name="ac0e358f4a3a4671f79406fc47c2e4fb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0e358f4a3a4671f79406fc47c2e4fb3">&#9670;&#160;</a></span>io_latency_probe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::io_latency_probe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1io__latency__probe.html#a686c16ebff88519c5a04a9be08b86b04">duration</a> const &amp;&#160;</td>
<td class="paramname"><em>period</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::asio::io_context &amp;&#160;</td>
<td class="paramname"><em>ios</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00034">34</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="aa96df10dfc2d320b6a87e168cb55f729" name="aa96df10dfc2d320b6a87e168cb55f729"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa96df10dfc2d320b6a87e168cb55f729">&#9670;&#160;</a></span>~io_latency_probe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::~<a class="el" href="classbeast_1_1io__latency__probe.html">io_latency_probe</a> </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__latency__probe_8h_source.html#l00043">43</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa588798e305a23b3ce4b7e4d8afa9c0f" name="aa588798e305a23b3ce4b7e4d8afa9c0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa588798e305a23b3ce4b7e4d8afa9c0f">&#9670;&#160;</a></span>get_io_context() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">boost::asio::io_context &amp; <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::get_io_context </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the io_context associated with the latency probe. </p>
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00052">52</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a3d616ba99914b172233dd64dc68ada34" name="a3d616ba99914b172233dd64dc68ada34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d616ba99914b172233dd64dc68ada34">&#9670;&#160;</a></span>get_io_context() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">boost::asio::io_context const &amp; <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::get_io_context </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00058">58</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a3aacab2155a327714b711dc3dbc8c69c" name="a3aacab2155a327714b711dc3dbc8c69c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aacab2155a327714b711dc3dbc8c69c">&#9670;&#160;</a></span>cancel() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::cancel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel all pending i/o. </p>
<p>Any handlers which have already been queued will still be called. </p>
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00069">69</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="adaee7525295db67f85573a6b73eff113" name="adaee7525295db67f85573a6b73eff113"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaee7525295db67f85573a6b73eff113">&#9670;&#160;</a></span>cancel_async()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::cancel_async </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__latency__probe_8h_source.html#l00076">76</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a583609000bb804d60aa7404f8d01762b" name="a583609000bb804d60aa7404f8d01762b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a583609000bb804d60aa7404f8d01762b">&#9670;&#160;</a></span>sample_one()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<div class="memtemplate">
template&lt;class Handler &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::sample_one </td>
<td>(</td>
<td class="paramtype">Handler &amp;&amp;&#160;</td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Measure one sample of i/o latency. </p>
<p>Handler will be called with this signature: void Handler (Duration d); </p>
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00089">89</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a0d31e25fc6af4e3ed0ff85c82e0a5599" name="a0d31e25fc6af4e3ed0ff85c82e0a5599"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d31e25fc6af4e3ed0ff85c82e0a5599">&#9670;&#160;</a></span>sample()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<div class="memtemplate">
template&lt;class Handler &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::sample </td>
<td>(</td>
<td class="paramtype">Handler &amp;&amp;&#160;</td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initiate continuous i/o latency sampling. </p>
<p>Handler will be called with this signature: void Handler (<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>); </p>
<p class="definition">Definition at line <a class="el" href="io__latency__probe_8h_source.html#l00106">106</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="abb9c67df3d6e343c2712618752c6ad5f" name="abb9c67df3d6e343c2712618752c6ad5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb9c67df3d6e343c2712618752c6ad5f">&#9670;&#160;</a></span>cancel() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::cancel </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a>&lt; decltype(<a class="el" href="classbeast_1_1io__latency__probe.html#a29c18ff449978ef74989fce7dc4d8bae">m_mutex</a>)&gt; &amp;&#160;</td>
<td class="paramname"><em>lock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>wait</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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__latency__probe_8h_source.html#l00119">119</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a4ad793e4145f2062fcbe2a2c25dde6c4" name="a4ad793e4145f2062fcbe2a2c25dde6c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ad793e4145f2062fcbe2a2c25dde6c4">&#9670;&#160;</a></span>addref()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::addref </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__latency__probe_8h_source.html#l00132">132</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a7f82fe723caebead49ca8bdf479ebc22" name="a7f82fe723caebead49ca8bdf479ebc22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f82fe723caebead49ca8bdf479ebc22">&#9670;&#160;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::release </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__latency__probe_8h_source.html#l00139">139</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a29c18ff449978ef74989fce7dc4d8bae" name="a29c18ff449978ef74989fce7dc4d8bae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29c18ff449978ef74989fce7dc4d8bae">&#9670;&#160;</a></span>m_mutex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<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/recursive_mutex.html">std::recursive_mutex</a> <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_mutex</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__latency__probe_8h_source.html#l00025">25</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="abcfd188c27ce5224fd41dc8cf0e2d659" name="abcfd188c27ce5224fd41dc8cf0e2d659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcfd188c27ce5224fd41dc8cf0e2d659">&#9670;&#160;</a></span>m_cond</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<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_any.html">std::condition_variable_any</a> <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_cond</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__latency__probe_8h_source.html#l00026">26</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a783c2279e0f950923ffdbdd8997ce8c3" name="a783c2279e0f950923ffdbdd8997ce8c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a783c2279e0f950923ffdbdd8997ce8c3">&#9670;&#160;</a></span>m_count</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<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> <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_count</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__latency__probe_8h_source.html#l00027">27</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a0e42d183a6ff580915cb318ce995870b" name="a0e42d183a6ff580915cb318ce995870b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e42d183a6ff580915cb318ce995870b">&#9670;&#160;</a></span>m_period</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1io__latency__probe.html#a686c16ebff88519c5a04a9be08b86b04">duration</a> const <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_period</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__latency__probe_8h_source.html#l00028">28</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="aae383624a03cc91e1c9f71d67a931958" name="aae383624a03cc91e1c9f71d67a931958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae383624a03cc91e1c9f71d67a931958">&#9670;&#160;</a></span>m_ios</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::asio::io_context&amp; <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_ios</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__latency__probe_8h_source.html#l00029">29</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="a36fc1e9d3fa836e6f8913643eed50707" name="a36fc1e9d3fa836e6f8913643eed50707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36fc1e9d3fa836e6f8913643eed50707">&#9670;&#160;</a></span>m_timer</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::asio::basic_waitable_timer&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a>&gt; <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_timer</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__latency__probe_8h_source.html#l00030">30</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.h</a>.</p>
</div>
</div>
<a id="afc81df0e2b1263891edacabf50bc9477" name="afc81df0e2b1263891edacabf50bc9477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc81df0e2b1263891edacabf50bc9477">&#9670;&#160;</a></span>m_cancel</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classbeast_1_1io__latency__probe.html">beast::io_latency_probe</a>&lt; Clock &gt;::m_cancel</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__latency__probe_8h_source.html#l00031">31</a> of file <a class="el" href="io__latency__probe_8h_source.html">io_latency_probe.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