mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
178 lines
18 KiB
HTML
178 lines
18 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: Spawn.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&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&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&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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_9d7e4921ea2f62e76f4d31f5afd6d533.html">server</a></li><li class="navelem"><a class="el" href="dir_7e087469d2ac96de512fc3a89c49a74a.html">detail</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Spawn.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="preprocessor">#ifndef XRPL_SERVER_SPAWN_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SERVER_SPAWN_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <xrpl/basics/Log.h></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <boost/asio/spawn.hpp></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <boost/asio/strand.hpp></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/concepts.html">concepts</a>></span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="foldopen" id="foldopen00012" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespaceripple_1_1util.html"> 12</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple_1_1util.html">ripple::util</a> {</div>
|
|
<div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespaceripple_1_1util_1_1impl.html"> 13</a></span><span class="keyword">namespace </span>impl {</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="conceptripple_1_1util_1_1impl_1_1IsStrand.html"> 16</a></span><span class="keyword">concept </span><a class="code hl_concept" href="conceptripple_1_1util_1_1impl_1_1IsStrand.html">IsStrand</a> = <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::same_as</a><</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/decay.html">std::decay_t<T></a>,</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> boost::asio::strand<typename std::decay_t<T>::inner_executor_type>>;</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespaceripple_1_1util_1_1impl.html#a12da36ffe2bf0936066374d041a8f332"> 30</a></span><span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_variable" href="namespaceripple_1_1util_1_1impl.html#a12da36ffe2bf0936066374d041a8f332">kPROPAGATE_EXCEPTIONS</a> = [](<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/error/exception_ptr.html">std::exception_ptr</a> ePtr) {</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">if</span> (ePtr)</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> {</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">try</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> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/error/rethrow_exception.html">std::rethrow_exception</a>(ePtr);</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="keywordflow">catch</span> (<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/error/exception.html">std::exception</a> <span class="keyword">const</span>& e)</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> JLOG(<a class="code hl_function" href="namespaceripple.html#a94e13759bd026c8ac305482e17f05adb">debugLog</a>().warn()) << <span class="stringliteral">"Spawn exception: "</span> << e.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/error/exception/what.html">what</a>();</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">throw</span>;</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> }</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">catch</span> (...)</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> JLOG(<a class="code hl_function" href="namespaceripple.html#a94e13759bd026c8ac305482e17f05adb">debugLog</a>().warn()) << <span class="stringliteral">"Spawn exception: Unknown"</span>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">throw</span>;</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> }</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>} <span class="comment">// namespace impl</span></div>
|
|
</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="keyword">template</span> <<span class="keyword">typename</span> Ctx, <span class="keyword">typename</span> F></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">requires</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_invocable_r_v<void, F, boost::asio::yield_context></a></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keywordtype">void</span></div>
|
|
<div class="foldopen" id="foldopen00068" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="namespaceripple_1_1util.html#a655f955a56ba1c435b6e4c0f8e49dc14"> 68</a></span><a class="code hl_function" href="namespaceripple_1_1util.html#a655f955a56ba1c435b6e4c0f8e49dc14">spawn</a>(Ctx&& ctx, F&& func)</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>{</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (<a class="code hl_concept" href="conceptripple_1_1util_1_1impl_1_1IsStrand.html">impl::IsStrand<Ctx></a>)</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> boost::asio::spawn(</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward<Ctx></a>(ctx),</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward<F></a>(func),</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_variable" href="namespaceripple_1_1util_1_1impl.html#a12da36ffe2bf0936066374d041a8f332">impl::kPROPAGATE_EXCEPTIONS</a>);</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> }</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">else</span></div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> {</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> boost::asio::spawn(</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> boost::asio::make_strand(</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> boost::asio::get_associated_executor(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward<Ctx></a>(ctx))),</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward<F></a>(func),</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_variable" href="namespaceripple_1_1util_1_1impl.html#a12da36ffe2bf0936066374d041a8f332">impl::kPROPAGATE_EXCEPTIONS</a>);</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</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 class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>} <span class="comment">// namespace ripple::util</span></div>
|
|
</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aconceptripple_1_1util_1_1impl_1_1IsStrand_html"><div class="ttname"><a href="conceptripple_1_1util_1_1impl_1_1IsStrand.html">ripple::util::impl::IsStrand</a></div><div class="ttdef"><b>Definition</b> <a href="Spawn_8h_source.html#l00016">Spawn.h:16</a></div></div>
|
|
<div class="ttc" id="aconcepts_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/concepts.html">concepts</a></div></div>
|
|
<div class="ttc" id="adecay_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/decay.html">std::decay_t</a></div></div>
|
|
<div class="ttc" id="aexception_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/exception.html">std::exception</a></div></div>
|
|
<div class="ttc" id="aexception_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/exception_ptr.html">std::exception_ptr</a></div></div>
|
|
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1util_1_1impl_html_a12da36ffe2bf0936066374d041a8f332"><div class="ttname"><a href="namespaceripple_1_1util_1_1impl.html#a12da36ffe2bf0936066374d041a8f332">ripple::util::impl::kPROPAGATE_EXCEPTIONS</a></div><div class="ttdeci">constexpr auto kPROPAGATE_EXCEPTIONS</div><div class="ttdoc">A completion handler that restores boost::asio::spawn's behaviour from Boost 1.83.</div><div class="ttdef"><b>Definition</b> <a href="Spawn_8h_source.html#l00030">Spawn.h:30</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1util_html"><div class="ttname"><a href="namespaceripple_1_1util.html">ripple::util</a></div><div class="ttdef"><b>Definition</b> <a href="Spawn_8h_source.html#l00012">Spawn.h:12</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1util_html_a655f955a56ba1c435b6e4c0f8e49dc14"><div class="ttname"><a href="namespaceripple_1_1util.html#a655f955a56ba1c435b6e4c0f8e49dc14">ripple::util::spawn</a></div><div class="ttdeci">void spawn(Ctx &&ctx, F &&func)</div><div class="ttdoc">Spawns a coroutine using boost::asio::spawn</div><div class="ttdef"><b>Definition</b> <a href="Spawn_8h_source.html#l00068">Spawn.h:68</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a94e13759bd026c8ac305482e17f05adb"><div class="ttname"><a href="namespaceripple.html#a94e13759bd026c8ac305482e17f05adb">ripple::debugLog</a></div><div class="ttdeci">beast::Journal debugLog()</div><div class="ttdoc">Returns a debug journal.</div><div class="ttdef"><b>Definition</b> <a href="Log_8cpp_source.html#l00457">Log.cpp:457</a></div></div>
|
|
<div class="ttc" id="arethrow_exception_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/rethrow_exception.html">std::rethrow_exception</a></div><div class="ttdeci">T rethrow_exception(T... args)</div></div>
|
|
<div class="ttc" id="atype_traits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a></div></div>
|
|
<div class="ttc" id="awhat_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/exception/what.html">std::exception::what</a></div><div class="ttdeci">T what(T... args)</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|