Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
Loading...
Searching...
No Matches
luaservice::ScriptState Struct Reference

A structure that describes the state of a script. More...

import "LuaService.idl";

Public Types

enum  ExecState { STAT_NEW , STAT_RUNNING , STAT_TERMINATED , STAT_RESTARTING }
 Execution state of a script. More...
 
enum  ExitType { EXIT_CODE , SIGNAL }
 Describes the type of exitStatus. More...
 

Public Attributes

ExecState execState
 execution state of the script
 
ExitType exitType
 type of exit status
 
int exitStatus
 exit code or signal
 

Detailed Description

A structure that describes the state of a script.

When a script is uploaded the new execState is STAT_NEW, exitType and exitStatus are not valid.

When the execState is changed to STAT_TERMINATED, exitType and exitStatus will be set.

Definition at line 46 of file LuaService.idl.

Member Enumeration Documentation

◆ ExecState

Execution state of a script.

Enumerator
STAT_NEW 

the script never ran (after uploading or system (re)start)

STAT_RUNNING 

script is running

STAT_TERMINATED 

script is terminated

STAT_RESTARTING 

script is terminated and restarts after the Environment::restartInterval

Definition at line 49 of file LuaService.idl.

◆ ExitType

Describes the type of exitStatus.

Enumerator
EXIT_CODE 

exitStatus is an exit code

SIGNAL 

exitStatus is a signal

Definition at line 57 of file LuaService.idl.

Member Data Documentation

◆ execState

ExecState luaservice::ScriptState::execState

execution state of the script

Definition at line 62 of file LuaService.idl.

◆ exitStatus

int luaservice::ScriptState::exitStatus

exit code or signal

Definition at line 64 of file LuaService.idl.

◆ exitType

ExitType luaservice::ScriptState::exitType

type of exit status

Definition at line 63 of file LuaService.idl.


The documentation for this struct was generated from the following file: