Ice 3.7 Slice API Reference
Loading...
Searching...
No Matches
Registry.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:ICEGRID_API"]]
8[["cpp:doxygen:include:IceGrid/IceGrid.h"]]
9[["cpp:header-ext:h"]]
10[["cpp:include:IceGrid/Config.h"]]
11
12[["ice-prefix"]]
13
14[["js:module:ice"]]
15[["js:cjs-module"]]
16
17[["objc:dll-export:ICEGRID_API"]]
18[["objc:header-dir:objc"]]
19
20[["python:pkgdir:IceGrid"]]
21
22#include <IceGrid/Exception.ice>
23#include <IceGrid/Session.ice>
24#include <IceGrid/Admin.ice>
25#include <Ice/Locator.ice>
26
27#ifndef __SLICE2JAVA_COMPAT__
28[["java:package:com.zeroc"]]
29#endif
30
31["objc:prefix:ICEGRID"]
32module IceGrid
33{
34
57
64interface Query
65{
75 ["nonmutating", "cpp:const"] idempotent Object* findObjectById(Ice::Identity id);
76
88 ["nonmutating", "cpp:const"] idempotent Object* findObjectByType(string type);
89
105 ["nonmutating", "cpp:const"] idempotent Object* findObjectByTypeOnLeastLoadedNode(string type, LoadSample sample);
106
117 ["nonmutating", "cpp:const"] idempotent Ice::ObjectProxySeq findAllObjectsByType(string type);
118
131 ["cpp:const"] idempotent Ice::ObjectProxySeq findAllReplicas(Object* proxy);
132}
133
143interface Registry
144{
160 Session* createSession(string userId, string password)
162
178 AdminSession* createAdminSession(string userId, string password)
180
194
208
221 ["nonmutating", "cpp:const"] idempotent int getSessionTimeout();
222
234 ["nonmutating", "cpp:const"] idempotent int getACMTimeout();
235}
236
246interface Locator extends Ice::Locator
247{
256 ["cpp:const"] idempotent Registry* getLocalRegistry();
257
266 ["cpp:const"] idempotent Query* getLocalQuery();
267}
268
269}
This exception is raised if a client is denied the ability to create a session with IceGrid.
Definition Exception.ice:346
Used by administrative clients to view, update, and receive observer updates from the IceGrid registr...
Definition Admin.ice:1644
The IceGrid locator interface provides access to the Query and Registry object of the IceGrid registr...
Definition Registry.ice:247
idempotent Query * getLocalQuery()
Get the proxy of the query object hosted by this IceGrid registry.
idempotent Registry * getLocalRegistry()
Get the proxy of the registry object hosted by this IceGrid registry.
The IceGrid query interface.
Definition Registry.ice:65
idempotent Ice::ObjectProxySeq findAllObjectsByType(string type)
Find all the well-known objects with the given type.
idempotent Object * findObjectById(Ice::Identity id)
Find a well-known object by identity.
idempotent Object * findObjectByType(string type)
Find a well-known object by type.
idempotent Object * findObjectByTypeOnLeastLoadedNode(string type, LoadSample sample)
Find a well-known object by type on the least-loaded node.
idempotent Ice::ObjectProxySeq findAllReplicas(Object *proxy)
Find all the object replicas associated with the given proxy.
The IceGrid registry allows clients create sessions directly with the registry.
Definition Registry.ice:144
Session * createSession(string userId, string password)
Create a client session.
AdminSession * createAdminSessionFromSecureConnection()
Create an administrative session from a secure connection.
idempotent int getSessionTimeout()
Get the session timeout.
AdminSession * createAdminSession(string userId, string password)
Create an administrative session.
idempotent int getACMTimeout()
Get the value of the ACM timeout.
Session * createSessionFromSecureConnection()
Create a client session from a secure connection.
A session object is used by IceGrid clients to allocate and release objects.
Definition Session.ice:44
Definition Admin.ice:36
LoadSample
Determines which load sampling interval to use.
Definition Registry.ice:41
@ LoadSample1
Sample every minute.
Definition Registry.ice:45
@ LoadSample15
Sample every fifteen minutes.
Definition Registry.ice:55
@ LoadSample5
Sample every five minutes.
Definition Registry.ice:50
The Ice core library.
Definition BuiltinSequences.ice:27
sequence< Object > ObjectProxySeq
A sequence of object proxies.
Definition BuiltinSequences.ice:57
The identity of an Ice object.
Definition Identity.ice:40