Files
rippled/semaphore_8h_source.html
2025-11-03 23:17:02 -08:00

190 lines
22 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: semaphore.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_ba3df07e81ea6c232f7f0c8823316f62.html">core</a></li><li class="navelem"><a class="el" href="dir_ba227d129a24ecf2cd1f513aa6e21996.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">semaphore.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#ifndef XRPL_CORE_SEMAPHORE_H_INCLUDED</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#define XRPL_CORE_SEMAPHORE_H_INCLUDED</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/condition_variable.html">condition_variable</a>&gt;</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a>&gt;</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Mutex, <span class="keyword">class</span> CondVar&gt;</div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="};">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html"> 57</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1basic__semaphore.html">basic_semaphore</a></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>{</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc"> 60</a></span> Mutex <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be"> 61</a></span> CondVar <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999"> 62</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a70b65a73bd62bd3b1e15f25297514494"> 65</a></span> <span class="keyword">using </span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">size_type</a> = <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="foldopen" id="foldopen00070" data-start="{" data-end="}">
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b"> 70</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b">basic_semaphore</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">size_type</a> count = 0) : <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>(count)</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> {</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00076" data-start="{" data-end="}">
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c"> 76</a></span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c">notify</a>()</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lock{<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>};</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> ++<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>.notify_one();</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> }</div>
</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="}">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b"> 85</a></span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b">wait</a>()</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> {</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a> lock{<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>};</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">while</span> (<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a> == 0)</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>.wait(lock);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> --<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> }</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00097" data-start="{" data-end="}">
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013"> 97</a></span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013">try_wait</a>()</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> {</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lock{<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>};</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a> == 0)</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> --<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>};</div>
</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="namespaceripple.html#a3d1073988f9cea389d752de1ffb8803d"> 107</a></span><span class="keyword">using </span><a class="code hl_class" href="classripple_1_1basic__semaphore.html">semaphore</a> = <a class="code hl_class" href="classripple_1_1basic__semaphore.html">basic_semaphore&lt;std::mutex, std::condition_variable&gt;</a>;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html"><div class="ttname"><a href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a></div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00057">semaphore.h:58</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_a4cdfd0582d4673cb56de9d9de689aadc"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">ripple::basic_semaphore::m_mutex</a></div><div class="ttdeci">Mutex m_mutex</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00060">semaphore.h:60</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_a4e32a2af04d2aadf63f616543049f999"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">ripple::basic_semaphore::m_count</a></div><div class="ttdeci">std::size_t m_count</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00062">semaphore.h:62</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_a4f15dff9ed04010b49cef17aa46b683b"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b">ripple::basic_semaphore::wait</a></div><div class="ttdeci">void wait()</div><div class="ttdoc">Block until notify is called.</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00085">semaphore.h:85</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_a881f36997b728fa7093cc0fed4150d8b"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b">ripple::basic_semaphore::basic_semaphore</a></div><div class="ttdeci">basic_semaphore(size_type count=0)</div><div class="ttdoc">Create the semaphore, with an optional initial count.</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00070">semaphore.h:70</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_a8b281f8b0690027c7f5c8071e866a013"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013">ripple::basic_semaphore::try_wait</a></div><div class="ttdeci">bool try_wait()</div><div class="ttdoc">Perform a non-blocking wait.</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00097">semaphore.h:97</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_ae88049f63899f4ed72c788b4b1f989be"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">ripple::basic_semaphore::m_cond</a></div><div class="ttdeci">CondVar m_cond</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00061">semaphore.h:61</a></div></div>
<div class="ttc" id="aclassripple_1_1basic__semaphore_html_afb527f24d3a10d885892f8f46d8ce49c"><div class="ttname"><a href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c">ripple::basic_semaphore::notify</a></div><div class="ttdeci">void notify()</div><div class="ttdoc">Increment the count and unblock one waiting thread.</div><div class="ttdef"><b>Definition</b> <a href="semaphore_8h_source.html#l00076">semaphore.h:76</a></div></div>
<div class="ttc" id="acondition_variable_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/condition_variable.html">condition_variable</a></div></div>
<div class="ttc" id="alock_guard_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a></div></div>
<div class="ttc" id="amutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="aunique_lock_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a></div></div>
</div><!-- fragment --></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>