Raritan PX2/PX3 JSON-RPC API
TimerEventManager.idl
1 #ifndef __EVENT_TIMEREVENTMANAGER_IDL__
2 #define __EVENT_TIMEREVENTMANAGER_IDL__
3 
5 module event {
6 
9 
11  constant int NO_ERROR = 0;
12  constant int ERR_INVALID_SCHEDULE = 1;
13  constant int ERR_UNKNOWN_EVENT_ID = 2;
14  constant int ERR_CREATE_EVENT_ID_FAILED = 3;
15  constant int ERR_MAX_TIMERS_CREATED = 4;
16 
24  constant int JAN = 1;
25  constant int FEB = 2;
26  constant int MAR = 3;
27  constant int APR = 4;
28  constant int MAY = 5;
29  constant int JUN = 6;
30  constant int JUL = 7;
31  constant int AUG = 8;
32  constant int SEP = 9;
33  constant int OCT = 10;
34  constant int NOV = 11;
35  constant int DEC = 12;
36 
37  constant int SUN = 0;
38  constant int MON = 1;
39  constant int TUE = 2;
40  constant int WED = 3;
41  constant int THU = 4;
42  constant int FRI = 5;
43  constant int SAT = 6;
44 
52  structure Range {
53  int start;
54  int end;
55  int step;
56  };
65  structure Schedule {
66  boolean enabled;
67  vector<Range> minute;
68  vector<Range> hour;
69  vector<Range> dayOfMonth;
70  vector<Range> month;
71  vector<Range> dayOfWeek;
72  };
73 
82  structure TimerEvent {
83  vector<string> eventId;
85  };
86 
100  int addTimerEvent(in Schedule schedule, out vector<string> eventId);
101 
111  int modifyTimerEvent(in vector<string> eventId, in Schedule schedule);
112 
120  int deleteTimerEvent(in vector<string> eventId);
121 
125  vector<TimerEvent> listTimerEvents();
126 
127  };
128 
129 }
130 
131 #endif /* __EVENT_TIMEREVENTMANAGER_IDL__ */
Schedule executionTime
Schedule for execution time.
Definition: TimerEventManager.idl:84
vector< Range > minute
Ranges for minute.
Definition: TimerEventManager.idl:67
vector< Range > month
Ranges for month.
Definition: TimerEventManager.idl:70
int start
Start time.
Definition: TimerEventManager.idl:53
TimerEventManager interface.
Definition: TimerEventManager.idl:8
TimerEvent structure.
Definition: TimerEventManager.idl:82
vector< Range > dayOfWeek
Ranges for day of week.
Definition: TimerEventManager.idl:71
Range structure.
Definition: TimerEventManager.idl:52
int step
Step.
Definition: TimerEventManager.idl:55
vector< string > eventId
Event ID.
Definition: TimerEventManager.idl:83
vector< Range > hour
Ranges for hour.
Definition: TimerEventManager.idl:68
int end
End time.
Definition: TimerEventManager.idl:54
vector< Range > dayOfMonth
Ranges for day of month.
Definition: TimerEventManager.idl:69
Schedule structure.
Definition: TimerEventManager.idl:65
boolean enabled
Whether the timer event is enabled.
Definition: TimerEventManager.idl:66