168 lines
14 KiB
HTML
168 lines
14 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: pkg/l4re-core/ned/lib/include/cmd_control 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="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="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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</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">
|
|
$(function(){initNavTree('cmd__control_source.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<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">cmd_control</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">// -*- Mode: C++ -*-</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// vim:ft=cpp</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright (C) 2016, 2024 Kernkonzept GmbH.</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Author(s): Sarah Hoffmann <sarah.hoffmann@kernkonzept.com></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <l4/sys/cxx/ipc_epiface></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <l4/sys/cxx/ipc_string></span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="foldopen" id="foldopen00014" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="namespaceL4Re.html"> 14</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4Re.html">L4Re</a> { <span class="keyword">namespace </span>Ned {</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span></div>
|
|
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classL4Re_1_1Ned_1_1Cmd__control.html"> 19</a></span><span class="keyword">class </span><a class="code hl_class" href="classL4Re_1_1Ned_1_1Cmd__control.html">Cmd_control</a> : <span class="keyword">public</span> L4::Kobject_0t<Cmd_control></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>{</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_define" href="ipc__iface.html#a7bc5bdbe269ef0598c166ed1dd923549">L4_INLINE_RPC_NF</a>(<span class="keywordtype">long</span>, <a class="code hl_function" href="classL4Re_1_1Ned_1_1Cmd__control.html#afe210984d1642f4da06eddd39b1fd627">execute</a>, (L4::Ipc::String<> cmd,</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_struct" href="structL4_1_1Ipc_1_1Array.html">L4::Ipc::Array<char></a> &result));</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">public</span>:</div>
|
|
<div class="foldopen" id="foldopen00042" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classL4Re_1_1Ned_1_1Cmd__control.html#afe210984d1642f4da06eddd39b1fd627"> 42</a></span> <span class="keywordtype">long</span> <a class="code hl_function" href="classL4Re_1_1Ned_1_1Cmd__control.html#afe210984d1642f4da06eddd39b1fd627">execute</a>(L4::Ipc::String<> cmd) <span class="keyword">noexcept</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> <a class="code hl_struct" href="structL4_1_1Ipc_1_1Array.html">L4::Ipc::Array<char></a> res(0, NULL);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">return</span> execute_t::call(<a class="code hl_function" href="classL4_1_1Kobject__t.html#a3d80fec7e057d575ec4b393437f05f8a">c</a>(), cmd, res);</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
|
|
<div class="foldopen" id="foldopen00064" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classL4Re_1_1Ned_1_1Cmd__control.html#ac11ac55759d345c33cfc2c627d63de29"> 64</a></span> <span class="keywordtype">long</span> <a class="code hl_function" href="classL4Re_1_1Ned_1_1Cmd__control.html#ac11ac55759d345c33cfc2c627d63de29">execute</a>(L4::Ipc::String<> cmd,</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> L4::Ipc::String<char> *result) <span class="keyword">noexcept</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_struct" href="structL4_1_1Ipc_1_1Array.html">L4::Ipc::Array<char></a> res(result->length, result->data);</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">long</span> r = execute_t::call(<a class="code hl_function" href="classL4_1_1Kobject__t.html#a3d80fec7e057d575ec4b393437f05f8a">c</a>(), cmd, res);</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">if</span> (r >= 0)</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> result->length = res.length;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">return</span> r;</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="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">typedef</span> <a class="code hl_struct" href="structL4_1_1Typeid_1_1Rpcs.html">L4::Typeid::Rpcs<execute_t></a> Rpcs;</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>};</div>
|
|
</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="comment">// namespace</span></div>
|
|
</div>
|
|
<div class="ttc" id="aclassL4Re_1_1Ned_1_1Cmd__control_html"><div class="ttname"><a href="classL4Re_1_1Ned_1_1Cmd__control.html">L4Re::Ned::Cmd_control</a></div><div class="ttdoc">Direct control interface for Ned.</div><div class="ttdef"><b>Definition</b> <a href="#l00019">cmd_control:20</a></div></div>
|
|
<div class="ttc" id="aclassL4Re_1_1Ned_1_1Cmd__control_html_ac11ac55759d345c33cfc2c627d63de29"><div class="ttname"><a href="classL4Re_1_1Ned_1_1Cmd__control.html#ac11ac55759d345c33cfc2c627d63de29">L4Re::Ned::Cmd_control::execute</a></div><div class="ttdeci">long execute(L4::Ipc::String<> cmd, L4::Ipc::String< char > *result) noexcept</div><div class="ttdoc">Execute the given Lua code.</div><div class="ttdef"><b>Definition</b> <a href="#l00064">cmd_control:64</a></div></div>
|
|
<div class="ttc" id="aclassL4Re_1_1Ned_1_1Cmd__control_html_afe210984d1642f4da06eddd39b1fd627"><div class="ttname"><a href="classL4Re_1_1Ned_1_1Cmd__control.html#afe210984d1642f4da06eddd39b1fd627">L4Re::Ned::Cmd_control::execute</a></div><div class="ttdeci">long execute(L4::Ipc::String<> cmd) noexcept</div><div class="ttdoc">Execute the given Lua code.</div><div class="ttdef"><b>Definition</b> <a href="#l00042">cmd_control:42</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Kobject__t_html_a3d80fec7e057d575ec4b393437f05f8a"><div class="ttname"><a href="classL4_1_1Kobject__t.html#a3d80fec7e057d575ec4b393437f05f8a">L4::Kobject_t< Derived, L4::Kobject, L4::PROTO_ANY, Type_info::Demand_t<> >::c</a></div><div class="ttdeci">L4::Cap< Class > c() const noexcept</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00769">__typeinfo.h:769</a></div></div>
|
|
<div class="ttc" id="aipc__iface_html_a7bc5bdbe269ef0598c166ed1dd923549"><div class="ttname"><a href="ipc__iface.html#a7bc5bdbe269ef0598c166ed1dd923549">L4_INLINE_RPC_NF</a></div><div class="ttdeci">#define L4_INLINE_RPC_NF(res, name, args...)</div><div class="ttdoc">Define an inline RPC call type (the type only, no callable).</div><div class="ttdef"><b>Definition</b> <a href="ipc__iface_source.html#l00453">ipc_iface:453</a></div></div>
|
|
<div class="ttc" id="anamespaceL4Re_html"><div class="ttname"><a href="namespaceL4Re.html">L4Re</a></div><div class="ttdoc">L4Re C++ Interfaces.</div><div class="ttdef"><b>Definition</b> <a href="#l00014">cmd_control:14</a></div></div>
|
|
<div class="ttc" id="astructL4_1_1Ipc_1_1Array_html"><div class="ttname"><a href="structL4_1_1Ipc_1_1Array.html">L4::Ipc::Array</a></div><div class="ttdoc">Array data type for dynamically sized arrays in RPCs.</div><div class="ttdef"><b>Definition</b> <a href="ipc__array_source.html#l00081">ipc_array:82</a></div></div>
|
|
<div class="ttc" id="astructL4_1_1Typeid_1_1Rpcs_html"><div class="ttname"><a href="structL4_1_1Typeid_1_1Rpcs.html">L4::Typeid::Rpcs</a></div><div class="ttdoc">Standard list of RPCs of an interface.</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00428">__typeinfo.h:428</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>pkg</b></li><li class="navelem"><b>l4re-core</b></li><li class="navelem"><b>ned</b></li><li class="navelem"><b>lib</b></li><li class="navelem"><b>include</b></li><li class="navelem"><b>cmd_control</b></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|