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
|
<!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: session::SessionManager 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="namespacesession.html">session</a></li><li class="navelem"><a class="el" href="interfacesession_1_1SessionManager.html">SessionManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacesession_1_1SessionManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">session::SessionManager Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Session manager interface
<a href="interfacesession_1_1SessionManager.html#details">More...</a></p>
<p><code>import"<a class="el" href="SessionManager_8idl_source.html">SessionManager.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afd44ccd4c3e150332790171faab23939"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">CloseReason</a> { <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939ac70120e2835035b57d7e996733e1d76d">CLOSE_REASON_LOGOUT</a>
, <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939a53528547c7feaa869da60554c901bcb1">CLOSE_REASON_TIMEOUT</a>
, <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939a107630921c2e44764368fb7c2ae90f43">CLOSE_REASON_BROWSER_CLOSED</a>
, <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939a084f9740521f050915409e18328fd7f4">CLOSE_REASON_FORCED_DISCONNECT</a>
}</td></tr>
<tr class="memdesc:afd44ccd4c3e150332790171faab23939"><td class="mdescLeft"> </td><td class="mdescRight">Session close reasons <a href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">More...</a><br /></td></tr>
<tr class="separator:afd44ccd4c3e150332790171faab23939"><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:ad40e5e417779ef5d83759eb331df10d2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#ad40e5e417779ef5d83759eb331df10d2">newSession</a> (out <a class="el" href="structsession_1_1Session.html">Session</a> session, out string token)</td></tr>
<tr class="memdesc:ad40e5e417779ef5d83759eb331df10d2"><td class="mdescLeft"> </td><td class="mdescRight">Open a new session. <a href="interfacesession_1_1SessionManager.html#ad40e5e417779ef5d83759eb331df10d2">More...</a><br /></td></tr>
<tr class="separator:ad40e5e417779ef5d83759eb331df10d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b5a8b725d600b2a920fbf7e5767f2cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsession_1_1Session.html">Session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#a9b5a8b725d600b2a920fbf7e5767f2cf">getCurrentSession</a> ()</td></tr>
<tr class="memdesc:a9b5a8b725d600b2a920fbf7e5767f2cf"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve current session information. <a href="interfacesession_1_1SessionManager.html#a9b5a8b725d600b2a920fbf7e5767f2cf">More...</a><br /></td></tr>
<tr class="separator:a9b5a8b725d600b2a920fbf7e5767f2cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f0b0de84a9d5b9d794f88ce0b6955fd"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structsession_1_1Session.html">Session</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#a8f0b0de84a9d5b9d794f88ce0b6955fd">getSessions</a> ()</td></tr>
<tr class="memdesc:a8f0b0de84a9d5b9d794f88ce0b6955fd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve all open sessions. <a href="interfacesession_1_1SessionManager.html#a8f0b0de84a9d5b9d794f88ce0b6955fd">More...</a><br /></td></tr>
<tr class="separator:a8f0b0de84a9d5b9d794f88ce0b6955fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a063d5690f13f5e96ee1ed35131a77c00"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#a063d5690f13f5e96ee1ed35131a77c00">closeSession</a> (in int sessionId, in <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">CloseReason</a> reason)</td></tr>
<tr class="memdesc:a063d5690f13f5e96ee1ed35131a77c00"><td class="mdescLeft"> </td><td class="mdescRight">Close a session identified by its token. <a href="interfacesession_1_1SessionManager.html#a063d5690f13f5e96ee1ed35131a77c00">More...</a><br /></td></tr>
<tr class="separator:a063d5690f13f5e96ee1ed35131a77c00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f6a8bab1b914af0feb49f380746a023"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#a1f6a8bab1b914af0feb49f380746a023">closeCurrentSession</a> (in <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">CloseReason</a> reason)</td></tr>
<tr class="memdesc:a1f6a8bab1b914af0feb49f380746a023"><td class="mdescLeft"> </td><td class="mdescRight">Close the current session. <a href="interfacesession_1_1SessionManager.html#a1f6a8bab1b914af0feb49f380746a023">More...</a><br /></td></tr>
<tr class="separator:a1f6a8bab1b914af0feb49f380746a023"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae362d9890ef9cf660bb8c23a73f6625e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#ae362d9890ef9cf660bb8c23a73f6625e">touchCurrentSession</a> (in boolean userActivity)</td></tr>
<tr class="memdesc:ae362d9890ef9cf660bb8c23a73f6625e"><td class="mdescLeft"> </td><td class="mdescRight">Reset the current session's idle timer. <a href="interfacesession_1_1SessionManager.html#ae362d9890ef9cf660bb8c23a73f6625e">More...</a><br /></td></tr>
<tr class="separator:ae362d9890ef9cf660bb8c23a73f6625e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4854c66d2db6495eea5dd2a1ce4fe98"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structsession_1_1HistoryEntry.html">HistoryEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#af4854c66d2db6495eea5dd2a1ce4fe98">getSessionHistory</a> ()</td></tr>
<tr class="memdesc:af4854c66d2db6495eea5dd2a1ce4fe98"><td class="mdescLeft"> </td><td class="mdescRight">Get previous session data for the current user. <a href="interfacesession_1_1SessionManager.html#af4854c66d2db6495eea5dd2a1ce4fe98">More...</a><br /></td></tr>
<tr class="separator:af4854c66d2db6495eea5dd2a1ce4fe98"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8215e171033c622c41bb3f087b4a5583"><td class="memItemLeft" align="right" valign="top"><a id="a8215e171033c622c41bb3f087b4a5583"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesession_1_1SessionManager.html#a8215e171033c622c41bb3f087b4a5583">ERR_ACTIVE_SESSION_EXCLUSIVE_FOR_USER</a> = 1</td></tr>
<tr class="memdesc:a8215e171033c622c41bb3f087b4a5583"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structsession_1_1Session.html" title="Session information">Session</a> creation denied due to single login limitation. <br /></td></tr>
<tr class="separator:a8215e171033c622c41bb3f087b4a5583"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Session manager interface </p>
<p><a class="el" href="structsession_1_1Session.html" title="Session information">Session</a> manager allows clients to announce a user session, i.e. consecutive activity that is related to each other, and make use of session services. Depending on transport protocoll an established session allows simplified authentication using the session token. For instance, for HTTP transport implementation sessiontoken can be written into HTTP Header while other authentication schemes may be omitted (for details, see transport mapping documentation). Each session has a defined timeout and an idle timer. A session is deleted once idle time is equal or greater than session timeout. Idle timer is implicitely touched by transport implementation whenever a call arrives that can be mapped to a particular session. In addition a client may decide to call touchCurrentSession with userActivity flag set to true. In this case userIdle attribute of session is reset to 0. This has purely informational character and will not cause any further action of session manager. It may be used to determine user activity under the assumptions that clients may do frequent background calls without actual user activity. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="afd44ccd4c3e150332790171faab23939"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd44ccd4c3e150332790171faab23939">◆ </a></span>CloseReason</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">session::SessionManager::CloseReason</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Session close reasons </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afd44ccd4c3e150332790171faab23939ac70120e2835035b57d7e996733e1d76d"></a>CLOSE_REASON_LOGOUT </td><td class="fielddoc"><p>Regular logout. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd44ccd4c3e150332790171faab23939a53528547c7feaa869da60554c901bcb1"></a>CLOSE_REASON_TIMEOUT </td><td class="fielddoc"><p><a class="el" href="structsession_1_1Session.html" title="Session information">Session</a> timed out. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd44ccd4c3e150332790171faab23939a107630921c2e44764368fb7c2ae90f43"></a>CLOSE_REASON_BROWSER_CLOSED </td><td class="fielddoc"><p>Browser window was closed. </p>
</td></tr>
<tr><td class="fieldname"><a id="afd44ccd4c3e150332790171faab23939a084f9740521f050915409e18328fd7f4"></a>CLOSE_REASON_FORCED_DISCONNECT </td><td class="fielddoc"><p><a class="el" href="structsession_1_1Session.html" title="Session information">Session</a> was forcibly closed. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1f6a8bab1b914af0feb49f380746a023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f6a8bab1b914af0feb49f380746a023">◆ </a></span>closeCurrentSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void session::SessionManager::closeCurrentSession </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">CloseReason</a> </td>
<td class="paramname"><em>reason</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the current session. </p>
<p>This call must be authenticated using a session token.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reason</td><td>close reason </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a063d5690f13f5e96ee1ed35131a77c00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a063d5690f13f5e96ee1ed35131a77c00">◆ </a></span>closeSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void session::SessionManager::closeSession </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>sessionId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="interfacesession_1_1SessionManager.html#afd44ccd4c3e150332790171faab23939">CloseReason</a> </td>
<td class="paramname"><em>reason</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a session identified by its token. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sessionId</td><td>ID of the session that should be closed </td></tr>
<tr><td class="paramname">reason</td><td>close reason </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9b5a8b725d600b2a920fbf7e5767f2cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b5a8b725d600b2a920fbf7e5767f2cf">◆ </a></span>getCurrentSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsession_1_1Session.html">Session</a> session::SessionManager::getCurrentSession </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve current session information. </p>
<p>This call must be authenticated using a session token.</p>
<dl class="section return"><dt>Returns</dt><dd>Session information </dd></dl>
</div>
</div>
<a id="af4854c66d2db6495eea5dd2a1ce4fe98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4854c66d2db6495eea5dd2a1ce4fe98">◆ </a></span>getSessionHistory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structsession_1_1HistoryEntry.html">HistoryEntry</a>> session::SessionManager::getSessionHistory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get previous session data for the current user. </p>
<dl class="section return"><dt>Returns</dt><dd>History data, sorted from newer to older sessions </dd></dl>
</div>
</div>
<a id="a8f0b0de84a9d5b9d794f88ce0b6955fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f0b0de84a9d5b9d794f88ce0b6955fd">◆ </a></span>getSessions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structsession_1_1Session.html">Session</a>> session::SessionManager::getSessions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve all open sessions. </p>
<dl class="section return"><dt>Returns</dt><dd>List of sessions </dd></dl>
</div>
</div>
<a id="ad40e5e417779ef5d83759eb331df10d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad40e5e417779ef5d83759eb331df10d2">◆ </a></span>newSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int session::SessionManager::newSession </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="structsession_1_1Session.html">Session</a> </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>token</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a new session. </p>
<p>This function will create a new session for the authenticated user. Upon success it will return a session token which can be used to authenticate future requests.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>Session information </td></tr>
<tr><td class="paramname">token</td><td>Returned token for the newly created session</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if session creation was denied due to single login limitation </dd></dl>
</div>
</div>
<a id="ae362d9890ef9cf660bb8c23a73f6625e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae362d9890ef9cf660bb8c23a73f6625e">◆ </a></span>touchCurrentSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void session::SessionManager::touchCurrentSession </td>
<td>(</td>
<td class="paramtype">in boolean </td>
<td class="paramname"><em>userActivity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the current session's idle timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">userActivity</td><td>Indicates that the session is touched due to user activity.</td></tr>
</table>
</dd>
</dl>
<p>If userActivity is not set, this is internally a NOP since any RPC call will implicitly touch the session. This call must be authenticated using a session token. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="SessionManager_8idl_source.html">SessionManager.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>
|
