Ice 3.7 Slice API Reference
Locator.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICE_API"]]
8 [["cpp:doxygen:include:Ice/Ice.h"]]
9 [["cpp:header-ext:h"]]
10 
11 [["ice-prefix"]]
12 
13 [["js:module:ice"]]
14 [["js:cjs-module"]]
15 
16 [["objc:dll-export:ICE_API"]]
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:Ice"]]
20 
21 #include <Ice/Identity.ice>
22 #include <Ice/Process.ice>
23 
24 #ifndef __SLICE2JAVA_COMPAT__
25 [["java:package:com.zeroc"]]
26 #endif
27 
28 ["objc:prefix:ICE"]
29 module Ice
30 {
31 
38 {
39 }
40 
48 {
49 }
50 
58 {
59 }
60 
67 {
68 }
69 
76 {
77 }
78 
79 interface LocatorRegistry;
80 
93 interface Locator
94 {
109  ["amd", "nonmutating", "cpp:const"] idempotent Object* findObjectById(Identity id)
111 
125  ["amd", "nonmutating", "cpp:const"] idempotent Object* findAdapterById(string id)
127 
135  ["nonmutating", "cpp:const"] idempotent LocatorRegistry* getRegistry();
136 }
137 
150 {
170  ["amd"] idempotent void setAdapterDirectProxy(string id, Object* proxy)
172 
198  ["amd"] idempotent void setReplicatedAdapterDirectProxy(string adapterId, string replicaGroupId, Object* p)
200 
213  ["amd"] idempotent void setServerProcessProxy(string id, Process* proxy)
215 }
216 
226 interface LocatorFinder
227 {
237 }
238 
239 }
Ice::Locator::findObjectById
idempotent Object * findObjectById(Identity id)
Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be ...
Ice::Locator::getRegistry
idempotent LocatorRegistry * getRegistry()
Get the locator registry.
Ice::InvalidReplicaGroupIdException
This exception is raised if the replica group provided by the server is invalid.
Definition: Locator.ice:48
Process.ice
Ice::ServerNotFoundException
This exception is raised if a server cannot be found.
Definition: Locator.ice:76
Ice::LocatorRegistry::setReplicatedAdapterDirectProxy
idempotent void setReplicatedAdapterDirectProxy(string adapterId, string replicaGroupId, Object *p)
Set the adapter endpoints with the locator registry.
Ice::LocatorRegistry::setServerProcessProxy
idempotent void setServerProcessProxy(string id, Process *proxy)
Set the process proxy for a server.
Ice::ObjectNotFoundException
This exception is raised if an object cannot be found.
Definition: Locator.ice:67
Ice::AdapterNotFoundException
This exception is raised if an adapter cannot be found.
Definition: Locator.ice:38
Ice::LocatorRegistry
The Ice locator registry interface.
Definition: Locator.ice:150
Ice
The Ice core library.
Definition: BuiltinSequences.ice:27
Identity.ice
Ice::Process
An administrative interface for process management.
Definition: Process.ice:42
Ice::LocatorRegistry::setAdapterDirectProxy
idempotent void setAdapterDirectProxy(string id, Object *proxy)
Set the adapter endpoints with the locator registry.
Ice::Locator
The Ice locator interface.
Definition: Locator.ice:94
Ice::AdapterAlreadyActiveException
This exception is raised if a server tries to set endpoints for an adapter that is already active.
Definition: Locator.ice:58
Ice::Identity
The identity of an Ice object.
Definition: Identity.ice:40
Ice::LocatorFinder
This inferface should be implemented by services implementing the Ice::Locator interface.
Definition: Locator.ice:227
Ice::Locator::findAdapterById
idempotent Object * findAdapterById(string id)
Find an adapter by id and return a proxy that contains its endpoints.
Ice::LocatorFinder::getLocator
Locator * getLocator()
Get the locator proxy implemented by the process hosting this finder object.