/usr/share/doc/ice34-slice/reference/IceGrid/Session.html is in ice34-slice 3.4.2-8.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>
IceGrid::Session
</title>
<style type="text/css">
body {
font-family: Arial, Helvetica, sans-serif;
}
.Page {
width: 850px;
margin-left: auto;
margin-right: auto;
}
.Symbol {
font-family: "Courier New", Courier, mono;
}
.Synopsis {
font-family: "Courier New", Courier, mono;
font-weight: bold;
}
.Deprecated {
font-style: italic;
}
.Warning {
font-style: italic;
}
.Note {
font-style: italic;
}
.HeaderFooter {
width: 100%;
}
.Logo {
border-style: none;
}
.LogoTable {
}
.Button {
border-style: none;
}
.ButtonGrey {
border-style: none;
cursor: default;
}
</style>
</head>
<body>
<div class="Page">
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html"><img class="Button" src="../images/home.gif" alt="Home"></a></td>
<td><a href="ServiceInstanceDescriptor.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../IceGrid.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="TemplateDescriptor.html"><img class="Button" src="../images/next.gif" alt="Next"></a></td>
<td><a href="../_sindex.html"><img class="Button" src="../images/index.gif" alt="Index"></a></td>
</tr>
</table>
</td>
<td align="center">
<table>
<tr>
<td>
<form method="get" action="/cgi-bin/swish.cgi" enctype="application/x-www-form-urlencoded" class="form">
<div>
<input maxlength="100" value="" type="text" name="query">
<input type="submit" value="Search" name="submit"></div>
</form></td>
</tr>
</table>
</td>
<td align="right">
<table class="LogoTable">
<tr>
<td><a href="http://www.zeroc.com"><img class="Logo" src="../images/logo.gif" alt="Logo"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- SwishCommand index -->
<hr>
<h1 class="Symbol">IceGrid::Session</h1>
<h2>Overview</h2>
<h3 class="Synopsis">interface Session extends <a class="Symbol" href="../Glacier2/Session.html#Session">::Glacier2::Session</a></h3>
<p>
A session object is used by IceGrid clients to allocate and
release objects. Client sessions are either created with the
<a class="Symbol" href="Registry.html">Registry</a> object or the registry client <a class="Symbol" href="../Glacier2/SessionManager.html">::Glacier2::SessionManager</a>
object.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Registry.html">Registry</a></dt>
<dt class="Symbol"><a class="Symbol" href="../Glacier2/SessionManager.html">::Glacier2::SessionManager</a></dt>
</dl>
<h2>Operation Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="#keepAlive">keepAlive</a></dt>
<dd>
Keep the session alive.</dd>
<dt class="Symbol"><a class="Symbol" href="#allocateObjectById">allocateObjectById</a></dt>
<dd>
Allocate an object.</dd>
<dt class="Symbol"><a class="Symbol" href="#allocateObjectByType">allocateObjectByType</a></dt>
<dd>
Allocate an object with the given type.</dd>
<dt class="Symbol"><a class="Symbol" href="#releaseObject">releaseObject</a></dt>
<dd>
Release an object.</dd>
<dt class="Symbol"><a class="Symbol" href="#setAllocationTimeout">setAllocationTimeout</a></dt>
<dd>
Set the allocation timeout.</dd>
</dl>
<h2>Operations</h2>
<h3 class="Synopsis">void <a class="Symbol" name="keepAlive">keepAlive</a>()</h3>
<p>
Keep the session alive. Clients should call this operation
regularly to prevent the server from reaping the session.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Registry.html#getSessionTimeout">Registry::getSessionTimeout</a></dt>
</dl>
<h3 class="Synopsis">Object* <a class="Symbol" name="allocateObjectById">allocateObjectById</a>(<a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id) throws <a class="Symbol" href="ObjectNotRegisteredException.html">ObjectNotRegisteredException</a>, <a class="Symbol" href="AllocationException.html">AllocationException</a></h3>
<p>
Allocate an object. Depending on the allocation timeout, this
operation might hang until the object is available or until the
timeout is reached.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">id</dt>
<dd>
The identity of the object to allocate.</dd>
</dl>
<h4>Return Value</h4>
<p>The proxy of the allocated object.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="ObjectNotRegisteredException.html">ObjectNotRegisteredException</a></dt>
<dd>
Raised if the object with
the given identity is not registered with the registry.</dd>
<dt class="Symbol"><a class="Symbol" href="AllocationException.html">AllocationException</a></dt>
<dd>
Raised if the object can't be
allocated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setAllocationTimeout">setAllocationTimeout</a></dt>
<dt class="Symbol"><a class="Symbol" href="#releaseObject">releaseObject</a></dt>
</dl>
<h3 class="Synopsis">Object* <a class="Symbol" name="allocateObjectByType">allocateObjectByType</a>(string type) throws <a class="Symbol" href="AllocationException.html">AllocationException</a></h3>
<p>
Allocate an object with the given type. Depending on the
allocation timeout, this operation can block until an object
becomes available or until the timeout is reached.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">type</dt>
<dd>
The type of the object.</dd>
</dl>
<h4>Return Value</h4>
<p>The proxy of the allocated object.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="ObjectNotRegisteredException.html">ObjectNotRegisteredException</a></dt>
<dd>
Raised if no objects with the given type can be allocated.</dd>
<dt class="Symbol"><a class="Symbol" href="AllocationException.html">AllocationException</a></dt>
<dd>
Raised if the object could not be allocated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setAllocationTimeout">setAllocationTimeout</a></dt>
<dt class="Symbol"><a class="Symbol" href="#releaseObject">releaseObject</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="releaseObject">releaseObject</a>(<a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id) throws <a class="Symbol" href="ObjectNotRegisteredException.html">ObjectNotRegisteredException</a>, <a class="Symbol" href="AllocationException.html">AllocationException</a></h3>
<p>
Release an object.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">id</dt>
<dd>
The identity of the object to release.</dd>
</dl>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="ObjectNotRegisteredException.html">ObjectNotRegisteredException</a></dt>
<dd>
Raised if the object with
the given identity is not registered with the registry.</dd>
<dt class="Symbol"><a class="Symbol" href="AllocationException.html">AllocationException</a></dt>
<dd>
Raised if the given object can't be
released. This might happen if the object isn't allocatable or
isn't allocated by the session.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#allocateObjectById">allocateObjectById</a></dt>
<dt class="Symbol"><a class="Symbol" href="#allocateObjectByType">allocateObjectByType</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="setAllocationTimeout">setAllocationTimeout</a>(int timeout)</h3>
<p>
Set the allocation timeout. If no objects are available for an
allocation request, the request will hang for the duration of
this timeout.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">timeout</dt>
<dd>
The timeout in milliseconds.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#allocateObjectById">allocateObjectById</a></dt>
<dt class="Symbol"><a class="Symbol" href="#allocateObjectByType">allocateObjectByType</a></dt>
</dl>
<hr>
<!-- SwishCommand noindex -->
<table class="HeaderFooter">
<tr>
<td align="left">
<table>
<tr>
<td><a href="../index.html"><img class="Button" src="../images/home.gif" alt="Home"></a></td>
<td><a href="ServiceInstanceDescriptor.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../IceGrid.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="TemplateDescriptor.html"><img class="Button" src="../images/next.gif" alt="Next"></a></td>
<td><a href="../_sindex.html"><img class="Button" src="../images/index.gif" alt="Index"></a></td>
</tr>
</table>
</td>
<td align="center">
<table>
<tr>
<td>
<form method="get" action="/cgi-bin/swish.cgi" enctype="application/x-www-form-urlencoded" class="form">
<div>
<input maxlength="100" value="" type="text" name="query">
<input type="submit" value="Search" name="submit"></div>
</form></td>
</tr>
</table>
</td>
<td align="right">
<table class="LogoTable">
<tr>
<td><a href="http://www.zeroc.com"><img class="Logo" src="../images/logo.gif" alt="Logo"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<!-- SwishCommand index -->
</div>
</body>
</html>
|