The Ice locator interface. More...
defined in <Ice/Locator.ice>
interface Locator { ... }
Inheritance diagram for Ice::Locator:
Operations | |
| idempotent Object * | findAdapterById (string id) throws AdapterNotFoundException |
| Find an adapter by id and return a proxy that contains its endpoints. More... | |
| idempotent Object * | findObjectById (Identity id) throws ObjectNotFoundException |
| Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object. More... | |
| idempotent LocatorRegistry * | getRegistry () |
| Get the locator registry. More... | |
Detailed Description
The Ice locator interface.
This interface is used by clients to lookup adapters and objects. It is also used by servers to get the locator registry proxy.
The Locator interface is intended to be used by Ice internals and by locator implementations. Regular user code should not attempt to use any functionality of this interface directly.
Operation Documentation
◆ findAdapterById()
["amd","nonmutating","cpp:const"]
| idempotent Object* findAdapterById | ( | string | id | ) | throws AdapterNotFoundException |
Find an adapter by id and return a proxy that contains its endpoints.
- Parameters
-
id The adapter id.
- Returns
- The adapter proxy, or null if the adapter is not active.
- Exceptions
-
AdapterNotFoundException Raised if the adapter cannot be found.
◆ findObjectById()
["amd","nonmutating","cpp:const"]
| idempotent Object* findObjectById | ( | Identity | id | ) | throws ObjectNotFoundException |
Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object.
- Parameters
-
id The identity.
- Returns
- The proxy, or null if the object is not active.
- Exceptions
-
ObjectNotFoundException Raised if the object cannot be found.
◆ getRegistry()
["nonmutating","cpp:const"]
| idempotent LocatorRegistry* getRegistry | ( | ) |
Get the locator registry.
- Returns
- The locator registry.
The documentation for this interface was generated from the following file:
- Ice/Locator.ice
