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
|
<!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: luaservice::ScriptState Struct Reference</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="namespaceluaservice.html">luaservice</a></li><li class="navelem"><a class="el" href="structluaservice_1_1ScriptState.html">ScriptState</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structluaservice_1_1ScriptState-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">luaservice::ScriptState Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A structure that descripts the state of a script.
<a href="structluaservice_1_1ScriptState.html#details">More...</a></p>
<p><code>import"<a class="el" href="LuaService_8idl_source.html">LuaService.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad907e2146398006a2e16659aeccd034a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">ExecState</a> { <a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aab09641ed1577da07e05ee6b277e523af">STAT_NEW</a>,
<a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aad69c918089360bccb1193a217408e26c">STAT_RUNNING</a>,
<a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aa6208fa1b5b50c9d0be550c306bddd09d">STAT_TERMINATED</a>,
<a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034aa20ff815d5e0578081b2f7f0fa5a80621">STAT_RESTARTING</a>
}</td></tr>
<tr class="memdesc:ad907e2146398006a2e16659aeccd034a"><td class="mdescLeft"> </td><td class="mdescRight">execution state for a scripts <a href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">More...</a><br /></td></tr>
<tr class="separator:ad907e2146398006a2e16659aeccd034a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a204d94da4cbcb1c0d2f027dcca0a3099"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">ExitType</a> { <a class="el" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099a48ba8e3f1cdc709aef6aec6c697e5fc4">EXIT_CODE</a>,
<a class="el" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099a0821969cbdb3d255b41052b772dcd236">SIGNAL</a>
}</td></tr>
<tr class="memdesc:a204d94da4cbcb1c0d2f027dcca0a3099"><td class="mdescLeft"> </td><td class="mdescRight">Descripts the type of exitStatus. <a href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">More...</a><br /></td></tr>
<tr class="separator:a204d94da4cbcb1c0d2f027dcca0a3099"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a69172b8deba9943aafef325eb86e6cfe"><td class="memItemLeft" align="right" valign="top"><a id="a69172b8deba9943aafef325eb86e6cfe"></a>
<a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">ExecState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structluaservice_1_1ScriptState.html#a69172b8deba9943aafef325eb86e6cfe">execState</a></td></tr>
<tr class="memdesc:a69172b8deba9943aafef325eb86e6cfe"><td class="mdescLeft"> </td><td class="mdescRight">execution state of the script <br /></td></tr>
<tr class="separator:a69172b8deba9943aafef325eb86e6cfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa722eb45f9d9db9d30950e44c52b65f5"><td class="memItemLeft" align="right" valign="top"><a id="aa722eb45f9d9db9d30950e44c52b65f5"></a>
<a class="el" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">ExitType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structluaservice_1_1ScriptState.html#aa722eb45f9d9db9d30950e44c52b65f5">exitType</a></td></tr>
<tr class="memdesc:aa722eb45f9d9db9d30950e44c52b65f5"><td class="mdescLeft"> </td><td class="mdescRight">type of exit code <br /></td></tr>
<tr class="separator:aa722eb45f9d9db9d30950e44c52b65f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8bd66963eb19fc84fb0b2de19ff47c7"><td class="memItemLeft" align="right" valign="top"><a id="ac8bd66963eb19fc84fb0b2de19ff47c7"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structluaservice_1_1ScriptState.html#ac8bd66963eb19fc84fb0b2de19ff47c7">exitStatus</a></td></tr>
<tr class="memdesc:ac8bd66963eb19fc84fb0b2de19ff47c7"><td class="mdescLeft"> </td><td class="mdescRight">exit status or signal <br /></td></tr>
<tr class="separator:ac8bd66963eb19fc84fb0b2de19ff47c7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A structure that descripts the state of a script. </p>
<p>When a script is uploaded the new execState is STAT_NEW. exitCode and signal is not valid.</p>
<p>When the execState is changing to STAT_TERMINATED then exitCode and signal will be set. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ad907e2146398006a2e16659aeccd034a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad907e2146398006a2e16659aeccd034a">◆ </a></span>ExecState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structluaservice_1_1ScriptState.html#ad907e2146398006a2e16659aeccd034a">luaservice::ScriptState::ExecState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>execution state for a scripts </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad907e2146398006a2e16659aeccd034aab09641ed1577da07e05ee6b277e523af"></a>STAT_NEW </td><td class="fielddoc"><p>the script never ran (after uploading or system (re)start) </p>
</td></tr>
<tr><td class="fieldname"><a id="ad907e2146398006a2e16659aeccd034aad69c918089360bccb1193a217408e26c"></a>STAT_RUNNING </td><td class="fielddoc"><p>script state is running </p>
</td></tr>
<tr><td class="fieldname"><a id="ad907e2146398006a2e16659aeccd034aa6208fa1b5b50c9d0be550c306bddd09d"></a>STAT_TERMINATED </td><td class="fielddoc"><p>script state is terminated </p>
</td></tr>
<tr><td class="fieldname"><a id="ad907e2146398006a2e16659aeccd034aa20ff815d5e0578081b2f7f0fa5a80621"></a>STAT_RESTARTING </td><td class="fielddoc"><p>script is terminated and restarts after 'restart interval' </p>
</td></tr>
</table>
</div>
</div>
<a id="a204d94da4cbcb1c0d2f027dcca0a3099"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a204d94da4cbcb1c0d2f027dcca0a3099">◆ </a></span>ExitType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structluaservice_1_1ScriptState.html#a204d94da4cbcb1c0d2f027dcca0a3099">luaservice::ScriptState::ExitType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Descripts the type of exitStatus. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a204d94da4cbcb1c0d2f027dcca0a3099a48ba8e3f1cdc709aef6aec6c697e5fc4"></a>EXIT_CODE </td><td class="fielddoc"><p>exitStatus is an exit code </p>
</td></tr>
<tr><td class="fieldname"><a id="a204d94da4cbcb1c0d2f027dcca0a3099a0821969cbdb3d255b41052b772dcd236"></a>SIGNAL </td><td class="fielddoc"><p>exitStatus is a signal </p>
</td></tr>
</table>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="LuaService_8idl_source.html">LuaService.idl</a></li>
</ul>
</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>
|