Ice 3.7 Slice API Reference
Loading...
Searching...
No Matches
PluginFacade.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
23#include <Ice/Current.ice>
24
25#include <IceGrid/Admin.ice>
26
27#ifndef __SLICE2JAVA_COMPAT__
28[["java:package:com.zeroc"]]
29#endif
30
31["objc:prefix:ICEGRID"]
32module IceGrid
33{
34
45local interface ReplicaGroupFilter
46{
64 Ice::StringSeq filter(string replicaGroupId, Ice::StringSeq adapterIds, Ice::Connection con, Ice::Context ctx);
65}
66
78local interface TypeFilter
79{
98}
99
108local interface RegistryPluginFacade
109{
122 ["nonmutating", "cpp:const"] idempotent ApplicationInfo getApplicationInfo(string name)
124
136 ["nonmutating", "cpp:const"] idempotent ServerInfo getServerInfo(string id)
138
153 ["nonmutating", "cpp:const"] idempotent string getAdapterServer(string adapterId)
155
170 ["nonmutating", "cpp:const"] idempotent string getAdapterApplication(string adapterId)
172
187 ["nonmutating", "cpp:const"] idempotent string getAdapterNode(string adapterId)
189
207 ["nonmutating", "cpp:const"] idempotent AdapterInfoSeq getAdapterInfo(string id)
209
222 ["nonmutating", "cpp:const"] idempotent ObjectInfo getObjectInfo(Ice::Identity id)
224
239 ["nonmutating", "cpp:const"] idempotent NodeInfo getNodeInfo(string name)
241
256 ["nonmutating", "cpp:const"] idempotent LoadInfo getNodeLoad(string name)
258
274 ["nonmutating", "cpp:const"] idempotent string getPropertyForAdapter(string adapterId, string name)
276
289 ["cpp:noexcept", "swift:noexcept"] void addReplicaGroupFilter(string id, ReplicaGroupFilter filter);
290
302 ["cpp:noexcept", "swift:noexcept"] bool removeReplicaGroupFilter(string id, ReplicaGroupFilter filter);
303
313 ["cpp:noexcept", "swift:noexcept"] void addTypeFilter(string type, TypeFilter filter);
314
326 ["cpp:noexcept", "swift:noexcept"] bool removeTypeFilter(string type, TypeFilter filter);
327}
328
329}
This exception is raised if an adapter does not exist.
Definition Exception.ice:117
This exception is raised if an application does not exist.
Definition Exception.ice:43
This exception is raised if a node does not exist.
Definition Exception.ice:162
This exception is raised if a node could not be reached.
Definition Exception.ice:207
This exception is raised if an object is not registered.
Definition Exception.ice:147
This exception is raised if a server does not exist.
Definition Exception.ice:58
The RegistryPluginFacade is implemented by IceGrid and can be used by plugins and filter implementati...
Definition PluginFacade.ice:109
idempotent string getAdapterServer(string adapterId)
Get the ID of the server to which the given adapter belongs.
idempotent string getAdapterApplication(string adapterId)
Get the name of the application to which the given adapter belongs.
idempotent ObjectInfo getObjectInfo(Ice::Identity id)
Get the object info for the object with the given identity.
idempotent ApplicationInfo getApplicationInfo(string name)
Get an application descriptor.
idempotent string getAdapterNode(string adapterId)
Get the name of the node to which the given adapter belongs.
idempotent AdapterInfoSeq getAdapterInfo(string id)
Get the adapter information for the replica group or adapter with the given id.
idempotent string getPropertyForAdapter(string adapterId, string name)
Get the property value for the given property and adapter.
idempotent ServerInfo getServerInfo(string id)
Get the server information for the server with the given id.
void addReplicaGroupFilter(string id, ReplicaGroupFilter filter)
Add a replica group filter.
void addTypeFilter(string type, TypeFilter filter)
Add a type filter.
bool removeTypeFilter(string type, TypeFilter filter)
Remove a type filter.
idempotent NodeInfo getNodeInfo(string name)
Get the node information for the node with the given name.
idempotent LoadInfo getNodeLoad(string name)
Get the load averages of the node.
bool removeReplicaGroupFilter(string id, ReplicaGroupFilter filter)
Remove a replica group filter.
The ReplicaGroupFilter is used by IceGrid to filter adapters returned to the client when it resolves ...
Definition PluginFacade.ice:46
Ice::StringSeq filter(string replicaGroupId, Ice::StringSeq adapterIds, Ice::Connection con, Ice::Context ctx)
Filter the given set of adapters.
The TypeFilter is used by IceGrid to filter well-known proxies returned to the client when it searche...
Definition PluginFacade.ice:79
Ice::ObjectProxySeq filter(string type, Ice::ObjectProxySeq proxies, Ice::Connection con, Ice::Context ctx)
Filter the given set of proxies.
The user-level interface to a connection.
Definition Connection.ice:223
Definition Admin.ice:36
sequence< AdapterInfo > AdapterInfoSeq
A sequence of adapter information structures.
Definition Admin.ice:172
sequence< Object > ObjectProxySeq
A sequence of object proxies.
Definition BuiltinSequences.ice:57
dictionary< string, string > Context
A request context.
Definition Current.ice:42
sequence< string > StringSeq
A sequence of strings.
Definition BuiltinSequences.ice:51
Information about an IceGrid application.
Definition Admin.ice:344
Information about the load of a node.
Definition Admin.ice:327
Information about an IceGrid node.
Definition Admin.ice:230
Information about an Ice object.
Definition Admin.ice:113
Information about a server managed by an IceGrid node.
Definition Admin.ice:180
The identity of an Ice object.
Definition Identity.ice:40