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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: event::Engine Interface 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 / Server Technology Xerus™ PDU JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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="namespaceevent.html">event</a></li><li class="navelem"><a class="el" href="interfaceevent_1_1Engine.html">Engine</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="interfaceevent_1_1Engine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">event::Engine Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>There is a single event engine instance reachable by a well known reference.
<a href="interfaceevent_1_1Engine.html#details">More...</a></p>
<p><code>import"<a class="el" href="EventEngine_8idl_source.html">EventEngine.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An action is a tuple of 'id' (unique within the scope of this event engine), 'name' which is unique as well and used by the GUI as user readable identificator, 'isSystem' which denotes the action as system action, 'type' which defines what it is, and an argument vector that vary depending on type and which is passed to the action. <a href="structevent_1_1Engine_1_1Action.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Condition.html">Condition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1Engine_1_1Condition.html" title="Condition is a logical combination of multiple events.">Condition</a> is a logical combination of multiple events. <a href="structevent_1_1Engine_1_1Condition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1EventDesc.html">EventDesc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An event descriptor. <a href="structevent_1_1Engine_1_1EventDesc.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="structevent_1_1Engine_1_1Rule.html" title="A Rule binds an action to a condition.">Rule</a> binds an action to a condition. <a href="structevent_1_1Engine_1_1Rule.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a28892468352a8f6b85dec98b27d36453"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a28892468352a8f6b85dec98b27d36453">listEventDescs</a> (in vector< string > eventIdPrefix, out vector< <a class="el" href="structevent_1_1Engine_1_1EventDesc.html">EventDesc</a> > eventDescs)</td></tr>
<tr class="memdesc:a28892468352a8f6b85dec98b27d36453"><td class="mdescLeft"> </td><td class="mdescRight">Query existing event descriptors. <a href="interfaceevent_1_1Engine.html#a28892468352a8f6b85dec98b27d36453">More...</a><br /></td></tr>
<tr class="separator:a28892468352a8f6b85dec98b27d36453"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1815e6c8f4ccf1ff5b1b3e5579c432f4"><td class="memItemLeft" align="right" valign="top">vector< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a1815e6c8f4ccf1ff5b1b3e5579c432f4">listActionTypes</a> ()</td></tr>
<tr class="memdesc:a1815e6c8f4ccf1ff5b1b3e5579c432f4"><td class="mdescLeft"> </td><td class="mdescRight">List all available action types. <a href="interfaceevent_1_1Engine.html#a1815e6c8f4ccf1ff5b1b3e5579c432f4">More...</a><br /></td></tr>
<tr class="separator:a1815e6c8f4ccf1ff5b1b3e5579c432f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4db363fe10647eaccbf139d505b11d15"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a4db363fe10647eaccbf139d505b11d15">addAction</a> (in <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> action, out string actionId)</td></tr>
<tr class="memdesc:a4db363fe10647eaccbf139d505b11d15"><td class="mdescLeft"> </td><td class="mdescRight">Add a new action. <a href="interfaceevent_1_1Engine.html#a4db363fe10647eaccbf139d505b11d15">More...</a><br /></td></tr>
<tr class="separator:a4db363fe10647eaccbf139d505b11d15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2030bec53648590f7827f7c84507c986"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a2030bec53648590f7827f7c84507c986">modifyAction</a> (in <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> action)</td></tr>
<tr class="memdesc:a2030bec53648590f7827f7c84507c986"><td class="mdescLeft"> </td><td class="mdescRight">Modify an action. <a href="interfaceevent_1_1Engine.html#a2030bec53648590f7827f7c84507c986">More...</a><br /></td></tr>
<tr class="separator:a2030bec53648590f7827f7c84507c986"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea8adb4c07e6893bcbdd1864e12a10e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#aea8adb4c07e6893bcbdd1864e12a10e7">deleteAction</a> (in string actionId)</td></tr>
<tr class="memdesc:aea8adb4c07e6893bcbdd1864e12a10e7"><td class="mdescLeft"> </td><td class="mdescRight">Remove an action. <a href="interfaceevent_1_1Engine.html#aea8adb4c07e6893bcbdd1864e12a10e7">More...</a><br /></td></tr>
<tr class="separator:aea8adb4c07e6893bcbdd1864e12a10e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84d3c33927b99c8f290d323a34ef1d0a"><td class="memItemLeft" align="right" valign="top"><a id="a84d3c33927b99c8f290d323a34ef1d0a"></a>
vector< <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a84d3c33927b99c8f290d323a34ef1d0a">listActions</a> ()</td></tr>
<tr class="memdesc:a84d3c33927b99c8f290d323a34ef1d0a"><td class="mdescLeft"> </td><td class="mdescRight">List all actions currently know to this event engine. <br /></td></tr>
<tr class="separator:a84d3c33927b99c8f290d323a34ef1d0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab30ed106885825318bb85642cbb07513"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#ab30ed106885825318bb85642cbb07513">triggerAction</a> (in string actionId, out string errMsg, in vector< <a class="el" href="structevent_1_1KeyValue.html">KeyValue</a> > context)</td></tr>
<tr class="memdesc:ab30ed106885825318bb85642cbb07513"><td class="mdescLeft"> </td><td class="mdescRight">Trigger an action. <a href="interfaceevent_1_1Engine.html#ab30ed106885825318bb85642cbb07513">More...</a><br /></td></tr>
<tr class="separator:ab30ed106885825318bb85642cbb07513"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12bc5f3b857d5406a4257ed0a958a38b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a12bc5f3b857d5406a4257ed0a958a38b">testAction</a> (in <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> action, out string errMsg, in vector< <a class="el" href="structevent_1_1KeyValue.html">KeyValue</a> > context)</td></tr>
<tr class="memdesc:a12bc5f3b857d5406a4257ed0a958a38b"><td class="mdescLeft"> </td><td class="mdescRight">Test an action. <a href="interfaceevent_1_1Engine.html#a12bc5f3b857d5406a4257ed0a958a38b">More...</a><br /></td></tr>
<tr class="separator:a12bc5f3b857d5406a4257ed0a958a38b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2568d251bcc0ca415b3927c8bdf953d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#ae2568d251bcc0ca415b3927c8bdf953d">addRule</a> (in <a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a> rule, out string ruleId)</td></tr>
<tr class="memdesc:ae2568d251bcc0ca415b3927c8bdf953d"><td class="mdescLeft"> </td><td class="mdescRight">Add a new rule. <a href="interfaceevent_1_1Engine.html#ae2568d251bcc0ca415b3927c8bdf953d">More...</a><br /></td></tr>
<tr class="separator:ae2568d251bcc0ca415b3927c8bdf953d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05602a6d585c3187c8e86956ff5718ba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a05602a6d585c3187c8e86956ff5718ba">modifyRule</a> (in <a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a> rule)</td></tr>
<tr class="memdesc:a05602a6d585c3187c8e86956ff5718ba"><td class="mdescLeft"> </td><td class="mdescRight">Modify a rule. <a href="interfaceevent_1_1Engine.html#a05602a6d585c3187c8e86956ff5718ba">More...</a><br /></td></tr>
<tr class="separator:a05602a6d585c3187c8e86956ff5718ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65688db34f10cb851258dd131376aaa3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a65688db34f10cb851258dd131376aaa3">enableRule</a> (in string ruleId)</td></tr>
<tr class="memdesc:a65688db34f10cb851258dd131376aaa3"><td class="mdescLeft"> </td><td class="mdescRight">Enable a rule. <a href="interfaceevent_1_1Engine.html#a65688db34f10cb851258dd131376aaa3">More...</a><br /></td></tr>
<tr class="separator:a65688db34f10cb851258dd131376aaa3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b3128393a26540665c9651013ff3272"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a4b3128393a26540665c9651013ff3272">disableRule</a> (in string ruleId)</td></tr>
<tr class="memdesc:a4b3128393a26540665c9651013ff3272"><td class="mdescLeft"> </td><td class="mdescRight">Disable a rule. <a href="interfaceevent_1_1Engine.html#a4b3128393a26540665c9651013ff3272">More...</a><br /></td></tr>
<tr class="separator:a4b3128393a26540665c9651013ff3272"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbc75f286e1fa8bd9512082de69ce5f5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#afbc75f286e1fa8bd9512082de69ce5f5">deleteRule</a> (in string ruleId)</td></tr>
<tr class="memdesc:afbc75f286e1fa8bd9512082de69ce5f5"><td class="mdescLeft"> </td><td class="mdescRight">Delete a rule. <a href="interfaceevent_1_1Engine.html#afbc75f286e1fa8bd9512082de69ce5f5">More...</a><br /></td></tr>
<tr class="separator:afbc75f286e1fa8bd9512082de69ce5f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66ff70643c37d2462ab4f45159249e62"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a66ff70643c37d2462ab4f45159249e62">listRules</a> ()</td></tr>
<tr class="memdesc:a66ff70643c37d2462ab4f45159249e62"><td class="mdescLeft"> </td><td class="mdescRight">List all rules. <a href="interfaceevent_1_1Engine.html#a66ff70643c37d2462ab4f45159249e62">More...</a><br /></td></tr>
<tr class="separator:a66ff70643c37d2462ab4f45159249e62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebb769720cace0da79460219f91d7376"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#aebb769720cace0da79460219f91d7376">deliverEvent</a> (in <a class="el" href="structevent_1_1Event.html">Event</a> event)</td></tr>
<tr class="memdesc:aebb769720cace0da79460219f91d7376"><td class="mdescLeft"> </td><td class="mdescRight">Deliver an event. <a href="interfaceevent_1_1Engine.html#aebb769720cace0da79460219f91d7376">More...</a><br /></td></tr>
<tr class="separator:aebb769720cace0da79460219f91d7376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d9a89132ea45541215577378ed3b25c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Engine.html#a7d9a89132ea45541215577378ed3b25c">rearmRule</a> (in string ruleId)</td></tr>
<tr class="memdesc:a7d9a89132ea45541215577378ed3b25c"><td class="mdescLeft"> </td><td class="mdescRight">Rearm an event rule that is active. <a href="interfaceevent_1_1Engine.html#a7d9a89132ea45541215577378ed3b25c">More...</a><br /></td></tr>
<tr class="separator:a7d9a89132ea45541215577378ed3b25c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>There is a single event engine instance reachable by a well known reference. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4db363fe10647eaccbf139d505b11d15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4db363fe10647eaccbf139d505b11d15">◆ </a></span>addAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::addAction </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> </td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>actionId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new action. </p>
<p>The id and isSystem fields are ignored. The actions's id field is allocated automatically and returned in the actionId parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the name of the new action already exists </dd>
<dd>
2 if generating the action id failed </dd>
<dd>
3 if the maximum number of actions have been created </dd></dl>
</div>
</div>
<a id="ae2568d251bcc0ca415b3927c8bdf953d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2568d251bcc0ca415b3927c8bdf953d">◆ </a></span>addRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::addRule </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a> </td>
<td class="paramname"><em>rule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>ruleId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new rule. </p>
<p>The id, hasMatched and isSystem fields are ignored. The rule's id field is allocated automatically and returned in the the ruleId parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the name of the new rule already exists </dd>
<dd>
2 if generating the rule id failed </dd>
<dd>
3 if the rule condition contains an invalid event id </dd>
<dd>
4 if the maximum number of rules have been created </dd>
<dd>
5 if the maximum number of actions per rule is exceeded </dd></dl>
</div>
</div>
<a id="aea8adb4c07e6893bcbdd1864e12a10e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea8adb4c07e6893bcbdd1864e12a10e7">◆ </a></span>deleteAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::deleteAction </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>actionId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove an action. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if id is unknown </dd>
<dd>
2 if the action is not deletable </dd></dl>
</div>
</div>
<a id="afbc75f286e1fa8bd9512082de69ce5f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbc75f286e1fa8bd9512082de69ce5f5">◆ </a></span>deleteRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::deleteRule </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>ruleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a rule. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if ruleId is unknown </dd>
<dd>
2 if the rule is not deletable </dd></dl>
</div>
</div>
<a id="aebb769720cace0da79460219f91d7376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebb769720cace0da79460219f91d7376">◆ </a></span>deliverEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::deliverEvent </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1Event.html">Event</a> </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deliver an event. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if event is unknown </dd></dl>
</div>
</div>
<a id="a4b3128393a26540665c9651013ff3272"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b3128393a26540665c9651013ff3272">◆ </a></span>disableRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::disableRule </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>ruleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable a rule. </p>
<p>A disabled rule will be ignored when processing events.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if ruleId is unknown </dd></dl>
</div>
</div>
<a id="a65688db34f10cb851258dd131376aaa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65688db34f10cb851258dd131376aaa3">◆ </a></span>enableRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::enableRule </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>ruleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable a rule. </p>
<p>An enabled rule will be evaluated when processing events.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if id is unknown </dd></dl>
</div>
</div>
<a id="a1815e6c8f4ccf1ff5b1b3e5579c432f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1815e6c8f4ccf1ff5b1b3e5579c432f4">◆ </a></span>listActionTypes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<string> event::Engine::listActionTypes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>List all available action types. </p>
<p>The action type is intentionally defined generically so that implementation can be extensible without changing interface. </p>
</div>
</div>
<a id="a28892468352a8f6b85dec98b27d36453"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28892468352a8f6b85dec98b27d36453">◆ </a></span>listEventDescs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::listEventDescs </td>
<td>(</td>
<td class="paramtype">in vector< string > </td>
<td class="paramname"><em>eventIdPrefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out vector< <a class="el" href="structevent_1_1Engine_1_1EventDesc.html">EventDesc</a> > </td>
<td class="paramname"><em>eventDescs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query existing event descriptors. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if id was not found </dd></dl>
</div>
</div>
<a id="a66ff70643c37d2462ab4f45159249e62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66ff70643c37d2462ab4f45159249e62">◆ </a></span>listRules()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a>> event::Engine::listRules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>List all rules. </p>
<p>Question: will number of rules be small enough to list them all in a single operation. A single <a class="el" href="structevent_1_1Engine_1_1Rule.html" title="A Rule binds an action to a condition.">Rule</a> may be quite large... See below for alternative interface using iterator. </p>
</div>
</div>
<a id="a2030bec53648590f7827f7c84507c986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2030bec53648590f7827f7c84507c986">◆ </a></span>modifyAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::modifyAction </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> </td>
<td class="paramname"><em>action</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify an action. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the name of the new action already exists </dd>
<dd>
2 if the action id does not exist </dd></dl>
</div>
</div>
<a id="a05602a6d585c3187c8e86956ff5718ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05602a6d585c3187c8e86956ff5718ba">◆ </a></span>modifyRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::modifyRule </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1Engine_1_1Rule.html">Rule</a> </td>
<td class="paramname"><em>rule</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify a rule. </p>
<p>The hasMatched and isSystem fields are ignored.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the name of the new rule already exists </dd>
<dd>
2 if the rule id does not exist </dd>
<dd>
3 if the rule condition contains an invalid event id </dd>
<dd>
4 if the maximum number of actions per rule is exceeded </dd></dl>
</div>
</div>
<a id="a7d9a89132ea45541215577378ed3b25c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d9a89132ea45541215577378ed3b25c">◆ </a></span>rearmRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::rearmRule </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>ruleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rearm an event rule that is active. </p>
<p>Once a <a class="el" href="structevent_1_1Engine_1_1Rule.html" title="A Rule binds an action to a condition.">Rule</a> triggers its actions it is done once. If the condition of the rules becomes false and back again true, no action will be performed unless the rule is rearmed. Rules may be auto-rearmed what means whenever the rule's conditions changes from false to true actions are triggered over and again.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the rule is unknown </dd>
<dd>
2 if the rule is not enabled </dd></dl>
</div>
</div>
<a id="a12bc5f3b857d5406a4257ed0a958a38b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12bc5f3b857d5406a4257ed0a958a38b">◆ </a></span>testAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::testAction </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1Engine_1_1Action.html">Action</a> </td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>errMsg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in vector< <a class="el" href="structevent_1_1KeyValue.html">KeyValue</a> > </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test an action. </p>
<p>This is similar to <a class="el" href="interfaceevent_1_1Engine.html#ab30ed106885825318bb85642cbb07513">triggerAction</a>, except that an action that is not yet saved can be passed in. Therefore this method can be used for testing actions to be newly created. The operation will block until the action has been performed or an error occurred. In the latter case errMsg will contain an error message. The context is passed to the actions.</p>
<p>NOTE: Currently this function doesn't block!</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the action name is invalid </dd>
<dd>
2 if no actor was found for the action </dd>
<dd>
3 if performing the action failed, errmsg will be set </dd></dl>
</div>
</div>
<a id="ab30ed106885825318bb85642cbb07513"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab30ed106885825318bb85642cbb07513">◆ </a></span>triggerAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::Engine::triggerAction </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>actionId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>errMsg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in vector< <a class="el" href="structevent_1_1KeyValue.html">KeyValue</a> > </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Trigger an action. </p>
<p>This is mainly used for test and debugging. The operation will block until the action has been performed or an error occurred. In the latter case errMsg will contain an error message. The context is passed to the actions.</p>
<p>NOTE: Currently this function doesn't block!</p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if id is unknown </dd>
<dd>
2 if no actor was found for the action </dd>
<dd>
3 if performing the action failed, errmsg will be set </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="EventEngine_8idl_source.html">EventEngine.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
