File: interfaceevent_1_1Channel.html

package info (click to toggle)
raritan-json-rpc-sdk 4.0.20%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 57,236 kB
  • sloc: cs: 223,121; perl: 117,786; python: 26,872; javascript: 6,544; makefile: 27
file content (420 lines) | stat: -rw-r--r-- 22,561 bytes parent folder | download
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
<!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::Channel 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&amp;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&amp;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_1Channel.html">Channel</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfaceevent_1_1Channel-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">event::Channel Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i....">Event</a> <a class="el" href="interfaceevent_1_1Channel.html" title="Event Channel.">Channel</a>.  
 <a href="interfaceevent_1_1Channel.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="EventService_8idl_source.html">EventService.idl</a>&quot;;</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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Channel_1_1EventSelect.html">EventSelect</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure to select an <a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i....">Event</a> *.  <a href="structevent_1_1Channel_1_1EventSelect.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a8de92136097076091b6787f8bb0bf386"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a8de92136097076091b6787f8bb0bf386">demandEventType</a> (in typecode type)</td></tr>
<tr class="memdesc:a8de92136097076091b6787f8bb0bf386"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subscribe for events of a given type.  <a href="interfaceevent_1_1Channel.html#a8de92136097076091b6787f8bb0bf386">More...</a><br /></td></tr>
<tr class="separator:a8de92136097076091b6787f8bb0bf386"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b962b946c04651f3c3cbb8fe4c473d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a5b962b946c04651f3c3cbb8fe4c473d0">cancelEventType</a> (in typecode type)</td></tr>
<tr class="memdesc:a5b962b946c04651f3c3cbb8fe4c473d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the subscription for events of a given type.  <a href="interfaceevent_1_1Channel.html#a5b962b946c04651f3c3cbb8fe4c473d0">More...</a><br /></td></tr>
<tr class="separator:a5b962b946c04651f3c3cbb8fe4c473d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31b429b0b7c1a85c5bcbde1479024703"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a31b429b0b7c1a85c5bcbde1479024703">demandEventTypes</a> (in vector&lt; typecode &gt; types)</td></tr>
<tr class="memdesc:a31b429b0b7c1a85c5bcbde1479024703"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subscribe for multiple event types at once.  <a href="interfaceevent_1_1Channel.html#a31b429b0b7c1a85c5bcbde1479024703">More...</a><br /></td></tr>
<tr class="separator:a31b429b0b7c1a85c5bcbde1479024703"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59a4a26903dd06ccd456077067325b5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a59a4a26903dd06ccd456077067325b5a">cancelEventTypes</a> (in vector&lt; typecode &gt; types)</td></tr>
<tr class="memdesc:a59a4a26903dd06ccd456077067325b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel subscription for events that are of any of given types.  <a href="interfaceevent_1_1Channel.html#a59a4a26903dd06ccd456077067325b5a">More...</a><br /></td></tr>
<tr class="separator:a59a4a26903dd06ccd456077067325b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2efc0181644cbcbf57dc18eb2d802466"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a2efc0181644cbcbf57dc18eb2d802466">demandEvent</a> (in typecode type, in Object src)</td></tr>
<tr class="memdesc:a2efc0181644cbcbf57dc18eb2d802466"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subscribe for events that are of given type and emitted by a specific object instance.  <a href="interfaceevent_1_1Channel.html#a2efc0181644cbcbf57dc18eb2d802466">More...</a><br /></td></tr>
<tr class="separator:a2efc0181644cbcbf57dc18eb2d802466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae44d20ac72f4e16259d1b6d3eecea422"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#ae44d20ac72f4e16259d1b6d3eecea422">cancelEvent</a> (in typecode type, in Object src)</td></tr>
<tr class="memdesc:ae44d20ac72f4e16259d1b6d3eecea422"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the subscription for events that are of given type and emitted by a specific object instance.  <a href="interfaceevent_1_1Channel.html#ae44d20ac72f4e16259d1b6d3eecea422">More...</a><br /></td></tr>
<tr class="separator:ae44d20ac72f4e16259d1b6d3eecea422"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfaef59f3ff2421f662ee3e4a752749e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#acfaef59f3ff2421f662ee3e4a752749e">demandEvents</a> (in vector&lt; <a class="el" href="structevent_1_1Channel_1_1EventSelect.html">EventSelect</a> &gt; events)</td></tr>
<tr class="memdesc:acfaef59f3ff2421f662ee3e4a752749e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subscribe for multiple specific events at once.  <a href="interfaceevent_1_1Channel.html#acfaef59f3ff2421f662ee3e4a752749e">More...</a><br /></td></tr>
<tr class="separator:acfaef59f3ff2421f662ee3e4a752749e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfbd245ad27eeea7a15dec7425e94866"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#adfbd245ad27eeea7a15dec7425e94866">cancelEvents</a> (in vector&lt; <a class="el" href="structevent_1_1Channel_1_1EventSelect.html">EventSelect</a> &gt; events)</td></tr>
<tr class="memdesc:adfbd245ad27eeea7a15dec7425e94866"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the subscription for multiple specific events.  <a href="interfaceevent_1_1Channel.html#adfbd245ad27eeea7a15dec7425e94866">More...</a><br /></td></tr>
<tr class="separator:adfbd245ad27eeea7a15dec7425e94866"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e6cc5ad2b8cae91d64e4bab9c925af1"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a9e6cc5ad2b8cae91d64e4bab9c925af1">pollEvents</a> (out vector&lt; <a class="el" href="structidl_1_1Event.html">idl::Event</a> &gt; events)</td></tr>
<tr class="memdesc:a9e6cc5ad2b8cae91d64e4bab9c925af1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll for new events blockingly.  <a href="interfaceevent_1_1Channel.html#a9e6cc5ad2b8cae91d64e4bab9c925af1">More...</a><br /></td></tr>
<tr class="separator:a9e6cc5ad2b8cae91d64e4bab9c925af1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a2ace064a76d94aaa5fb1919c56dda0"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1Channel.html#a4a2ace064a76d94aaa5fb1919c56dda0">pollEventsNb</a> (out vector&lt; <a class="el" href="structidl_1_1Event.html">idl::Event</a> &gt; events)</td></tr>
<tr class="memdesc:a4a2ace064a76d94aaa5fb1919c56dda0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll for new events non-blockingly.  <a href="interfaceevent_1_1Channel.html#a4a2ace064a76d94aaa5fb1919c56dda0">More...</a><br /></td></tr>
<tr class="separator:a4a2ace064a76d94aaa5fb1919c56dda0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i....">Event</a> <a class="el" href="interfaceevent_1_1Channel.html" title="Event Channel.">Channel</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae44d20ac72f4e16259d1b6d3eecea422"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae44d20ac72f4e16259d1b6d3eecea422">&#9670;&nbsp;</a></span>cancelEvent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::cancelEvent </td>
          <td>(</td>
          <td class="paramtype">in typecode&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in Object&#160;</td>
          <td class="paramname"><em>src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancel the subscription for events that are of given type and emitted by a specific object instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">evttype</td><td>Event typecode </td></tr>
    <tr><td class="paramname">src</td><td>Event source instance </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="adfbd245ad27eeea7a15dec7425e94866"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfbd245ad27eeea7a15dec7425e94866">&#9670;&nbsp;</a></span>cancelEvents()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::cancelEvents </td>
          <td>(</td>
          <td class="paramtype">in vector&lt; <a class="el" href="structevent_1_1Channel_1_1EventSelect.html">EventSelect</a> &gt;&#160;</td>
          <td class="paramname"><em>events</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancel the subscription for multiple specific events. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">events</td><td>List of typecodes to unsubscribe from </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a5b962b946c04651f3c3cbb8fe4c473d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b962b946c04651f3c3cbb8fe4c473d0">&#9670;&nbsp;</a></span>cancelEventType()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::cancelEventType </td>
          <td>(</td>
          <td class="paramtype">in typecode&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancel the subscription for events of a given type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">evttype</td><td>typecode of valueobject of demanded event </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a59a4a26903dd06ccd456077067325b5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59a4a26903dd06ccd456077067325b5a">&#9670;&nbsp;</a></span>cancelEventTypes()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::cancelEventTypes </td>
          <td>(</td>
          <td class="paramtype">in vector&lt; typecode &gt;&#160;</td>
          <td class="paramname"><em>types</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancel subscription for events that are of any of given types. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">evttypes</td><td>List of event typecodes </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a2efc0181644cbcbf57dc18eb2d802466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2efc0181644cbcbf57dc18eb2d802466">&#9670;&nbsp;</a></span>demandEvent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::demandEvent </td>
          <td>(</td>
          <td class="paramtype">in typecode&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in Object&#160;</td>
          <td class="paramname"><em>src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Subscribe for events that are of given type and emitted by a specific object instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">evttype</td><td>Event typecode </td></tr>
    <tr><td class="paramname">src</td><td>Event source instance </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="acfaef59f3ff2421f662ee3e4a752749e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfaef59f3ff2421f662ee3e4a752749e">&#9670;&nbsp;</a></span>demandEvents()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::demandEvents </td>
          <td>(</td>
          <td class="paramtype">in vector&lt; <a class="el" href="structevent_1_1Channel_1_1EventSelect.html">EventSelect</a> &gt;&#160;</td>
          <td class="paramname"><em>events</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Subscribe for multiple specific events at once. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">events</td><td>List of typecodes to subscribe for </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a8de92136097076091b6787f8bb0bf386"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8de92136097076091b6787f8bb0bf386">&#9670;&nbsp;</a></span>demandEventType()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::demandEventType </td>
          <td>(</td>
          <td class="paramtype">in typecode&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Subscribe for events of a given type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">evttype</td><td>typecode of valueobject of demanded event </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a31b429b0b7c1a85c5bcbde1479024703"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31b429b0b7c1a85c5bcbde1479024703">&#9670;&nbsp;</a></span>demandEventTypes()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void event::Channel::demandEventTypes </td>
          <td>(</td>
          <td class="paramtype">in vector&lt; typecode &gt;&#160;</td>
          <td class="paramname"><em>types</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Subscribe for multiple event types at once. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">evttypes</td><td>List of event typecodes </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a9e6cc5ad2b8cae91d64e4bab9c925af1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e6cc5ad2b8cae91d64e4bab9c925af1">&#9670;&nbsp;</a></span>pollEvents()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean event::Channel::pollEvents </td>
          <td>(</td>
          <td class="paramtype">out vector&lt; <a class="el" href="structidl_1_1Event.html">idl::Event</a> &gt;&#160;</td>
          <td class="paramname"><em>events</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Poll for new events blockingly. </p>
<p>This method will block in case the queue is empty. It will return as soon as at least one event is available, or after a maximum wait time of 30 seconds.</p>
<p>The method will not return more than an implementation-defined maximum number of events. The boolean return value indicates whether there are more events in the queue.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">events</td><td>List of new events </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if there are more events in the queue <code>false</code> if the queue is empty </dd></dl>

</div>
</div>
<a id="a4a2ace064a76d94aaa5fb1919c56dda0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a2ace064a76d94aaa5fb1919c56dda0">&#9670;&nbsp;</a></span>pollEventsNb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean event::Channel::pollEventsNb </td>
          <td>(</td>
          <td class="paramtype">out vector&lt; <a class="el" href="structidl_1_1Event.html">idl::Event</a> &gt;&#160;</td>
          <td class="paramname"><em>events</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Poll for new events non-blockingly. </p>
<p>The method will not return more than an implementation-defined maximum number of events. The boolean return value indicates whether there are more events in the queue.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">events</td><td>List of new events </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if there are more events in the queue <code>false</code> if the queue is empty </dd></dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="EventService_8idl_source.html">EventService.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&#160;<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>