Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
LuaService.idl
1 
28 module luaservice {
29 
39  structure ScriptState {
40 
42  enumeration ExecState {
46  STAT_RESTARTING
47  };
48 
50  enumeration ExitType {
52  SIGNAL
53  };
54 
57  int exitStatus;
58  };
59 
61  structure ScriptOptions {
62  boolean autoStart;
63  boolean autoRestart;
64  };
65 
73  structure Environment {
83  };
84 
88  interface Manager {
89 
91  constant int NO_ERROR = 0;
92  constant int ERR_INVALID_NAME = 1;
93  constant int ERR_NO_SUCH_SCRIPT = 2;
94  constant int ERR_MAX_SCRIPT_NUMBERS_EXCEEDED = 3;
95  constant int ERR_MAX_SCRIPT_SIZE_EXCEEDED = 4;
96  constant int ERR_MAX_ALL_SCRIPT_SIZE_EXCEEDED = 5;
97  constant int ERR_NOT_TERMINATED = 6;
98  constant int ERR_NOT_RUNNING = 7;
99  constant int ERR_INVALID_ADDR = 8;
100 
101 
119  int setScript(in string name, in string script, in ScriptOptions options);
120 
130  int getScript(in string name, out string script);
131 
139  vector<string> getScriptNames();
140 
151  int deleteScript(in string name);
152 
163  int setScriptOptions(in string name, in ScriptOptions options);
164 
175  int getScriptOptions(in string name, out ScriptOptions options);
176 
182  Environment getEnvironment();
183 
209  int getScriptOutput(in string name, in long iAddr, out long oAddr, out long nAddr, out string oString, out boolean more);
210 
221  int startScript(in string name);
222 
233  int terminateScript(in string name);
234 
245  int getScriptState(in string name, out ScriptState state);
246 
247 
253  map<string, ScriptState> getScriptStates();
254  };
255 
256 }
boolean autoRestart
restarts a script after termination or crash
Definition: LuaService.idl:63
ExitType exitType
type of exit code
Definition: LuaService.idl:56
boolean autoStart
starts a script after system booting
Definition: LuaService.idl:62
int maxScriptSize
maximum size of a script file (l)
Definition: LuaService.idl:77
script state is terminated
Definition: LuaService.idl:45
the script never ran (after uploading or system (re)start)
Definition: LuaService.idl:43
int exitStatus
exit status or signal
Definition: LuaService.idl:57
There is a single manager instance.
Definition: LuaService.idl:88
some script options
Definition: LuaService.idl:61
int amountOfScripts
number of scripts that are stored (cs)
Definition: LuaService.idl:76
A structure that descripts the state of a script.
Definition: LuaService.idl:39
ExecState execState
execution state of the script
Definition: LuaService.idl:55
int outputBufferSize
output buffer size per script (l)
Definition: LuaService.idl:80
int allScriptSize
size of all script files (cs)
Definition: LuaService.idl:79
exitStatus is an exit code
Definition: LuaService.idl:51
ExitType
Descripts the type of exitStatus.
Definition: LuaService.idl:50
int autoStartDelay
minimum delay to 'autoStart' a script
Definition: LuaService.idl:82
ExecState
execution state for a scripts
Definition: LuaService.idl:42
int restartInterval
minimum delay to next (re)start (cs)
Definition: LuaService.idl:81
int maxAmountOfScripts
number of scripts that can be stored (l)
Definition: LuaService.idl:75
script state is running
Definition: LuaService.idl:44
int maxAllScriptSize
maximum size of all script files (l)
Definition: LuaService.idl:78
int maxMemoryPerScript
maximum virtual memory per script (l)
Definition: LuaService.idl:74
The struct represents two kinds of information:
Definition: LuaService.idl:73