/usr/share/doc/ice34-slice/reference/Ice/Communicator.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 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 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | <!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>
Ice::Communicator
</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="CollocationOptimizationException.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Ice.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="CommunicatorDestroyedException.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">Ice::Communicator</h1>
<h2>Overview</h2>
<h3 class="Synopsis">local interface Communicator</h3>
<p>
The central object in Ice. One or more communicators can be
instantiated for an Ice application. Communicator instantiation
is language-specific, and not specified in Slice code.</p>
<h4>Used By</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="../Freeze/Connection.html#getCommunicator">::Freeze::Connection::getCommunicator</a></dt>
<dt class="Symbol"><a class="Symbol" href="../IceBox/Service.html#start">::IceBox::Service::start</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html#getCommunicator">ObjectAdapter::getCommunicator</a></dt>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Logger.html">Logger</a></dt>
<dt class="Symbol"><a class="Symbol" href="Stats.html">Stats</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a></dt>
<dt class="Symbol"><a class="Symbol" href="Properties.html">Properties</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectFactory.html">ObjectFactory</a></dt>
</dl>
<h2>Operation Index</h2>
<dl>
<dt class="Symbol"><a class="Symbol" href="#destroy">destroy</a></dt>
<dd>
Destroy the communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#shutdown">shutdown</a></dt>
<dd>
Shuts down this communicator's server functionality, which
includes the deactivation of all object adapters.</dd>
<dt class="Symbol"><a class="Symbol" href="#waitForShutdown">waitForShutdown</a></dt>
<dd>
Wait until the application has called <a class="Symbol" href="#shutdown">shutdown</a> (or <a class="Symbol" href="#destroy">destroy</a>).</dd>
<dt class="Symbol"><a class="Symbol" href="#isShutdown">isShutdown</a></dt>
<dd>
Check whether communicator has been shut down.</dd>
<dt class="Symbol"><a class="Symbol" href="#stringToProxy">stringToProxy</a></dt>
<dd>
Convert a stringified proxy into a proxy.</dd>
<dt class="Symbol"><a class="Symbol" href="#proxyToString">proxyToString</a></dt>
<dd>
Convert a proxy into a string.</dd>
<dt class="Symbol"><a class="Symbol" href="#propertyToProxy">propertyToProxy</a></dt>
<dd>
Convert a set of proxy properties into a proxy.</dd>
<dt class="Symbol"><a class="Symbol" href="#proxyToProperty">proxyToProperty</a></dt>
<dd>
Convert a proxy to a set of proxy properties.</dd>
<dt class="Symbol"><a class="Symbol" href="#stringToIdentity">stringToIdentity</a></dt>
<dd>
Convert a string into an identity.</dd>
<dt class="Symbol"><a class="Symbol" href="#identityToString">identityToString</a></dt>
<dd>
Convert an identity into a string.</dd>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapter">createObjectAdapter</a></dt>
<dd>
Create a new object adapter.</dd>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapterWithEndpoints">createObjectAdapterWithEndpoints</a></dt>
<dd>
Create a new object adapter with endpoints.</dd>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapterWithRouter">createObjectAdapterWithRouter</a></dt>
<dd>
Create a new object adapter with a router.</dd>
<dt class="Symbol"><a class="Symbol" href="#addObjectFactory">addObjectFactory</a></dt>
<dd>
Add a servant factory to this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#findObjectFactory">findObjectFactory</a></dt>
<dd>
Find a servant factory registered with this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getImplicitContext">getImplicitContext</a></dt>
<dd>
Get the implicit context associated with this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getProperties">getProperties</a></dt>
<dd>
Get the properties for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getLogger">getLogger</a></dt>
<dd>
Get the logger for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getStats">getStats</a></dt>
<dd>
Get the statistics callback object for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getDefaultRouter">getDefaultRouter</a></dt>
<dd>
Get the default router this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#setDefaultRouter">setDefaultRouter</a></dt>
<dd>
Set a default router for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getDefaultLocator">getDefaultLocator</a></dt>
<dd>
Get the default locator this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#setDefaultLocator">setDefaultLocator</a></dt>
<dd>
Set a default Ice locator for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getPluginManager">getPluginManager</a></dt>
<dd>
Get the plug-in manager for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#flushBatchRequests">flushBatchRequests</a></dt>
<dd>
Flush any pending batch requests for this communicator.</dd>
<dt class="Symbol"><a class="Symbol" href="#getAdmin">getAdmin</a></dt>
<dd>
Get a proxy to the main facet of the Admin object.</dd>
<dt class="Symbol"><a class="Symbol" href="#addAdminFacet">addAdminFacet</a></dt>
<dd>
Add a new facet to the Admin object.</dd>
<dt class="Symbol"><a class="Symbol" href="#removeAdminFacet">removeAdminFacet</a></dt>
<dd>
Remove the following facet to the Admin object.</dd>
</dl>
<h2>Operations</h2>
<h3 class="Synopsis">void <a class="Symbol" name="destroy">destroy</a>()</h3>
<p>
Destroy the communicator. This operation calls <a class="Symbol" href="#shutdown">shutdown</a>
implicitly. Calling <a class="Symbol" href="#destroy">destroy</a> cleans up memory, and shuts down
this communicator's client functionality and destroys all object
adapters. Subsequent calls to <a class="Symbol" href="#destroy">destroy</a> are ignored.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#shutdown">shutdown</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html#destroy">ObjectAdapter::destroy</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="shutdown">shutdown</a>()</h3>
<p>
Shuts down this communicator's server functionality, which
includes the deactivation of all object adapters. (Attempts to use
a deactivated object adapter raise <a class="Symbol" href="ObjectAdapterDeactivatedException.html">ObjectAdapterDeactivatedException</a>.)
Subsequent calls to <a class="Symbol" href="#shutdown">shutdown</a> are ignored.</p>
<p class="Note"> After <a class="Symbol" href="#shutdown">shutdown</a> returns, no new requests are
processed. However, requests that have been started before
<a class="Symbol" href="#shutdown">shutdown</a> was called might still be active. You can use
<a class="Symbol" href="#waitForShutdown">waitForShutdown</a> to wait for the completion of all
requests.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#destroy">destroy</a></dt>
<dt class="Symbol"><a class="Symbol" href="#waitForShutdown">waitForShutdown</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html#deactivate">ObjectAdapter::deactivate</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="waitForShutdown">waitForShutdown</a>()</h3>
<p>
Wait until the application has called <a class="Symbol" href="#shutdown">shutdown</a> (or <a class="Symbol" href="#destroy">destroy</a>).
On the server side, this operation blocks the calling thread
until all currently-executing operations have completed.
On the client side, the operation simply block until another
thread has called <a class="Symbol" href="#shutdown">shutdown</a> or <a class="Symbol" href="#destroy">destroy</a>.
<p>A typical use of this operation is to call it
from the main thread, which then waits until some other thread
calls <a class="Symbol" href="#shutdown">shutdown</a>. After shut-down is complete, the main thread
returns and can do some cleanup work before it finally calls
<a class="Symbol" href="#destroy">destroy</a> to shut down the client functionality, and then
exits the application.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#shutdown">shutdown</a></dt>
<dt class="Symbol"><a class="Symbol" href="#destroy">destroy</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html#waitForDeactivate">ObjectAdapter::waitForDeactivate</a></dt>
</dl>
<h3 class="Synopsis">bool <a class="Symbol" name="isShutdown">isShutdown</a>()</h3>
<p>
Check whether communicator has been shut down.</p>
<h4>Return Value</h4>
<p>True if the communicator has been shut down; false otherwise.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#shutdown">shutdown</a></dt>
</dl>
<h3 class="Synopsis">Object* <a class="Symbol" name="stringToProxy">stringToProxy</a>(string str)</h3>
<p>
Convert a stringified proxy into a proxy. For example,
<tt>MyCategory/MyObject:tcp -h some_host -p
10000</tt> creates a proxy that refers to the Ice object
having an identity with a name "MyObject" and a category
"MyCategory", with the server running on host "some_host", port
10000. If the stringified proxy does not parse correctly, the
operation throws one of <a class="Symbol" href="ProxyParseException.html">ProxyParseException</a>,
<a class="Symbol" href="EndpointParseException.html">EndpointParseException</a>, or <a class="Symbol" href="IdentityParseException.html">IdentityParseException</a>.
An appendix in the Ice manual provides a detailed description
of the syntax supported by stringified proxies.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">str</dt>
<dd>
The stringified proxy to convert into a proxy.</dd>
</dl>
<h4>Return Value</h4>
<p>The proxy, or nil if <tt>str</tt> is an empty string.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#proxyToString">proxyToString</a></dt>
</dl>
<h3 class="Synopsis">string <a class="Symbol" name="proxyToString">proxyToString</a>(Object* obj)</h3>
<p>
Convert a proxy into a string.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">obj</dt>
<dd>
The proxy to convert into a stringified proxy.</dd>
</dl>
<h4>Return Value</h4>
<p>The stringified proxy, or an empty string if
<tt>obj</tt> is nil.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#stringToProxy">stringToProxy</a></dt>
</dl>
<h3 class="Synopsis">Object* <a class="Symbol" name="propertyToProxy">propertyToProxy</a>(string property)</h3>
<p>
Convert a set of proxy properties into a proxy. The "base"
name supplied in the <tt>property</tt> argument refers to a
property containing a stringified proxy, such as
<tt>MyProxy=id:tcp -h localhost -p 10000</tt>. Additional
properties configure local settings for the proxy, such as
<tt>MyProxy.PreferSecure=1</tt>. The "Properties"
appendix in the Ice manual describes each of the supported
proxy properties.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">property</dt>
<dd>
The base property name.</dd>
</dl>
<h4>Return Value</h4>
<p>The proxy.</p>
<h3 class="Synopsis"><a class="Symbol" href="../Ice.html#PropertyDict">PropertyDict</a> <a class="Symbol" name="proxyToProperty">proxyToProperty</a>(Object* proxy, string property)</h3>
<p>
Convert a proxy to a set of proxy properties.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">proxy</dt>
<dd>
The proxy.</dd>
<dt class="Symbol">property</dt>
<dd>
The base property name.</dd>
</dl>
<h4>Return Value</h4>
<p>The property set.</p>
<h3 class="Synopsis"><a class="Symbol" href="Identity.html">Identity</a> <a class="Symbol" name="stringToIdentity">stringToIdentity</a>(string str)</h3>
<p>
Convert a string into an identity. If the string does not parse
correctly, the operation throws <a class="Symbol" href="IdentityParseException.html">IdentityParseException</a>.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">str</dt>
<dd>
The string to convert into an identity.</dd>
</dl>
<h4>Return Value</h4>
<p>The identity.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#identityToString">identityToString</a></dt>
</dl>
<h3 class="Synopsis">string <a class="Symbol" name="identityToString">identityToString</a>(<a class="Symbol" href="Identity.html">Identity</a> ident)</h3>
<p>
Convert an identity into a string.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">ident</dt>
<dd>
The identity to convert into a string.</dd>
</dl>
<h4>Return Value</h4>
<p>The "stringified" identity.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#stringToIdentity">stringToIdentity</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a> <a class="Symbol" name="createObjectAdapter">createObjectAdapter</a>(string name)</h3>
<p>
Create a new object adapter. The endpoints for the object
adapter are taken from the property <tt><em>name</em>.Endpoints</tt>.</p>
<p>It is legal to create an object adapter with the empty string as
its name. Such an object adapter is accessible via bidirectional
connections or by collocated invocations that originate from the
same communicator as is used by the adapter.</p>
<p>Attempts to create a named object adapter for which no configuration
can be found raise <a class="Symbol" href="InitializationException.html">InitializationException</a>.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">name</dt>
<dd>
The object adapter name.</dd>
</dl>
<h4>Return Value</h4>
<p>The new object adapter.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapterWithEndpoints">createObjectAdapterWithEndpoints</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a></dt>
<dt class="Symbol"><a class="Symbol" href="Properties.html">Properties</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a> <a class="Symbol" name="createObjectAdapterWithEndpoints">createObjectAdapterWithEndpoints</a>(string name, string endpoints)</h3>
<p>
Create a new object adapter with endpoints. This operation sets
the property <tt><em>name</em>.Endpoints</tt>,
and then calls <a class="Symbol" href="#createObjectAdapter">createObjectAdapter</a>. It is provided as a
convenience function.</p>
<p>Calling this operation with an empty name will result in a
UUID being generated for the name.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">name</dt>
<dd>
The object adapter name.</dd>
<dt class="Symbol">endpoints</dt>
<dd>
The endpoints for the object adapter.</dd>
</dl>
<h4>Return Value</h4>
<p>The new object adapter.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapter">createObjectAdapter</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a></dt>
<dt class="Symbol"><a class="Symbol" href="Properties.html">Properties</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a> <a class="Symbol" name="createObjectAdapterWithRouter">createObjectAdapterWithRouter</a>(string name, <a class="Symbol" href="Router.html">Router</a>* rtr)</h3>
<p>
Create a new object adapter with a router. This operation
creates a routed object adapter.</p>
<p>Calling this operation with an empty name will result in a
UUID being generated for the name.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">name</dt>
<dd>
The object adapter name.</dd>
<dt class="Symbol">rtr</dt>
<dd>
The router.</dd>
</dl>
<h4>Return Value</h4>
<p>The new object adapter.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapter">createObjectAdapter</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html">ObjectAdapter</a></dt>
<dt class="Symbol"><a class="Symbol" href="Properties.html">Properties</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="addObjectFactory">addObjectFactory</a>(<a class="Symbol" href="ObjectFactory.html">ObjectFactory</a> factory, string id)</h3>
<p>
Add a servant factory to this communicator. Installing a
factory with an id for which a factory is already registered
throws <a class="Symbol" href="AlreadyRegisteredException.html">AlreadyRegisteredException</a>.</p>
<p>When unmarshaling an Ice object, the Ice run-time reads the
most-derived type id off the wire and attempts to create an
instance of the type using a factory. If no instance is created,
either because no factory was found, or because all factories
returned nil, the object is sliced to the next most-derived type
and the process repeats. If no factory is found that can create an
instance, the Ice run-time throws <a class="Symbol" href="NoObjectFactoryException.html">NoObjectFactoryException</a>.</p>
<p>The following order is used to locate a factory for a type:</p>
<ol>
<li>The Ice run-time looks for a factory registered
specifically for the type.</li>
<li>If no instance has been created, the Ice run-time looks
for the default factory, which is registered with an empty type id.
</li>
<li>If no instance has been created by any of the preceding
steps, the Ice run-time looks for a factory that may have been
statically generated by the language mapping for non-abstract classes.
</li>
</ol>
<p></p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">factory</dt>
<dd>
The factory to add.</dd>
<dt class="Symbol">id</dt>
<dd>
The type id for which the factory can create instances, or
an empty string for the default factory.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#findObjectFactory">findObjectFactory</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectFactory.html">ObjectFactory</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="ObjectFactory.html">ObjectFactory</a> <a class="Symbol" name="findObjectFactory">findObjectFactory</a>(string id)</h3>
<p>
Find a servant factory registered with this communicator.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">id</dt>
<dd>
The type id for which the factory can create instances,
or an empty string for the default factory.</dd>
</dl>
<h4>Return Value</h4>
<p>The servant factory, or null if no servant factory was
found for the given id.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#addObjectFactory">addObjectFactory</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectFactory.html">ObjectFactory</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="ImplicitContext.html">ImplicitContext</a> <a class="Symbol" name="getImplicitContext">getImplicitContext</a>()</h3>
<p>
Get the implicit context associated with this communicator.</p>
<h4>Return Value</h4>
<p>The implicit context associated with this communicator;
returns null when the property Ice.ImplicitContext is not set
or is set to None.</p>
<h3 class="Synopsis"><a class="Symbol" href="Properties.html">Properties</a> <a class="Symbol" name="getProperties">getProperties</a>()</h3>
<p>
Get the properties for this communicator.</p>
<h4>Return Value</h4>
<p>This communicator's properties.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Properties.html">Properties</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="Logger.html">Logger</a> <a class="Symbol" name="getLogger">getLogger</a>()</h3>
<p>
Get the logger for this communicator.</p>
<h4>Return Value</h4>
<p>This communicator's logger.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Logger.html">Logger</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="Stats.html">Stats</a> <a class="Symbol" name="getStats">getStats</a>()</h3>
<p>
Get the statistics callback object for this communicator.</p>
<h4>Return Value</h4>
<p>This communicator's statistics callback object.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="Stats.html">Stats</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="Router.html">Router</a>* <a class="Symbol" name="getDefaultRouter">getDefaultRouter</a>()</h3>
<p>
Get the default router this communicator.</p>
<h4>Return Value</h4>
<p>The default router for this communicator.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setDefaultRouter">setDefaultRouter</a></dt>
<dt class="Symbol"><a class="Symbol" href="Router.html">Router</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="setDefaultRouter">setDefaultRouter</a>(<a class="Symbol" href="Router.html">Router</a>* rtr)</h3>
<p>
Set a default router for this communicator. All newly
created proxies will use this default router. To disable the
default router, null can be used. Note that this
operation has no effect on existing proxies.</p>
<p class="Note">You can also set a router for an individual proxy
by calling the operation <tt>ice_router</tt> on the proxy.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">rtr</dt>
<dd>
The default router to use for this communicator.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#getDefaultRouter">getDefaultRouter</a></dt>
<dt class="Symbol"><a class="Symbol" href="#createObjectAdapterWithRouter">createObjectAdapterWithRouter</a></dt>
<dt class="Symbol"><a class="Symbol" href="Router.html">Router</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="Locator.html">Locator</a>* <a class="Symbol" name="getDefaultLocator">getDefaultLocator</a>()</h3>
<p>
Get the default locator this communicator.</p>
<h4>Return Value</h4>
<p>The default locator for this communicator.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#setDefaultLocator">setDefaultLocator</a></dt>
<dt class="Symbol"><a class="Symbol" href="Locator.html">Locator</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="setDefaultLocator">setDefaultLocator</a>(<a class="Symbol" href="Locator.html">Locator</a>* loc)</h3>
<p>
Set a default Ice locator for this communicator. All newly
created proxy and object adapters will use this default
locator. To disable the default locator, null can be used.
Note that this operation has no effect on existing proxies or
object adapters.</p>
<p class="Note"> You can also set a locator for an individual proxy
by calling the operation <tt>ice_locator</tt> on the proxy, or for an
object adapter by calling the operation <tt>setLocator</tt> on the
object adapter.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">loc</dt>
<dd>
The default locator to use for this communicator.</dd>
</dl>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="#getDefaultLocator">getDefaultLocator</a></dt>
<dt class="Symbol"><a class="Symbol" href="Locator.html">Locator</a></dt>
<dt class="Symbol"><a class="Symbol" href="ObjectAdapter.html#setLocator">ObjectAdapter::setLocator</a></dt>
</dl>
<h3 class="Synopsis"><a class="Symbol" href="PluginManager.html">PluginManager</a> <a class="Symbol" name="getPluginManager">getPluginManager</a>()</h3>
<p>
Get the plug-in manager for this communicator.</p>
<h4>Return Value</h4>
<p>This communicator's plug-in manager.</p>
<h4>See Also</h4>
<dl>
<dt class="Symbol"><a class="Symbol" href="PluginManager.html">PluginManager</a></dt>
</dl>
<h3 class="Synopsis">void <a class="Symbol" name="flushBatchRequests">flushBatchRequests</a>()</h3>
<p>
Flush any pending batch requests for this communicator.
This causes all batch requests that were sent via proxies
obtained via this communicator to be sent to the server.</p>
<h3 class="Synopsis">Object* <a class="Symbol" name="getAdmin">getAdmin</a>()</h3>
<p>
Get a proxy to the main facet of the Admin object. When Ice.Admin.DelayCreation
is greater than 0, it is necessary to call getAdmin() after the communicator is
initialized to create the Admin object. Otherwise, the Admin object is created
automatically after all the plug-ins are initialized.</p>
<h4>Return Value</h4>
<p>The main ("") facet of the Admin object; a null proxy if no
Admin object is configured.</p>
<h3 class="Synopsis">void <a class="Symbol" name="addAdminFacet">addAdminFacet</a>(Object servant, string facet)</h3>
<p>
Add a new facet to the Admin object.
Adding a servant with a facet that is already registered
throws <a class="Symbol" href="AlreadyRegisteredException.html">AlreadyRegisteredException</a>.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">servant</dt>
<dd>
The servant that implements the new Admin facet.</dd>
<dt class="Symbol">facet</dt>
<dd>
The new Admin facet.</dd>
</dl>
<h3 class="Synopsis">Object <a class="Symbol" name="removeAdminFacet">removeAdminFacet</a>(string facet)</h3>
<p>
Remove the following facet to the Admin object.
Removing a facet that was not previously registered throws
<a class="Symbol" href="NotRegisteredException.html">NotRegisteredException</a>.</p>
<h4>Parameters</h4>
<dl>
<dt class="Symbol">facet</dt>
<dd>
The Admin facet.</dd>
</dl>
<h4>Return Value</h4>
<p>The servant associated with this Admin facet</p>
<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="CollocationOptimizationException.html"><img class="Button" src="../images/prev.gif" alt="Previous"></a></td>
<td><a href="../Ice.html"><img class="Button" src="../images/up.gif" alt="Up"></a></td>
<td><a href="CommunicatorDestroyedException.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>
|