mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
169 lines
20 KiB
HTML
169 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<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: 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 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&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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_d7c39fc6a58949d9b8efa0ea0aabeed8.html">core</a></li><li class="navelem"><a class="el" href="dir_46cfd23d8d12b129f8fcd173d5f01b52.html">impl</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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_CORE_SEMAPHORE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_CORE_SEMAPHORE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/condition_variable.html">condition_variable</a>></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">template</span> <<span class="keyword">class</span> Mutex, <span class="keyword">class</span> CondVar></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1basic__semaphore.html">basic_semaphore</a></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc"> 32</a></span>  Mutex <a class="code" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be"> 33</a></span>  CondVar <a class="code" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999"> 34</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a70b65a73bd62bd3b1e15f25297514494"> 37</a></span>  <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">size_type</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b"> 42</a></span>  <span class="keyword">explicit</span> <a class="code" href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b">basic_semaphore</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">size_type</a> count = 0)</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  : <a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a> (count)</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c"> 48</a></span>  <span class="keywordtype">void</span> <a class="code" href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c">notify</a> ()</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lock{<a class="code" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>};</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ++<a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>.notify_one ();</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b"> 56</a></span>  <span class="keywordtype">void</span> <a class="code" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b">wait</a> ()</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a> lock{<a class="code" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>};</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">while</span> (<a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a> == 0)</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>.wait (lock);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  --<a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013"> 67</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013">try_wait</a> ()</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  {</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lock{<a class="code" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>};</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a> == 0)</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  --<a class="code" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="namespaceripple.html#a4a5d6c7c86203893fb6acf4b0821c802"> 77</a></span> <span class="keyword">using</span> <a class="code" href="classripple_1_1basic__semaphore.html">semaphore</a> = <a class="code" href="classripple_1_1basic__semaphore.html">basic_semaphore <std::mutex, std::condition_variable></a>;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">// ripple</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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 class="ttdoc">STL class.</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#l00032">semaphore.h:32</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#l00033">semaphore.h:33</a></div></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#l00029">semaphore.h:29</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#l00056">semaphore.h:56</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 class="ttdoc">STL class.</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#l00042">semaphore.h:42</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#l00048">semaphore.h:48</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#l00067">semaphore.h:67</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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#l00034">semaphore.h:34</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="amutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</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>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|