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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: pdu-json-rpc-api/idl/LuaService.idl 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">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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_6f2e57e4ed4c9ccdca310d1229964312.html">pdu-json-rpc-api</a></li><li class="navelem"><a class="el" href="dir_8ea0db9e05c169824aafe6441489b6ed.html">idl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">LuaService.idl</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">/* SPDX-License-Identifier: BSD-3-Clause */</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"> * Copyright 2015 Raritan Inc. All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</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">/**</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Lua-Service</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Lua-Service is a service that you can use to upload and execute a Lua script.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * When the service is starting, a cleanup will be happend at first. That means</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * still running scripts will be killed and it will be tested for which script is</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * an option given. Does here something not match, then the script or the option</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * will be deleted.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * After the service is launched, the option 'autoRestart' will be for any script</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * evaluated. If the flag is 'true', the script is going to be executed with a</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * short delay (Environment->autoStartDelay).</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * You can download and upload a script with the commands getScript() and setScript().</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * When on uploading the script name is not present a new script will be created.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * If the name is already taken, then the old script will be overwritten.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Use startScript() to execute a lua script and terminateScript() to stop a script.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * If the option 'autoRestart' is set to 'true', then the script starts automatically</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * after it has exited.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * To get the output for a script use the command getScriptOutput(). The output</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * is limited to 'Environment->outputBufferSize' bytes and mapped to a virtual</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * address. On the first query call the method with starting address zero. After</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * that use the returned address 'nAddr' for the next request.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * A script can be called with arguments (see options and startWithArgs).</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespaceluaservice.html"> 35</a></span> module <a class="code" href="namespaceluaservice.html">luaservice</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /**</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * A structure that descripts the state of a script.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * When a script is uploaded the new execState is STAT_NEW. exitCode and</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * signal is not valid.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> *</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * When the execState is changing to STAT_TERMINATED then exitCode and signal</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * will be set.</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html"> 46</a></span>  structure <a class="code" href="structluaservice_1_1ScriptState.html">ScriptState</a> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /** execution state for a scripts */</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a"> 49</a></span>  enumeration <a class="code" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">ExecState</a> {</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aab09641ed1577da07e05ee6b277e523af"> 50</a></span>  <a class="code" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aab09641ed1577da07e05ee6b277e523af">STAT_NEW</a>, <span class="comment">///< the script never ran (after uploading or system (re)start)</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aad69c918089360bccb1193a217408e26c"> 51</a></span> <span class="comment"></span> <a class="code" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aad69c918089360bccb1193a217408e26c">STAT_RUNNING</a>, <span class="comment">///< script state is running</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aa6208fa1b5b50c9d0be550c306bddd09d"> 52</a></span> <span class="comment"></span> <a class="code" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aa6208fa1b5b50c9d0be550c306bddd09d">STAT_TERMINATED</a>, <span class="comment">///< script state is terminated</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aa20ff815d5e0578081b2f7f0fa5a80621"> 53</a></span> <span class="comment"></span> STAT_RESTARTING <span class="comment">///< script is terminated and restarts after 'restart interval'</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span> };</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /** Descripts the type of exitStatus */</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099"> 57</a></span>  enumeration <a class="code" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">ExitType</a> {</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099a48ba8e3f1cdc709aef6aec6c697e5fc4"> 58</a></span>  <a class="code" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099a48ba8e3f1cdc709aef6aec6c697e5fc4">EXIT_CODE</a>, <span class="comment">///< exitStatus is an exit code</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099a0821969cbdb3d255b41052b772dcd236"> 59</a></span> <span class="comment"></span> SIGNAL <span class="comment">///< exitStatus is a signal</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> };</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#a69172b8deba9943aafef325eb86e6cfe"> 62</a></span>  <a class="code" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">ExecState</a> <a class="code" href="structluaservice_1_1ScriptState.html#a69172b8deba9943aafef325eb86e6cfe">execState</a>; <span class="comment">///< execution state of the script</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#aa722eb45f9d9db9d30950e44c52b65f5"> 63</a></span> <span class="comment"></span> <a class="code" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">ExitType</a> <a class="code" href="structluaservice_1_1ScriptState.html#aa722eb45f9d9db9d30950e44c52b65f5">exitType</a>; <span class="comment">///< type of exit code</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptState.html#ac8bd66963eb19fc84fb0b2de19ff47c7"> 64</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1ScriptState.html#ac8bd66963eb19fc84fb0b2de19ff47c7">exitStatus</a>; <span class="comment">///< exit status or signal</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> };</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /** some script options */</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptOptions__2__0__0.html"> 68</a></span>  structure <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html">ScriptOptions_2_0_0</a> {</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptOptions__2__0__0.html#ae54ed21fe2d77ad266da84bd92d4d950"> 69</a></span>  map <string, string> <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html#ae54ed21fe2d77ad266da84bd92d4d950">defaultArgs</a>; <span class="comment">///< default arguments are passed to the lua script</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptOptions__2__0__0.html#a98c23b9d1c37314d356ded58d4ac9f1b"> 70</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html#a98c23b9d1c37314d356ded58d4ac9f1b">autoStart</a>; <span class="comment">///< starts a script after system booting</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structluaservice_1_1ScriptOptions__2__0__0.html#aab5b7c82c2c7a7059ea18aaae7ce24c2"> 71</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html#aab5b7c82c2c7a7059ea18aaae7ce24c2">autoRestart</a>; <span class="comment">///< restarts a script after termination or crash</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> };</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /**</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * The struct represents two kinds of information:</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * - limit (l)</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * - current status (cs)</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * Is a limit set to zero then there is no limit set. The unit of size</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * is byte. The unit of interval is millisecond.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> */</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html"> 81</a></span>  structure <a class="code" href="structluaservice_1_1Environment__2__0__0.html">Environment_2_0_0</a> {</div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#a0b50f8657886e927cb9d06b8d3c2cf7a"> 82</a></span>  <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#a0b50f8657886e927cb9d06b8d3c2cf7a">maxScriptMemoryGrowth</a>;<span class="comment">///< maximum virtual memory growth per script (l)</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#add7352a8cc1a33151ee65119a86fd56e"> 83</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#add7352a8cc1a33151ee65119a86fd56e">maxAmountOfScripts</a>; <span class="comment">///< number of scripts that can be stored (l)</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#a8c1426f551f6216a3c8c7510d49de1f6"> 84</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#a8c1426f551f6216a3c8c7510d49de1f6">amountOfScripts</a>; <span class="comment">///< number of scripts that are stored (cs)</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#a08bfd5bff1d348b94da57c2543523d72"> 85</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#a08bfd5bff1d348b94da57c2543523d72">maxScriptSize</a>; <span class="comment">///< maximum size of a script file (l)</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#a5c3e35134d819f3214a94963a0ea120b"> 86</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#a5c3e35134d819f3214a94963a0ea120b">maxAllScriptSize</a>; <span class="comment">///< maximum size of all script files (l)</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#abd9230fad019b85400bfdea81ad92a0d"> 87</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#abd9230fad019b85400bfdea81ad92a0d">allScriptSize</a>; <span class="comment">///< size of all script files (cs)</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#a5a10160b7ca288e8037c62b406770dc4"> 88</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#a5a10160b7ca288e8037c62b406770dc4">outputBufferSize</a>; <span class="comment">///< output buffer size per script (l)</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#abf71cce8b6d15406b0a6d53650f0ad8e"> 89</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#abf71cce8b6d15406b0a6d53650f0ad8e">restartInterval</a>; <span class="comment">///< minimum delay to next (re)start (cs)</span></div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structluaservice_1_1Environment__2__0__0.html#a87f083466fd431cbe15f169780d3f70c"> 90</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structluaservice_1_1Environment__2__0__0.html#a87f083466fd431cbe15f169780d3f70c">autoStartDelay</a>; <span class="comment">///< minimum delay to 'autoStart' a script</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /**</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * There is a single manager instance.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html"> 96</a></span>  <span class="keyword">interface </span><a class="code" href="interfaceluaservice_1_1Manager__2__0__1.html">Manager_2_0_1</a> {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /** Error codes */</span></div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a9ae1a7e7dd06f1c63ce7449ac26b6225"> 99</a></span>  constant <span class="keywordtype">int</span> NO_ERROR = 0; <span class="comment">///< no Error</span></div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#ac2fc9bf8846eea18931987d1d03b87fb"> 100</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_NAME = 1; <span class="comment">///< script name is invalid</span></div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a320296a4b7fed35c980677dcca1ca9e5"> 101</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_NO_SUCH_SCRIPT = 2; <span class="comment">///< script name not found</span></div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#aa34d245a2a181a4b232a705fc7c8b874"> 102</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_MAX_SCRIPT_NUMBERS_EXCEEDED = 3; <span class="comment">///< maximum amount of stored script files is reached</span></div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a613ebde8ff5a7ce8df611726ba2b6264"> 103</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_MAX_SCRIPT_SIZE_EXCEEDED = 4; <span class="comment">///< maximum size of a script file is reached</span></div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a4313996343d268c6d29982ae3447c998"> 104</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_MAX_ALL_SCRIPT_SIZE_EXCEEDED = 5; <span class="comment">///< maximum size of all script files is reached</span></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a4118520f6bfef52504c5e31a26beadd3"> 105</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_NOT_TERMINATED = 6; <span class="comment">///< script is not terminated</span></div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#ab0329c2f806120c03c615541f2ac8489"> 106</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_NOT_RUNNING = 7; <span class="comment">///< script is not running</span></div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a6b1ab9d1e906acaf1819cef2634cb7c4"> 107</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_ADDR = 8; <span class="comment">///< address parameter is wrong</span></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a7b523a3f49851652dd14fd5fa5ab59eb"> 108</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_TOO_MANY_ARGUMENTS = 10; <span class="comment">///< too many arguments</span></div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="interfaceluaservice_1_1Manager__2__0__1.html#a5bec1f953a33f655122c921820b78eaf"> 109</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_ARGUMENT_NOT_VALID = 11; <span class="comment">///< the argument has one or more invalid characters</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /**</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * Upload a script to instance</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> *</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * If there is a script with the same name the new script will replace</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * the existing script (script must be in STAT_NEW or STAT_TERMINATED).</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> *</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param name The name of the script file</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param script The script file packed in a string</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param options Options that can be set or not</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> *</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @return ERR_INVALID_NAME if script name is invalid</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @return ERR_MAX_SCRIPT_SIZE_EXCEEDED if the size of the new script is greater then the maximum file size</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @return ERR_MAX_ALL_SCRIPT_SIZE_EXCEEDED if maximum size of all script files is reached</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @return ERR_MAX_SCRIPT_NUMBERS_EXCEEDED if maximum amount of script files is reached</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @return ERR_NOT_TERMINATED if try to replace a running script</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">int</span> setScript(in <span class="keywordtype">string</span> name, in <span class="keywordtype">string</span> script, in <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html">ScriptOptions_2_0_0</a> options);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /**</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * To download a script file to user.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> *</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @param name The name of an existing script</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> *</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @return ERR_INVALID_NAME if script name is invalid</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> */</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">int</span> getScript(in <span class="keywordtype">string</span> name, out <span class="keywordtype">string</span> script);</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /**</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * Returns all script names in a string vector.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> *</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * If there are no scripts the vector is empty.</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> *</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * @return A vector with all script names.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> */</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  vector<string> getScriptNames();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> /**</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * Deletes a script.</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> *</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param name The name of the script</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> *</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @return ERR_INVALID_NAME if script name is invalid</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @return ERR_NOT_TERMINATED if try to delete a running script</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> */</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">int</span> deleteScript(in <span class="keywordtype">string</span> name);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> /**</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * Sets new options for a script.</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> *</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @param name The name of the script</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @param options The new options</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> *</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @return ERR_INVALID_NAME if script name is invalid</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * @return ERR_TOO_MANY_ARGUMENTS if the size of the map is to big</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @return ERR_ARGUMENT_NOT_VALID if a string in the arguments is not </span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">int</span> setScriptOptions(in <span class="keywordtype">string</span> name, in <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html">ScriptOptions_2_0_0</a> options);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> /**</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * Returns the options for a script.</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> *</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * @param name The name of the script</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @param options The return value</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> *</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @return ERR_INVALID_NAME if script name is invalid</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> */</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">int</span> getScriptOptions(in <span class="keywordtype">string</span> name, out <a class="code" href="structluaservice_1_1ScriptOptions__2__0__0.html">ScriptOptions_2_0_0</a> options);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"></span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> /**</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * To query the environment information.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> *</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @return a struct with the environment information</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> */</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="structluaservice_1_1Environment__2__0__0.html">Environment_2_0_0</a> getEnvironment();</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"></span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> /**</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * To get output from a script as a string</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> *</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * The output is stored in a string buffer with a defined size. The buffer is addressable with an</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * (virtual) address. The address will be increased ervery time when the buffer will be filled.</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> *</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * To get the output for the first time just call with address zero and then use the returned nAddr</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * argument.</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> *</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * If iAddr is negative then the last n bytes will be returned, e.g. -9 returns the last 9 characters.</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * If iAddr is zero then the whole available buffer will be returned.</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * If iAddr is positive then the returned buffer starts at this address.</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * If iAddr is equal to nAddr then there is no data available</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * If iAddr and oAddr is not equal then there were data lost (execption: first call with zero).</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> *</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @param name The name of the script</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * @param iAddr The virtual start address where the returned output should begin.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * @param oAddr The virtual address from where the string starts.</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * @param nAddr The virtual address for the next query.</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @param more A boolean whitch indicates if there is more data available.</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> *</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * @return ERR_INVALID_NAME if file name is invalid</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * @return ERR_INVALID_ADDR if iAddr is negative and the absolute value of parameter iAddr is greater as the limit</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> */</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordtype">int</span> getScriptOutput(in <span class="keywordtype">string</span> name, in <span class="keywordtype">long</span> iAddr, out <span class="keywordtype">long</span> oAddr, out <span class="keywordtype">long</span> nAddr, out <span class="keywordtype">string</span> oString, out <span class="keywordtype">boolean</span> more);</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> /**</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * Clear the output buffer of a script.</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> *</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * @param name The name of the script</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> *</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * @return ERR_INVALID_NAME if file name is invalid</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> */</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keywordtype">int</span> clearScriptOutput(in <span class="keywordtype">string</span> name);</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"></span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> /**</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * To start a script</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> *</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * The function starts a lua script.</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> *</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @return ERR_INVALID_NAME if file name is invalid</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @return ERR_NOT_TERMINATED if the script is running or restarting</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> */</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordtype">int</span> startScript(in <span class="keywordtype">string</span> name);</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"></span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> /**</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * To start a script with arguments</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> *</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * The function starts a lua script. Additionally you can add arguments which are available from the</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * lua script. This args will override the default arguments. All args are stored in a global table</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * called ARGS in lua.</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> *</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * @return ERR_INVALID_NAME if file name is invalid</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * @return ERR_NOT_TERMINATED if the script is running or restarting</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * @return ERR_TOO_MANY_ARGUMENTS if the size of the map is to big</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * @return ERR_ARGUMENT_NOT_VALID if a string in the arguments is not valid</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> */</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordtype">int</span> startScriptWithArgs(in <span class="keywordtype">string</span> name, in map<string, string> arguments);</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"></span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> /**</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * To stop a script</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> *</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * This command stops a running or restarting script. After terminating the option autorestart will</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * not be evaluated.</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> *</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @return ERR_INVALID_NAME if file name is invalid</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * @return ERR_NOT_RUNNING if the script is not running or restarting</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> */</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keywordtype">int</span> terminateScript(in <span class="keywordtype">string</span> name);</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"></span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> /**</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * Returns the state for a single script.</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> *</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * @param name The script name</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * @param state The state of the script</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> *</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * @return NO_ERROR if OK</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * @return ERR_INVALID_NAME if file name is invalid</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * @return ERR_NO_SUCH_SCRIPT if there is no script with the name</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> */</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordtype">int</span> getScriptState(in <span class="keywordtype">string</span> name, out <a class="code" href="structluaservice_1_1ScriptState.html">ScriptState</a> state);</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"></span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> /**</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * Returns the state for all scripts. If the map is empty then there are no scripts on the machine.</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> *</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * @return A map<string name, ScriptState state> with name and state for all available scripts.</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> */</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  map<string, ScriptState> getScriptStates();</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  };</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> }</div><div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_a0b50f8657886e927cb9d06b8d3c2cf7a"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#a0b50f8657886e927cb9d06b8d3c2cf7a">luaservice::Environment_2_0_0::maxScriptMemoryGrowth</a></div><div class="ttdeci">int maxScriptMemoryGrowth</div><div class="ttdoc">maximum virtual memory growth per script (l) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:82</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_aa722eb45f9d9db9d30950e44c52b65f5"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#aa722eb45f9d9db9d30950e44c52b65f5">luaservice::ScriptState::exitType</a></div><div class="ttdeci">ExitType exitType</div><div class="ttdoc">type of exit code </div><div class="ttdef"><b>Definition:</b> LuaService.idl:63</div></div>
<div class="ttc" id="structluaservice_1_1ScriptOptions__2__0__0_html"><div class="ttname"><a href="structluaservice_1_1ScriptOptions__2__0__0.html">luaservice::ScriptOptions_2_0_0</a></div><div class="ttdoc">some script options </div><div class="ttdef"><b>Definition:</b> LuaService.idl:68</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_ad907e2146398006a2e16659aeccd034aa6208fa1b5b50c9d0be550c306bddd09d"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aa6208fa1b5b50c9d0be550c306bddd09d">luaservice::ScriptState::STAT_TERMINATED</a></div><div class="ttdoc">script state is terminated </div><div class="ttdef"><b>Definition:</b> LuaService.idl:52</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_a5a10160b7ca288e8037c62b406770dc4"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#a5a10160b7ca288e8037c62b406770dc4">luaservice::Environment_2_0_0::outputBufferSize</a></div><div class="ttdeci">int outputBufferSize</div><div class="ttdoc">output buffer size per script (l) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:88</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_ad907e2146398006a2e16659aeccd034aab09641ed1577da07e05ee6b277e523af"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aab09641ed1577da07e05ee6b277e523af">luaservice::ScriptState::STAT_NEW</a></div><div class="ttdoc">the script never ran (after uploading or system (re)start) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:50</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_ac8bd66963eb19fc84fb0b2de19ff47c7"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#ac8bd66963eb19fc84fb0b2de19ff47c7">luaservice::ScriptState::exitStatus</a></div><div class="ttdeci">int exitStatus</div><div class="ttdoc">exit status or signal </div><div class="ttdef"><b>Definition:</b> LuaService.idl:64</div></div>
<div class="ttc" id="interfaceluaservice_1_1Manager__2__0__1_html"><div class="ttname"><a href="interfaceluaservice_1_1Manager__2__0__1.html">luaservice::Manager_2_0_1</a></div><div class="ttdoc">There is a single manager instance. </div><div class="ttdef"><b>Definition:</b> LuaService.idl:96</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_a5c3e35134d819f3214a94963a0ea120b"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#a5c3e35134d819f3214a94963a0ea120b">luaservice::Environment_2_0_0::maxAllScriptSize</a></div><div class="ttdeci">int maxAllScriptSize</div><div class="ttdoc">maximum size of all script files (l) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:86</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_a08bfd5bff1d348b94da57c2543523d72"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#a08bfd5bff1d348b94da57c2543523d72">luaservice::Environment_2_0_0::maxScriptSize</a></div><div class="ttdeci">int maxScriptSize</div><div class="ttdoc">maximum size of a script file (l) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:85</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html"><div class="ttname"><a href="structluaservice_1_1ScriptState.html">luaservice::ScriptState</a></div><div class="ttdoc">A structure that descripts the state of a script. </div><div class="ttdef"><b>Definition:</b> LuaService.idl:46</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_a69172b8deba9943aafef325eb86e6cfe"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#a69172b8deba9943aafef325eb86e6cfe">luaservice::ScriptState::execState</a></div><div class="ttdeci">ExecState execState</div><div class="ttdoc">execution state of the script </div><div class="ttdef"><b>Definition:</b> LuaService.idl:62</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_add7352a8cc1a33151ee65119a86fd56e"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#add7352a8cc1a33151ee65119a86fd56e">luaservice::Environment_2_0_0::maxAmountOfScripts</a></div><div class="ttdeci">int maxAmountOfScripts</div><div class="ttdoc">number of scripts that can be stored (l) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:83</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html">luaservice::Environment_2_0_0</a></div><div class="ttdoc">The struct represents two kinds of information: </div><div class="ttdef"><b>Definition:</b> LuaService.idl:81</div></div>
<div class="ttc" id="structluaservice_1_1ScriptOptions__2__0__0_html_a98c23b9d1c37314d356ded58d4ac9f1b"><div class="ttname"><a href="structluaservice_1_1ScriptOptions__2__0__0.html#a98c23b9d1c37314d356ded58d4ac9f1b">luaservice::ScriptOptions_2_0_0::autoStart</a></div><div class="ttdeci">boolean autoStart</div><div class="ttdoc">starts a script after system booting </div><div class="ttdef"><b>Definition:</b> LuaService.idl:70</div></div>
<div class="ttc" id="namespaceluaservice_html"><div class="ttname"><a href="namespaceluaservice.html">luaservice</a></div><div class="ttdoc">Lua-Service. </div><div class="ttdef"><b>Definition:</b> LuaService.idl:35</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_a204d94da4cbcb1c0d2f027dcca0a3099a48ba8e3f1cdc709aef6aec6c697e5fc4"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099a48ba8e3f1cdc709aef6aec6c697e5fc4">luaservice::ScriptState::EXIT_CODE</a></div><div class="ttdoc">exitStatus is an exit code </div><div class="ttdef"><b>Definition:</b> LuaService.idl:58</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_a204d94da4cbcb1c0d2f027dcca0a3099"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">luaservice::ScriptState::ExitType</a></div><div class="ttdeci">ExitType</div><div class="ttdoc">Descripts the type of exitStatus. </div><div class="ttdef"><b>Definition:</b> LuaService.idl:57</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_a8c1426f551f6216a3c8c7510d49de1f6"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#a8c1426f551f6216a3c8c7510d49de1f6">luaservice::Environment_2_0_0::amountOfScripts</a></div><div class="ttdeci">int amountOfScripts</div><div class="ttdoc">number of scripts that are stored (cs) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:84</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_a87f083466fd431cbe15f169780d3f70c"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#a87f083466fd431cbe15f169780d3f70c">luaservice::Environment_2_0_0::autoStartDelay</a></div><div class="ttdeci">int autoStartDelay</div><div class="ttdoc">minimum delay to &#39;autoStart&#39; a script </div><div class="ttdef"><b>Definition:</b> LuaService.idl:90</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_abf71cce8b6d15406b0a6d53650f0ad8e"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#abf71cce8b6d15406b0a6d53650f0ad8e">luaservice::Environment_2_0_0::restartInterval</a></div><div class="ttdeci">int restartInterval</div><div class="ttdoc">minimum delay to next (re)start (cs) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:89</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_ad907e2146398006a2e16659aeccd034a"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">luaservice::ScriptState::ExecState</a></div><div class="ttdeci">ExecState</div><div class="ttdoc">execution state for a scripts </div><div class="ttdef"><b>Definition:</b> LuaService.idl:49</div></div>
<div class="ttc" id="structluaservice_1_1ScriptState_html_ad907e2146398006a2e16659aeccd034aad69c918089360bccb1193a217408e26c"><div class="ttname"><a href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aad69c918089360bccb1193a217408e26c">luaservice::ScriptState::STAT_RUNNING</a></div><div class="ttdoc">script state is running </div><div class="ttdef"><b>Definition:</b> LuaService.idl:51</div></div>
<div class="ttc" id="structluaservice_1_1ScriptOptions__2__0__0_html_ae54ed21fe2d77ad266da84bd92d4d950"><div class="ttname"><a href="structluaservice_1_1ScriptOptions__2__0__0.html#ae54ed21fe2d77ad266da84bd92d4d950">luaservice::ScriptOptions_2_0_0::defaultArgs</a></div><div class="ttdeci">map< string, string > defaultArgs</div><div class="ttdoc">default arguments are passed to the lua script </div><div class="ttdef"><b>Definition:</b> LuaService.idl:69</div></div>
<div class="ttc" id="structluaservice_1_1Environment__2__0__0_html_abd9230fad019b85400bfdea81ad92a0d"><div class="ttname"><a href="structluaservice_1_1Environment__2__0__0.html#abd9230fad019b85400bfdea81ad92a0d">luaservice::Environment_2_0_0::allScriptSize</a></div><div class="ttdeci">int allScriptSize</div><div class="ttdoc">size of all script files (cs) </div><div class="ttdef"><b>Definition:</b> LuaService.idl:87</div></div>
<div class="ttc" id="structluaservice_1_1ScriptOptions__2__0__0_html_aab5b7c82c2c7a7059ea18aaae7ce24c2"><div class="ttname"><a href="structluaservice_1_1ScriptOptions__2__0__0.html#aab5b7c82c2c7a7059ea18aaae7ce24c2">luaservice::ScriptOptions_2_0_0::autoRestart</a></div><div class="ttdeci">boolean autoRestart</div><div class="ttdoc">restarts a script after termination or crash </div><div class="ttdef"><b>Definition:</b> LuaService.idl:71</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
