/usr/share/Ice-3.5.1/slice/Ice/ObjectAdapter.ice is in ice35-slice 3.5.1-5.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 | // **********************************************************************
//
// Copyright (c) 2003-2013 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
#pragma once
[["cpp:header-ext:h"]]
#include <Ice/CommunicatorF.ice>
#include <Ice/ServantLocatorF.ice>
#include <Ice/LocatorF.ice>
#include <Ice/Identity.ice>
#include <Ice/FacetMap.ice>
#include <Ice/Endpoint.ice>
module Ice
{
/**
*
* The object adapter provides an up-call interface from the Ice
* run time to the implementation of Ice objects.
*
* The object adapter is responsible for receiving requests
* from endpoints, and for mapping between servants, identities, and
* proxies.
*
* @see Communicator
* @see ServantLocator
*
**/
local interface ObjectAdapter
{
/**
*
* Get the name of this object adapter.
*
* @return This object adapter's name.
*
**/
["cpp:const"] string getName();
/**
*
* Get the communicator this object adapter belongs to.
*
* @return This object adapter's communicator.
*
* @see Communicator
*
**/
["cpp:const"] Communicator getCommunicator();
/**
*
* Activate all endpoints that belong to this object adapter.
* After activation, the object adapter can dispatch requests
* received through its endpoints.
*
* @see #hold
* @see #deactivate
*
**/
void activate();
/**
*
* Temporarily hold receiving and dispatching requests. The object
* adapter can be reactivated with the {@link #activate} operation.
*
* <p class="Note"> Holding is not immediate, i.e., after {@link #hold}
* returns, the object adapter might still be active for some
* time. You can use {@link #waitForHold} to wait until holding is
* complete.
*
* @see #activate
* @see #deactivate
* @see #waitForHold
*
**/
void hold();
/**
*
* Wait until the object adapter holds requests. Calling {@link #hold}
* initiates holding of requests, and {@link #waitForHold} only returns
* when holding of requests has been completed.
*
* @see #hold
* @see #waitForDeactivate
* @see Communicator#waitForShutdown
*
**/
void waitForHold();
/**
*
* Deactivate all endpoints that belong to this object adapter.
* After deactivation, the object adapter stops receiving
* requests through its endpoints. Object adapters that have been
* deactivated must not be reactivated again, and cannot be used
* otherwise. Attempts to use a deactivated object adapter raise
* {@link ObjectAdapterDeactivatedException}; however, attempts to
* {@link #deactivate} an already deactivated object adapter are
* ignored and do nothing. Once deactivated, it is possible to
* destroy the adapter to clean up resources and then create and
* activate a new adapter with the same name.
*
* <p class="Note"> After {@link #deactivate} returns, no new requests
* are processed by the object adapter. However, requests that
* have been started before {@link #deactivate} was called might
* still be active. You can use {@link #waitForDeactivate} to wait
* for the completion of all requests for this object adapter.
*
* @see #activate
* @see #hold
* @see #waitForDeactivate
* @see Communicator#shutdown
*
**/
void deactivate();
/**
*
* Wait until the object adapter has deactivated. Calling
* {@link #deactivate} initiates object adapter deactivation, and
* {@link #waitForDeactivate} only returns when deactivation has
* been completed.
*
* @see #deactivate
* @see #waitForHold
* @see Communicator#waitForShutdown
*
**/
void waitForDeactivate();
/**
*
* Check whether object adapter has been deactivated.
*
* @return Whether adapter has been deactivated.
*
* @see Communicator#shutdown
*
**/
["cpp:const"] bool isDeactivated();
/**
*
* Destroys the object adapter and cleans up all resources held by
* the object adapter. If the object adapter has not yet been
* deactivated, {@link #destroy} implicitly initiates the deactivation
* and waits for it to finish. Subsequent calls to {@link destroy} are
* ignored. Once {@link destroy} has returned, it is possible to create
* another object adapter with the same name.
*
* @see #deactivate
* @see #waitForDeactivate
* @see Communicator#destroy
*
**/
void destroy();
/**
*
* Add a servant to this object adapter's Active Servant Map. Note
* that one servant can implement several Ice objects by registering
* the servant with multiple identities. Adding a servant with an
* identity that is in the map already throws {@link AlreadyRegisteredException}.
*
* @param servant The servant to add.
*
* @param id The identity of the Ice object that is implemented by
* the servant.
*
* @return A proxy that matches the given identity and this object
* adapter.
*
* @see Identity
* @see #addFacet
* @see #addWithUUID
* @see #remove
* @see #find
*
**/
Object* add(Object servant, Identity id);
/**
*
* Like {@link #add}, but with a facet. Calling <tt>add(servant, id)</tt>
* is equivalent to calling {@link #addFacet} with an empty facet.
*
* @param servant The servant to add.
*
* @param id The identity of the Ice object that is implemented by
* the servant.
*
* @param facet The facet. An empty facet means the default facet.
*
* @return A proxy that matches the given identity, facet, and
* this object adapter.
*
* @see Identity
* @see #add
* @see #addFacetWithUUID
* @see #removeFacet
* @see #findFacet
*
**/
Object* addFacet(Object servant, Identity id, string facet);
/**
*
* Add a servant to this object adapter's Active Servant Map,
* using an automatically generated UUID as its identity. Note that
* the generated UUID identity can be accessed using the proxy's
* <tt>ice_getIdentity</tt> operation.
*
* @param servant The servant to add.
*
* @return A proxy that matches the generated UUID identity and
* this object adapter.
*
* @see Identity
* @see #add
* @see #addFacetWithUUID
* @see #remove
* @see #find
*
**/
Object* addWithUUID(Object servant);
/**
*
* Like {@link #addWithUUID}, but with a facet. Calling
* <tt>addWithUUID(servant)</tt> is equivalent to calling
* {@link #addFacetWithUUID} with an empty facet.
*
* @param servant The servant to add.
*
* @param facet The facet. An empty facet means the default
* facet.
*
* @return A proxy that matches the generated UUID identity,
* facet, and this object adapter.
*
* @see Identity
* @see #addFacet
* @see #addWithUUID
* @see #removeFacet
* @see #findFacet
*
**/
Object* addFacetWithUUID(Object servant, string facet);
/**
*
* Add a default servant to handle requests for a specific
* category. Adding a default servant for a category for
* which a default servant is already registered throws
* {@link AlreadyRegisteredException}. To dispatch operation
* calls on servants, the object adapter tries to find a servant
* for a given Ice object identity and facet in the following
* order:
*
* <ol>
*
* <li>The object adapter tries to find a servant for the identity
* and facet in the Active Servant Map.</li>
*
* <li>If no servant has been found in the Active Servant Map, the
* object adapter tries to find a default servant for the category
* component of the identity.</li>
*
* <li>If no servant has been found by any of the preceding steps,
* the object adapter tries to find a default servant for an empty
* category, regardless of the category contained in the identity.</li>
*
* <li>If no servant has been found by any of the preceding steps,
* the object adapter gives up and the caller receives
* {@link ObjectNotExistException} or {@link FacetNotExistException}.</li>
*
* </ol>
*
* @param servant The default servant.
*
* @param category The category for which the default servant is
* registered. An empty category means it will handle all categories.
*
* @see #removeDefaultServant
* @see #findDefaultServant
*
**/
void addDefaultServant(Object servant, string category);
/**
*
* Remove a servant (that is, the default facet) from the object
* adapter's Active Servant Map.
*
* @param id The identity of the Ice object that is implemented by
* the servant. If the servant implements multiple Ice objects,
* {@link #remove} has to be called for all those Ice objects.
* Removing an identity that is not in the map throws
* {@link NotRegisteredException}.
*
* @return The removed servant.
*
* @see Identity
* @see #add
* @see #addWithUUID
*
**/
Object remove(Identity id);
/**
*
* Like {@link #remove}, but with a facet. Calling <tt>remove(id)</tt>
* is equivalent to calling {@link #removeFacet} with an empty facet.
*
* @param id The identity of the Ice object that is implemented by
* the servant.
*
* @param facet The facet. An empty facet means the default facet.
*
* @return The removed servant.
*
* @see Identity
* @see #addFacet
* @see #addFacetWithUUID
*
**/
Object removeFacet(Identity id, string facet);
/**
*
* Remove all facets with the given identity from the Active
* Servant Map. The operation completely removes the Ice object,
* including its default facet. Removing an identity that
* is not in the map throws {@link NotRegisteredException}.
*
* @param id The identity of the Ice object to be removed.
*
* @return A collection containing all the facet names and
* servants of the removed Ice object.
*
* @see #remove
* @see #removeFacet
*
**/
FacetMap removeAllFacets(Identity id);
/**
*
* Remove the default servant for a specific category. Attempting
* to remove a default servant for a category that is not
* registered throws {@link NotRegisteredException}.
*
* @param category The category of the default servant to remove.
*
* @return The default servant.
*
* @see #addDefaultServant
* @see #findDefaultServant
*
**/
Object removeDefaultServant(string category);
/**
*
* Look up a servant in this object adapter's Active Servant Map
* by the identity of the Ice object it implements.
*
* <p class="Note">This operation only tries to look up a servant in
* the Active Servant Map. It does not attempt to find a servant
* by using any installed {@link ServantLocator}.
*
* @param id The identity of the Ice object for which the servant
* should be returned.
*
* @return The servant that implements the Ice object with the
* given identity, or null if no such servant has been found.
*
* @see Identity
* @see #findFacet
* @see #findByProxy
*
**/
["cpp:const"] Object find(Identity id);
/**
*
* Like {@link #find}, but with a facet. Calling <tt>find(id)</tt>
* is equivalent to calling {@link #findFacet} with an empty
* facet.
*
* @param id The identity of the Ice object for which the
* servant should be returned.
*
* @param facet The facet. An empty facet means the default
* facet.
*
* @return The servant that implements the Ice object with the
* given identity and facet, or null if no such servant has been
* found.
*
* @see Identity
* @see #find
* @see #findByProxy
*
**/
["cpp:const"] Object findFacet(Identity id, string facet);
/**
*
* Find all facets with the given identity in the Active Servant
* Map.
*
* @param id The identity of the Ice object for which the facets
* should be returned.
*
* @return A collection containing all the facet names and
* servants that have been found, or an empty map if there is no
* facet for the given identity.
*
* @see #find
* @see #findFacet
*
**/
["cpp:const"] FacetMap findAllFacets(Identity id);
/**
*
* Look up a servant in this object adapter's Active Servant Map,
* given a proxy.
*
* <p class="Note">This operation only tries to lookup a servant in
* the Active Servant Map. It does not attempt to find a servant
* by using any installed {@link ServantLocator}.
*
* @param proxy The proxy for which the servant should be returned.
*
* @return The servant that matches the proxy, or null if no such
* servant has been found.
*
* @see #find
* @see #findFacet
*
**/
["cpp:const"] Object findByProxy(Object* proxy);
/**
*
* Add a Servant Locator to this object adapter. Adding a servant
* locator for a category for which a servant locator is already
* registered throws {@link AlreadyRegisteredException}. To dispatch
* operation calls on servants, the object adapter tries to find a
* servant for a given Ice object identity and facet in the
* following order:
*
* <ol>
*
* <li>The object adapter tries to find a servant for the identity
* and facet in the Active Servant Map.</li>
*
* <li>If no servant has been found in the Active Servant Map,
* the object adapter tries to find a servant locator for the
* category component of the identity. If a locator is found, the
* object adapter tries to find a servant using this locator.</li>
*
* <li>If no servant has been found by any of the preceding steps,
* the object adapter tries to find a locator for an empty category,
* regardless of the category contained in the identity. If a
* locator is found, the object adapter tries to find a servant
* using this locator.</li>
*
* <li>If no servant has been found by any of the preceding steps,
* the object adapter gives up and the caller receives
* {@link ObjectNotExistException} or {@link FacetNotExistException}.</li>
*
* </ol>
*
* <p class="Note">Only one locator for the empty category can be
* installed.
*
* @param locator The locator to add.
*
* @param category The category for which the Servant Locator can
* locate servants, or an empty string if the Servant Locator does
* not belong to any specific category.
*
* @see Identity
* @see #removeServantLocator
* @see #findServantLocator
* @see ServantLocator
*
**/
void addServantLocator(ServantLocator locator, string category);
/**
*
* Remove a Servant Locator from this object adapter.
*
* @param category The category for which the Servant Locator can
* locate servants, or an empty string if the Servant Locator does
* not belong to any specific category.
*
* @return The Servant Locator, or throws {@link NotRegisteredException}
* if no Servant Locator was found for the given category.
*
* @see Identity
* @see #addServantLocator
* @see #findServantLocator
* @see ServantLocator
*
**/
ServantLocator removeServantLocator(string category);
/**
*
* Find a Servant Locator installed with this object adapter.
*
* @param category The category for which the Servant Locator can
* locate servants, or an empty string if the Servant Locator does
* not belong to any specific category.
*
* @return The Servant Locator, or null if no Servant Locator was
* found for the given category.
*
* @see Identity
* @see #addServantLocator
* @see #removeServantLocator
* @see ServantLocator
*
**/
["cpp:const"] ServantLocator findServantLocator(string category);
/**
*
* Find the default servant for a specific category.
*
* @param category The category of the default servant to find.
*
* @return The default servant or null if no default servant was
* registered for the category.
*
* @see #addDefaultServant
* @see #removeDefaultServant
*
**/
["cpp:const"] Object findDefaultServant(string category);
/**
*
* Create a proxy for the object with the given identity. If this
* object adapter is configured with an adapter id, the return
* value is an indirect proxy that refers to the adapter id. If
* a replica group id is also defined, the return value is an
* indirect proxy that refers to the replica group id. Otherwise,
* if no adapter id is defined, the return value is a direct
* proxy containing this object adapter's published endpoints.
*
* @param id The object's identity.
*
* @return A proxy for the object with the given identity.
*
* @see Identity
*
**/
["cpp:const"] Object* createProxy(Identity id);
/**
*
* Create a direct proxy for the object with the given identity.
* The returned proxy contains this object adapter's published
* endpoints.
*
* @param id The object's identity.
*
* @return A proxy for the object with the given identity.
*
* @see Identity
*
**/
["cpp:const"] Object* createDirectProxy(Identity id);
/**
*
* Create an indirect proxy for the object with the given identity.
* If this object adapter is configured with an adapter id, the
* return value refers to the adapter id. Otherwise, the return
* value contains only the object identity.
*
* @param id The object's identity.
*
* @return A proxy for the object with the given identity.
*
* @see Identity
*
**/
["cpp:const"] Object* createIndirectProxy(Identity id);
/**
* Set an Ice locator for this object adapter. By doing so, the
* object adapter will register itself with the locator registry
* when it is activated for the first time. Furthermore, the proxies
* created by this object adapter will contain the adapter name
* instead of its endpoints.
*
* @param loc The locator used by this object adapter.
*
* @see #createDirectProxy
* @see Locator
* @see LocatorRegistry
*
**/
void setLocator(Locator* loc);
/**
* Refresh the set of published endpoints. The run time re-reads
* the PublishedEndpoints property if it is set and re-reads the
* list of local interfaces if the adapter is configured to listen
* on all endpoints. This operation is useful to refresh the endpoint
* information that is published in the proxies that are created by
* an object adapter if the network interfaces used by a host changes.
*
**/
void refreshPublishedEndpoints();
/**
*
* Get the set of endpoints configured with this object adapter.
*
* @return The set of endpoints.
*
* @see Endpoint
*
**/
["cpp:const"] EndpointSeq getEndpoints();
/**
*
* Get the set of endpoints that proxies created by this object
* adapter will contain.
*
* @return The set of published endpoints.
*
* @see #refreshPublishedEndpoints
* @see Endpoint
*
**/
["cpp:const"] EndpointSeq getPublishedEndpoints();
};
};
|