/usr/share/doc/ice34-slice/reference/Freeze/Evictor.html is in ice34-slice 3.4.2-4ubuntu1.
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 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 | <!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>
Freeze::Evictor
</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="DeadlockException.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Freeze.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="EvictorDeactivatedException.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">Freeze::Evictor</h1>
<h2>Overview</h2>
<h3 class="Synopsis">local interface Evictor extends <a class="Symbol" href="../Ice/ServantLocator.html#ServantLocator">::Ice::ServantLocator</a></h3>
<p>
An automatic Ice object persistence manager, based on the
evictor pattern. The evictor is a servant locator implementation
that stores the persistent state of its objects in a database. Any
number of objects can be registered with an evictor, but only a
configurable number of servants are active at a time. These active
servants reside in a queue; the least recently used servant in the
queue is the first to be evicted when a new servant is activated.</p>
<h4>Derived Classes and Interfaces</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="BackgroundSaveEvictor.html#BackgroundSaveEvictor">BackgroundSaveEvictor</a></dt>
<dt class="Symbol"><a class="Symbol" href="TransactionalEvictor.html#TransactionalEvictor">TransactionalEvictor</a></dt>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="ServantInitializer.html">ServantInitializer</a></dt>
</dl>
<h2>Operation Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setSize">setSize</a></dt>
<dd>
Set the size of the evictor's servant queue.</dd>
<dt class="Symbol"><a class="Symbol" href="#getSize">getSize</a></dt>
<dd>
Get the size of the evictor's servant queue.</dd>
<dt class="Symbol"><a class="Symbol" href="#add">add</a></dt>
<dd>
Add a servant to this evictor.</dd>
<dt class="Symbol"><a class="Symbol" href="#addFacet">addFacet</a></dt>
<dd>
Like <a class="Symbol" href="#add">add</a>, but with a facet.</dd>
<dt class="Symbol"><a class="Symbol" href="#remove">remove</a></dt>
<dd>
Permanently destroy an Ice object.</dd>
<dt class="Symbol"><a class="Symbol" href="#removeFacet">removeFacet</a></dt>
<dd>
Like <a class="Symbol" href="#remove">remove</a>, but with a facet.</dd>
<dt class="Symbol"><a class="Symbol" href="#hasObject">hasObject</a></dt>
<dd>
Returns true if the given identity is managed by the evictor
with the default facet.</dd>
<dt class="Symbol"><a class="Symbol" href="#hasFacet">hasFacet</a></dt>
<dd>
Like <a class="Symbol" href="#hasObject">hasObject</a>, but with a facet.</dd>
<dt class="Symbol"><a class="Symbol" href="#getIterator">getIterator</a></dt>
<dd>
Get an iterator for the identities managed by the evictor.</dd>
</dl>
<h2>Operations</h2>
<h3 class="Synopsis">void <a class="Symbol" name="setSize">setSize</a>(int sz)</h3>
<p>
Set the size of the evictor's servant queue. This is the
maximum number of servants the evictor keeps active. Requests
to set the queue size to a value smaller than zero are ignored.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">sz</dt>
<dd>
The size of the servant queue. If the evictor
currently holds more than <tt>sz</tt> servants in its queue, it evicts
enough servants to match the new size. Note that this operation
can block if the new queue size is smaller than the current
number of servants that are servicing requests. In this case,
the operation waits until a sufficient number of servants
complete their requests.</dd>
</dl>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if a the evictor has
been deactivated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#getSize">getSize</a></dt>
</dl>
<h3 class="Synopsis">int <a class="Symbol" name="getSize">getSize</a>()</h3>
<p>
Get the size of the evictor's servant queue.</p>
<h4>Return Value</h4>
<p>The size of the servant queue.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if a the evictor has
been deactivated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setSize">setSize</a></dt>
</dl>
<h3 class="Synopsis">Object* <a class="Symbol" name="add">add</a>(Object servant, <a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id)</h3>
<p>
Add a servant to this evictor. The state of the servant passed to
this operation will be saved in the evictor's persistent store.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">servant</dt>
<dd>
The servant to add.</dd>
<dt class="Symbol">id</dt>
<dd>
The identity of the Ice object that is implemented by
the servant.</dd>
</dl>
<h4>Return Value</h4>
<p>A proxy that matches the given identity and this evictor's
object adapter.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Ice/AlreadyRegisteredException.html">::Ice::AlreadyRegisteredException</a></dt>
<dd>
Raised if the evictor already has
an object with this identity.</dd>
<dt class="Symbol"><a class="Symbol" href="DatabaseException.html">DatabaseException</a></dt>
<dd>
Raised if a database failure occurred.</dd>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if the evictor has
been deactivated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#addFacet">addFacet</a></dt>
<dt class="Symbol"><a class="Symbol" href="#remove">remove</a></dt>
<dt class="Symbol"><a class="Symbol" href="#removeFacet">removeFacet</a></dt>
</dl>
<h3 class="Synopsis">Object* <a class="Symbol" name="addFacet">addFacet</a>(Object servant, <a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id, string facet)</h3>
<p>
Like <a class="Symbol" href="#add">add</a>, but with a facet. Calling <tt>add(servant, id)</tt>
is equivalent to calling <a class="Symbol" href="#addFacet">addFacet</a> with an empty
facet.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">servant</dt>
<dd>
The servant to add.</dd>
<dt class="Symbol">id</dt>
<dd>
The identity of the Ice object that is implemented by
the servant.</dd>
<dt class="Symbol">facet</dt>
<dd>
The facet. An empty facet means the default
facet.</dd>
</dl>
<h4>Return Value</h4>
<p>A proxy that matches the given identity and this evictor's
object adapter.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Ice/AlreadyRegisteredException.html">::Ice::AlreadyRegisteredException</a></dt>
<dd>
Raised if the evictor already has
an object with this identity.</dd>
<dt class="Symbol"><a class="Symbol" href="DatabaseException.html">DatabaseException</a></dt>
<dd>
Raised if a database failure occurred.</dd>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if the evictor has
been deactivated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#add">add</a></dt>
<dt class="Symbol"><a class="Symbol" href="#remove">remove</a></dt>
<dt class="Symbol"><a class="Symbol" href="#removeFacet">removeFacet</a></dt>
</dl>
<h3 class="Synopsis">Object <a class="Symbol" name="remove">remove</a>(<a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id)</h3>
<p>
Permanently destroy an Ice object.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">id</dt>
<dd>
The identity of the Ice object.</dd>
</dl>
<h4>Return Value</h4>
<p>The removed servant.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Ice/NotRegisteredException.html">::Ice::NotRegisteredException</a></dt>
<dd>
Raised if this identity was not
registered with the evictor.</dd>
<dt class="Symbol"><a class="Symbol" href="DatabaseException.html">DatabaseException</a></dt>
<dd>
Raised if a database failure occurred.</dd>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if the evictor has
been deactivated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#add">add</a></dt>
<dt class="Symbol"><a class="Symbol" href="#removeFacet">removeFacet</a></dt>
</dl>
<h3 class="Synopsis">Object <a class="Symbol" name="removeFacet">removeFacet</a>(<a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id, string facet)</h3>
<p>
Like <a class="Symbol" href="#remove">remove</a>, but with a facet. Calling <tt>remove(id)</tt>
is equivalent to calling <a class="Symbol" href="#removeFacet">removeFacet</a> with an empty facet.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">id</dt>
<dd>
The identity of the Ice object.</dd>
<dt class="Symbol">facet</dt>
<dd>
The facet. An empty facet means the default
facet.</dd>
</dl>
<h4>Return Value</h4>
<p>The removed servant.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Ice/NotRegisteredException.html">::Ice::NotRegisteredException</a></dt>
<dd>
Raised if this identity was not
registered with the evictor.</dd>
<dt class="Symbol"><a class="Symbol" href="DatabaseException.html">DatabaseException</a></dt>
<dd>
Raised if a database failure occurred.</dd>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if the evictor has
been deactivated.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#remove">remove</a></dt>
<dt class="Symbol"><a class="Symbol" href="#addFacet">addFacet</a></dt>
</dl>
<h3 class="Synopsis">bool <a class="Symbol" name="hasObject">hasObject</a>(<a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id)</h3>
<p>
Returns true if the given identity is managed by the evictor
with the default facet.</p>
<h4>Return Value</h4>
<p>true if the identity is managed by the evictor, false
otherwise.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="DatabaseException.html">DatabaseException</a></dt>
<dd>
Raised if a database failure occurred.</dd>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if a the evictor has
been deactivated.</dd>
</dl>
<h3 class="Synopsis">bool <a class="Symbol" name="hasFacet">hasFacet</a>(<a class="Symbol" href="../Ice/Identity.html">::Ice::Identity</a> id, string facet)</h3>
<p>
Like <a class="Symbol" href="#hasObject">hasObject</a>, but with a facet. Calling <tt>hasObject(id)</tt>
is equivalent to calling @link #hasFacet] with an empty
facet.</p>
<h4>Return Value</h4>
<p>true if the identity is managed by the evictor for the
given facet, false otherwise.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="DatabaseException.html">DatabaseException</a></dt>
<dd>
Raised if a database failure occurred.</dd>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if a the evictor has
been deactivated.</dd>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="EvictorIterator.html">EvictorIterator</a> <a class="Symbol" name="getIterator">getIterator</a>(string facet, int batchSize)</h3>
<p>
Get an iterator for the identities managed by the evictor.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">facet</dt>
<dd>
The facet. An empty facet means the default
facet.</dd>
<dt class="Symbol">batchSize</dt>
<dd>
Internally, the Iterator retrieves the
identities in batches of size batchSize. Selecting a small batchSize
can have an adverse effect on performance.</dd>
</dl>
<h4>Return Value</h4>
<p>A new iterator.</p>
<h4>Exceptions</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="EvictorDeactivatedException.html">EvictorDeactivatedException</a></dt>
<dd>
Raised if a the evictor has
been deactivated.</dd>
</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="DeadlockException.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Freeze.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="EvictorDeactivatedException.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>
|