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/semaphore_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

172 lines
19 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: 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> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#ifndef XRPL_CORE_SEMAPHORE_H_INCLUDED</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#define XRPL_CORE_SEMAPHORE_H_INCLUDED</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</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="l00033" name="l00033"></a><span class="lineno"> 33</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="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</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="foldopen00038" data-start="{" data-end="};">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html"> 38</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="l00039" name="l00039"></a><span class="lineno"> 39</span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc"> 41</a></span> Mutex <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be"> 42</a></span> CondVar <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999"> 43</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="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a70b65a73bd62bd3b1e15f25297514494"> 46</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="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b"> 51</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="l00052" name="l00052"></a><span class="lineno"> 52</span> {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span></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#afb527f24d3a10d885892f8f46d8ce49c"> 57</a></span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c">notify</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> <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="l00060" name="l00060"></a><span class="lineno"> 60</span> ++<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>.notify_one();</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b"> 66</a></span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b">wait</a>()</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</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="l00069" name="l00069"></a><span class="lineno"> 69</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="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_variable" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a>.wait(lock);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> --<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</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="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013"> 78</a></span> <a class="code hl_function" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013">try_wait</a>()</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</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="l00081" name="l00081"></a><span class="lineno"> 81</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="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> --<a class="code hl_variable" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a>;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> }</div>
</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>};</div>
</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="namespaceripple.html#a3d1073988f9cea389d752de1ffb8803d"> 88</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="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</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#l00038">semaphore.h:39</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#l00041">semaphore.h:41</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#l00043">semaphore.h:43</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#l00066">semaphore.h:66</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#l00051">semaphore.h:51</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#l00078">semaphore.h:78</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#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#l00057">semaphore.h:57</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#l00006">algorithm.h:6</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>
Reference in New Issue View Git Blame Copy Permalink