-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathagent_2runners_2lua_2impl_8hpp_source.html
179 lines (177 loc) · 19.8 KB
/
agent_2runners_2lua_2impl_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenCBDC Transaction Processor: impl.hpp 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">OpenCBDC Transaction Processor
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('agent_2runners_2lua_2impl_8hpp_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">agent/runners/lua/impl.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="agent_2runners_2lua_2impl_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright (c) 2021 MIT Digital Currency Initiative,</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Federal Reserve Bank of Boston</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// Distributed under the MIT software license, see the accompanying</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// file COPYING or http://www.opensource.org/licenses/mit-license.php.</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">#ifndef OPENCBDC_TX_SRC_PARSEC_AGENT_RUNNER_H_</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#define OPENCBDC_TX_SRC_PARSEC_AGENT_RUNNER_H_</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="code" href="parsec_2agent_2runners_2interface_8hpp.html">parsec/agent/runners/interface.hpp</a>"</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "<a class="code" href="parsec_2util_8hpp.html">parsec/util.hpp</a>"</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <lua.hpp></span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <memory></span></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">namespace </span><a class="code hl_namespace" href="namespacecbdc_1_1parsec_1_1agent_1_1runner.html">cbdc::parsec::agent::runner</a> {</div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="};">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html"> 25</a></span> <span class="keyword">class </span><a class="code hl_class" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html">lua_runner</a> : <span class="keyword">public</span> <a class="code hl_class" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html">interface</a> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_friend" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#a840a7911de8a5de9fd24223ff80aa145">lua_runner</a>(std::shared_ptr<logging::log> logger,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">const</span> <a class="code hl_struct" href="structcbdc_1_1parsec_1_1config.html">cbdc::parsec::config</a>& cfg,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_class" href="classcbdc_1_1buffer.html">runtime_locking_shard::value_type</a> function,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_class" href="classcbdc_1_1buffer.html">parameter_type</a> param,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">bool</span> is_readonly_run,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_typedef" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#a233f652defabda9c2ab3a5a7c6df6b95">run_callback_type</a> result_callback,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_typedef" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#a921cfebcd7367e8310eb9fd9214f445b">try_lock_callback_type</a> try_lock_callback,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> std::shared_ptr<secp256k1_context> secp,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> std::shared_ptr<thread_pool> t_pool,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_typedef" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#ad281d7a5c2939bdb4bad95fc40d441cd">ticket_number_type</a> ticket_number);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> [[nodiscard]] <span class="keyword">auto</span> <a class="code hl_function" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html#a8e0b6cce317b7e4d919b6dc6c90a83d5">run</a>() -> <span class="keywordtype">bool</span> <span class="keyword">override</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html#a64546966c9dd9864be47f47ff346d064"> 45</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_variable" href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html#a64546966c9dd9864be47f47ff346d064">initial_lock_type</a> = broker::lock_type::read;</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> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> std::shared_ptr<lua_State> m_state;</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="keywordtype">void</span> contract_epilogue(<span class="keywordtype">int</span> n_results);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">auto</span> get_stack_string(<span class="keywordtype">int</span> index) -> std::optional<buffer>;</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">auto</span> get_stack_integer(<span class="keywordtype">int</span> index) -> std::optional<int64_t>;</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="keywordtype">void</span> schedule_contract();</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> handle_try_lock(<span class="keyword">const</span> <a class="code hl_typedef" href="classcbdc_1_1parsec_1_1broker_1_1interface.html#a7ad81d8ee6b0c0df7f8d2070b7e0d6f5">broker::interface::try_lock_return_type</a>& res);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">static</span> <span class="keyword">auto</span> check_sig(lua_State* L) -> int;</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="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclasscbdc_1_1buffer_html"><div class="ttname"><a href="classcbdc_1_1buffer.html">cbdc::buffer</a></div><div class="ttdoc">Buffer to store and retrieve byte data.</div><div class="ttdef"><b>Definition</b> <a href="buffer_8hpp_source.html#l00015">buffer.hpp:15</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1interface_html"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html">cbdc::parsec::agent::runner::interface</a></div><div class="ttdoc">Interface for a contract runner.</div><div class="ttdef"><b>Definition</b> <a href="parsec_2agent_2runners_2interface_8hpp_source.html#l00021">parsec/agent/runners/interface.hpp:21</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1interface_html_a233f652defabda9c2ab3a5a7c6df6b95"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#a233f652defabda9c2ab3a5a7c6df6b95">cbdc::parsec::agent::runner::interface::run_callback_type</a></div><div class="ttdeci">std::function< void(run_return_type)> run_callback_type</div><div class="ttdoc">Callback type for function execution.</div><div class="ttdef"><b>Definition</b> <a href="parsec_2agent_2runners_2interface_8hpp_source.html#l00057">parsec/agent/runners/interface.hpp:57</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1interface_html_a840a7911de8a5de9fd24223ff80aa145"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#a840a7911de8a5de9fd24223ff80aa145">cbdc::parsec::agent::runner::interface::lua_runner</a></div><div class="ttdeci">friend class lua_runner</div><div class="ttdef"><b>Definition</b> <a href="parsec_2agent_2runners_2interface_8hpp_source.html#l00117">parsec/agent/runners/interface.hpp:117</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1interface_html_a921cfebcd7367e8310eb9fd9214f445b"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#a921cfebcd7367e8310eb9fd9214f445b">cbdc::parsec::agent::runner::interface::try_lock_callback_type</a></div><div class="ttdeci">std::function< bool(broker::key_type, broker::lock_type, broker::interface::try_lock_callback_type)> try_lock_callback_type</div><div class="ttdoc">Callback function type for acquiring locks during function execution.</div><div class="ttdef"><b>Definition</b> <a href="parsec_2agent_2runners_2interface_8hpp_source.html#l00062">parsec/agent/runners/interface.hpp:62</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1interface_html_ad281d7a5c2939bdb4bad95fc40d441cd"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1interface.html#ad281d7a5c2939bdb4bad95fc40d441cd">cbdc::parsec::agent::runner::interface::ticket_number_type</a></div><div class="ttdeci">parsec::ticket_machine::ticket_number_type ticket_number_type</div><div class="ttdoc">Type alias for a ticket number.</div><div class="ttdef"><b>Definition</b> <a href="parsec_2agent_2runners_2interface_8hpp_source.html#l00050">parsec/agent/runners/interface.hpp:50</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner_html"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html">cbdc::parsec::agent::runner::lua_runner</a></div><div class="ttdoc">Lua function executor.</div><div class="ttdef"><b>Definition</b> <a href="#l00025">agent/runners/lua/impl.hpp:25</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner_html_a64546966c9dd9864be47f47ff346d064"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html#a64546966c9dd9864be47f47ff346d064">cbdc::parsec::agent::runner::lua_runner::initial_lock_type</a></div><div class="ttdeci">static constexpr auto initial_lock_type</div><div class="ttdoc">Lock type to acquire when requesting the function code.</div><div class="ttdef"><b>Definition</b> <a href="#l00045">agent/runners/lua/impl.hpp:45</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner_html_a8e0b6cce317b7e4d919b6dc6c90a83d5"><div class="ttname"><a href="classcbdc_1_1parsec_1_1agent_1_1runner_1_1lua__runner.html#a8e0b6cce317b7e4d919b6dc6c90a83d5">cbdc::parsec::agent::runner::lua_runner::run</a></div><div class="ttdeci">auto run() -> bool override</div><div class="ttdoc">Begins function execution.</div><div class="ttdef"><b>Definition</b> <a href="agent_2runners_2lua_2impl_8cpp_source.html#l00044">agent/runners/lua/impl.cpp:44</a></div></div>
<div class="ttc" id="aclasscbdc_1_1parsec_1_1broker_1_1interface_html_a7ad81d8ee6b0c0df7f8d2070b7e0d6f5"><div class="ttname"><a href="classcbdc_1_1parsec_1_1broker_1_1interface.html#a7ad81d8ee6b0c0df7f8d2070b7e0d6f5">cbdc::parsec::broker::interface::try_lock_return_type</a></div><div class="ttdeci">std::variant< value_type, error_code, runtime_locking_shard::shard_error > try_lock_return_type</div><div class="ttdoc">Return type from a try lock operation.</div><div class="ttdef"><b>Definition</b> <a href="parsec_2broker_2interface_8hpp_source.html#l00100">parsec/broker/interface.hpp:100</a></div></div>
<div class="ttc" id="anamespacecbdc_1_1parsec_1_1agent_1_1runner_html"><div class="ttname"><a href="namespacecbdc_1_1parsec_1_1agent_1_1runner.html">cbdc::parsec::agent::runner</a></div><div class="ttdef"><b>Definition</b> <a href="address_8cpp_source.html#l00019">address.cpp:19</a></div></div>
<div class="ttc" id="aparsec_2agent_2runners_2interface_8hpp_html"><div class="ttname"><a href="parsec_2agent_2runners_2interface_8hpp.html">interface.hpp</a></div></div>
<div class="ttc" id="aparsec_2util_8hpp_html"><div class="ttname"><a href="parsec_2util_8hpp.html">util.hpp</a></div></div>
<div class="ttc" id="astructcbdc_1_1parsec_1_1config_html"><div class="ttname"><a href="structcbdc_1_1parsec_1_1config.html">cbdc::parsec::config</a></div><div class="ttdoc">Configuration parameters for a phase two system.</div><div class="ttdef"><b>Definition</b> <a href="parsec_2util_8hpp_source.html#l00031">parsec/util.hpp:31</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_3cce81556147031cc47c784f481d4a07.html">parsec</a></li><li class="navelem"><a class="el" href="dir_cac327df0857ffcd3b3be3d64544de41.html">agent</a></li><li class="navelem"><a class="el" href="dir_6ca1fdd38998630ed30fb77209cb6716.html">runners</a></li><li class="navelem"><a class="el" href="dir_e92440125d888c3535dd042258104d55.html">lua</a></li><li class="navelem"><a class="el" href="agent_2runners_2lua_2impl_8hpp.html">impl.hpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>