Ice 3.7 C++11 API Reference
PluginFacade.h
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 //
5 // Ice version 3.7.10
6 //
7 // <auto-generated>
8 //
9 // Generated from file `PluginFacade.ice'
10 //
11 // Warning: do not edit this file.
12 //
13 // </auto-generated>
14 //
15 
16 #ifndef __IceGrid_PluginFacade_h__
17 #define __IceGrid_PluginFacade_h__
18 
20 #include <Ice/ProxyF.h>
21 #include <Ice/ObjectF.h>
22 #include <Ice/ValueF.h>
23 #include <Ice/Exception.h>
24 #include <Ice/LocalObject.h>
25 #include <Ice/StreamHelpers.h>
26 #include <Ice/Comparable.h>
27 #include <Ice/Proxy.h>
28 #include <Ice/Object.h>
29 #include <Ice/GCObject.h>
30 #include <Ice/Value.h>
31 #include <Ice/Incoming.h>
32 #include <Ice/IncomingAsync.h>
33 #include <Ice/FactoryTableInit.h>
34 #include <IceUtil/ScopedArray.h>
35 #include <Ice/Optional.h>
36 #include <Ice/ExceptionHelpers.h>
37 #include <Ice/SlicedDataF.h>
38 #include <Ice/BuiltinSequences.h>
39 #include <Ice/Current.h>
40 #include <IceGrid/Admin.h>
41 #include <IceUtil/UndefSysMacros.h>
42 #include <IceGrid/Config.h>
43 
44 #ifndef ICE_IGNORE_VERSION
45 # if ICE_INT_VERSION / 100 != 307
46 # error Ice version mismatch!
47 # endif
48 # if ICE_INT_VERSION % 100 >= 50
49 # error Beta header file detected
50 # endif
51 # if ICE_INT_VERSION % 100 < 10
52 # error Ice patch level mismatch!
53 # endif
54 #endif
55 
56 #ifndef ICEGRID_API
57 # if defined(ICE_STATIC_LIBS)
58 # define ICEGRID_API
59 # elif defined(ICEGRID_API_EXPORTS)
60 # define ICEGRID_API ICE_DECLSPEC_EXPORT
61 # else
62 # define ICEGRID_API ICE_DECLSPEC_IMPORT
63 # endif
64 #endif
65 
66 #ifdef ICE_CPP11_MAPPING // C++11 mapping
67 
68 namespace IceGrid
69 {
70 
71 class ReplicaGroupFilter;
72 class TypeFilter;
73 class RegistryPluginFacade;
74 
75 }
76 
77 namespace IceGrid
78 {
79 
89 class ICE_CLASS(ICEGRID_API) ReplicaGroupFilter
90 {
91 public:
92 
94 
105  virtual ::Ice::StringSeq filter(const ::std::string& replicaGroupId, const ::Ice::StringSeq& adapterIds, const ::std::shared_ptr<::Ice::Connection>& con, const ::Ice::Context& ctx) = 0;
106 };
107 
118 class ICE_CLASS(ICEGRID_API) TypeFilter
119 {
120 public:
121 
123 
134  virtual ::Ice::ObjectProxySeq filter(const ::std::string& type, const ::Ice::ObjectProxySeq& proxies, const ::std::shared_ptr<::Ice::Connection>& con, const ::Ice::Context& ctx) = 0;
135 };
136 
144 class ICE_CLASS(ICEGRID_API) RegistryPluginFacade
145 {
146 public:
147 
149 
157  virtual ::IceGrid::ApplicationInfo getApplicationInfo(const ::std::string& name) const = 0;
158 
165  virtual ::IceGrid::ServerInfo getServerInfo(const ::std::string& id) const = 0;
166 
176  virtual ::std::string getAdapterServer(const ::std::string& adapterId) const = 0;
177 
187  virtual ::std::string getAdapterApplication(const ::std::string& adapterId) const = 0;
188 
198  virtual ::std::string getAdapterNode(const ::std::string& adapterId) const = 0;
199 
212  virtual ::IceGrid::AdapterInfoSeq getAdapterInfo(const ::std::string& id) const = 0;
213 
221  virtual ::IceGrid::ObjectInfo getObjectInfo(const ::Ice::Identity& id) const = 0;
222 
231  virtual ::IceGrid::NodeInfo getNodeInfo(const ::std::string& name) const = 0;
232 
241  virtual ::IceGrid::LoadInfo getNodeLoad(const ::std::string& name) const = 0;
242 
252  virtual ::std::string getPropertyForAdapter(const ::std::string& adapterId, const ::std::string& name) const = 0;
253 
262  virtual void addReplicaGroupFilter(const ::std::string& id, const ::std::shared_ptr<ReplicaGroupFilter>& filter) noexcept = 0;
263 
270  virtual bool removeReplicaGroupFilter(const ::std::string& id, const ::std::shared_ptr<ReplicaGroupFilter>& filter) noexcept = 0;
271 
277  virtual void addTypeFilter(const ::std::string& type, const ::std::shared_ptr<TypeFilter>& filter) noexcept = 0;
278 
285  virtual bool removeTypeFilter(const ::std::string& type, const ::std::shared_ptr<TypeFilter>& filter) noexcept = 0;
286 };
287 
288 }
289 
291 namespace Ice
292 {
293 
294 }
296 
298 namespace IceGrid
299 {
300 
301 using ReplicaGroupFilterPtr = ::std::shared_ptr<ReplicaGroupFilter>;
302 
303 using TypeFilterPtr = ::std::shared_ptr<TypeFilter>;
304 
305 using RegistryPluginFacadePtr = ::std::shared_ptr<RegistryPluginFacade>;
306 
307 }
309 
310 #else // C++98 mapping
311 
312 namespace IceProxy
313 {
314 
315 }
316 
317 namespace IceGrid
318 {
319 
320 class ReplicaGroupFilter;
322 ICEGRID_API ::Ice::LocalObject* upCast(ReplicaGroupFilter*);
324 typedef ::IceInternal::Handle< ReplicaGroupFilter> ReplicaGroupFilterPtr;
325 
326 class TypeFilter;
328 ICEGRID_API ::Ice::LocalObject* upCast(TypeFilter*);
330 typedef ::IceInternal::Handle< TypeFilter> TypeFilterPtr;
331 
332 class RegistryPluginFacade;
334 ICEGRID_API ::Ice::LocalObject* upCast(RegistryPluginFacade*);
336 typedef ::IceInternal::Handle< RegistryPluginFacade> RegistryPluginFacadePtr;
337 
338 }
339 
341 namespace IceAsync
342 {
343 
344 }
346 
347 namespace IceProxy
348 {
349 
350 }
351 
352 namespace IceGrid
353 {
354 
364 class ICEGRID_API ReplicaGroupFilter : public virtual ::Ice::LocalObject
365 {
366 public:
367 
368  typedef ReplicaGroupFilterPtr PointerType;
369 
370  virtual ~ReplicaGroupFilter();
371 
372 #ifdef ICE_CPP11_COMPILER
373  ReplicaGroupFilter() = default;
374  ReplicaGroupFilter(const ReplicaGroupFilter&) = default;
375  ReplicaGroupFilter& operator=(const ReplicaGroupFilter&) = default;
376 #endif
377 
388  virtual ::Ice::StringSeq filter(const ::std::string& replicaGroupId, const ::Ice::StringSeq& adapterIds, const ::Ice::ConnectionPtr& con, const ::Ice::Context& ctx) = 0;
389 };
390 
392 inline bool operator==(const ReplicaGroupFilter& lhs, const ReplicaGroupFilter& rhs)
393 {
394  return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
395 }
396 
397 inline bool operator<(const ReplicaGroupFilter& lhs, const ReplicaGroupFilter& rhs)
398 {
399  return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
400 }
402 
413 class ICEGRID_API TypeFilter : public virtual ::Ice::LocalObject
414 {
415 public:
416 
417  typedef TypeFilterPtr PointerType;
418 
419  virtual ~TypeFilter();
420 
421 #ifdef ICE_CPP11_COMPILER
422  TypeFilter() = default;
423  TypeFilter(const TypeFilter&) = default;
424  TypeFilter& operator=(const TypeFilter&) = default;
425 #endif
426 
437  virtual ::Ice::ObjectProxySeq filter(const ::std::string& type, const ::Ice::ObjectProxySeq& proxies, const ::Ice::ConnectionPtr& con, const ::Ice::Context& ctx) = 0;
438 };
439 
441 inline bool operator==(const TypeFilter& lhs, const TypeFilter& rhs)
442 {
443  return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
444 }
445 
446 inline bool operator<(const TypeFilter& lhs, const TypeFilter& rhs)
447 {
448  return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
449 }
451 
459 class ICEGRID_API RegistryPluginFacade : public virtual ::Ice::LocalObject
460 {
461 public:
462 
463  typedef RegistryPluginFacadePtr PointerType;
464 
465  virtual ~RegistryPluginFacade();
466 
467 #ifdef ICE_CPP11_COMPILER
468  RegistryPluginFacade() = default;
469  RegistryPluginFacade(const RegistryPluginFacade&) = default;
470  RegistryPluginFacade& operator=(const RegistryPluginFacade&) = default;
471 #endif
472 
480  virtual ApplicationInfo getApplicationInfo(const ::std::string& name) const = 0;
481 
488  virtual ServerInfo getServerInfo(const ::std::string& id) const = 0;
489 
499  virtual ::std::string getAdapterServer(const ::std::string& adapterId) const = 0;
500 
510  virtual ::std::string getAdapterApplication(const ::std::string& adapterId) const = 0;
511 
521  virtual ::std::string getAdapterNode(const ::std::string& adapterId) const = 0;
522 
535  virtual AdapterInfoSeq getAdapterInfo(const ::std::string& id) const = 0;
536 
544  virtual ObjectInfo getObjectInfo(const ::Ice::Identity& id) const = 0;
545 
554  virtual NodeInfo getNodeInfo(const ::std::string& name) const = 0;
555 
564  virtual LoadInfo getNodeLoad(const ::std::string& name) const = 0;
565 
575  virtual ::std::string getPropertyForAdapter(const ::std::string& adapterId, const ::std::string& name) const = 0;
576 
585  virtual void addReplicaGroupFilter(const ::std::string& id, const ReplicaGroupFilterPtr& filter) ICE_NOEXCEPT = 0;
586 
593  virtual bool removeReplicaGroupFilter(const ::std::string& id, const ReplicaGroupFilterPtr& filter) ICE_NOEXCEPT = 0;
594 
600  virtual void addTypeFilter(const ::std::string& type, const TypeFilterPtr& filter) ICE_NOEXCEPT = 0;
601 
608  virtual bool removeTypeFilter(const ::std::string& type, const TypeFilterPtr& filter) ICE_NOEXCEPT = 0;
609 };
610 
612 inline bool operator==(const RegistryPluginFacade& lhs, const RegistryPluginFacade& rhs)
613 {
614  return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
615 }
616 
617 inline bool operator<(const RegistryPluginFacade& lhs, const RegistryPluginFacade& rhs)
618 {
619  return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
620 }
622 
623 }
624 
626 namespace Ice
627 {
628 
629 }
631 
632 #endif
633 
635 #endif
IceGrid::ReplicaGroupFilter::filter
virtual ::Ice::StringSeq filter(const ::std::string &replicaGroupId, const ::Ice::StringSeq &adapterIds, const ::std::shared_ptr<::Ice::Connection > &con, const ::Ice::Context &ctx)=0
Filter the the given set of adapters.
IceGrid::RegistryPluginFacade::getNodeInfo
virtual ::IceGrid::NodeInfo getNodeInfo(const ::std::string &name) const =0
Get the node information for the node with the given name.
Ice::ObjectProxySeq
::std::vector<::std::shared_ptr< ObjectPrx > > ObjectProxySeq
A sequence of object proxies.
Definition: BuiltinSequences.h:106
Optional.h
Ice::Context
::std::map<::std::string, ::std::string > Context
A request context.
Definition: Current.h:68
IceGrid::RegistryPluginFacade::getAdapterNode
virtual ::std::string getAdapterNode(const ::std::string &adapterId) const =0
Get the name of the node to which the given adapter belongs.
Current.h
IceGrid::ReplicaGroupFilter
The ReplicaGroupFilter is used by IceGrid to filter adapters returned to the client when it resolves ...
Definition: PluginFacade.h:90
IceGrid::RegistryPluginFacade::addTypeFilter
virtual void addTypeFilter(const ::std::string &type, const ::std::shared_ptr< TypeFilter > &filter) noexcept=0
Add a type filter.
StreamHelpers.h
IceGrid::RegistryPluginFacade::~RegistryPluginFacade
virtual ~RegistryPluginFacade()
IceGrid::RegistryPluginFacade::getAdapterInfo
virtual ::IceGrid::AdapterInfoSeq getAdapterInfo(const ::std::string &id) const =0
Get the adapter information for the replica group or adapter with the given id.
Ice::operator==
bool operator==(const C &lhs, const C &rhs)
Relational operator for generated structs and classes.
Definition: Comparable.h:184
GCObject.h
ICE_NOEXCEPT
#define ICE_NOEXCEPT
Definition: Config.h:128
Incoming.h
IceGrid::TypeFilter::~TypeFilter
virtual ~TypeFilter()
ICE_MEMBER
#define ICE_MEMBER(API)
Definition: Config.h:177
FactoryTableInit.h
IceGrid::RegistryPluginFacade::getAdapterServer
virtual ::std::string getAdapterServer(const ::std::string &adapterId) const =0
Get the ID of the server to which the given adapter belongs.
IceGrid::RegistryPluginFacade::getAdapterApplication
virtual ::std::string getAdapterApplication(const ::std::string &adapterId) const =0
Get the name of the application to which the given adapter belongs.
IceGrid::RegistryPluginFacade::getNodeLoad
virtual ::IceGrid::LoadInfo getNodeLoad(const ::std::string &name) const =0
Get the load averages of the node.
Admin.h
IncomingAsync.h
LocalObject.h
PushDisableWarnings.h
ProxyF.h
Ice::operator<
bool operator<(const C &lhs, const C &rhs)
Relational operator for generated structs and classes.
Definition: Comparable.h:136
IceGrid::RegistryPluginFacade::getServerInfo
virtual ::IceGrid::ServerInfo getServerInfo(const ::std::string &id) const =0
Get the server information for the server with the given id.
SlicedDataF.h
IceGrid::RegistryPluginFacade
The RegistryPluginFacade is implemented by IceGrid and can be used by plugins and filter implementati...
Definition: PluginFacade.h:145
ICEGRID_API
#define ICEGRID_API
Definition: PluginFacade.h:62
IceGrid::TypeFilter
The TypeFilter is used by IceGrid to filter well-known proxies returned to the client when it searche...
Definition: PluginFacade.h:119
Object.h
Proxy.h
UndefSysMacros.h
IceGrid::TypeFilter::filter
virtual ::Ice::ObjectProxySeq filter(const ::std::string &type, const ::Ice::ObjectProxySeq &proxies, const ::std::shared_ptr<::Ice::Connection > &con, const ::Ice::Context &ctx)=0
Filter the the given set of proxies.
ObjectF.h
Ice::StringSeq
::std::vector<::std::string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.h:96
IceGrid::RegistryPluginFacade::getObjectInfo
virtual ::IceGrid::ObjectInfo getObjectInfo(const ::Ice::Identity &id) const =0
Get the object info for the object with the given identity.
IceGrid::RegistryPluginFacade::removeReplicaGroupFilter
virtual bool removeReplicaGroupFilter(const ::std::string &id, const ::std::shared_ptr< ReplicaGroupFilter > &filter) noexcept=0
Remove a replica group filter.
Ice
Definition: BuiltinSequences.h:56
IceGrid::RegistryPluginFacade::removeTypeFilter
virtual bool removeTypeFilter(const ::std::string &type, const ::std::shared_ptr< TypeFilter > &filter) noexcept=0
Remove a type filter.
IceGrid::AdapterInfoSeq
::std::vector< AdapterInfo > AdapterInfoSeq
A sequence of adapter information structures.
Definition: Admin.h:204
IceGrid::ReplicaGroupFilter::~ReplicaGroupFilter
virtual ~ReplicaGroupFilter()
ExceptionHelpers.h
IceGrid::RegistryPluginFacade::getApplicationInfo
virtual ::IceGrid::ApplicationInfo getApplicationInfo(const ::std::string &name) const =0
Get an application descriptor.
Config.h
Comparable.h
BuiltinSequences.h
ScopedArray.h
IceGrid::RegistryPluginFacade::addReplicaGroupFilter
virtual void addReplicaGroupFilter(const ::std::string &id, const ::std::shared_ptr< ReplicaGroupFilter > &filter) noexcept=0
Add a replica group filter.
IceGrid
Definition: Admin.h:73
Exception.h
ValueF.h
Value.h
IceGrid::RegistryPluginFacade::getPropertyForAdapter
virtual ::std::string getPropertyForAdapter(const ::std::string &adapterId, const ::std::string &name) const =0
Get the property value for the given property and adapter.
PopDisableWarnings.h