Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | List of all members
IceGrid::AdminPrx Class Reference

The IceGrid administrative interface. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::AdminPrx:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::AdminPrx:
Collaboration graph
[legend]

Public Member Functions

void addApplication (const ApplicationDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add an application to IceGrid. More...
 
::std::function< void()> addApplicationAsync (const ApplicationDescriptor &descriptor, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add an application to IceGrid. More...
 
template<template< typename > class P = ::std::promise>
auto addApplicationAsync (const ApplicationDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Add an application to IceGrid. More...
 
void addObject (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add an object to the object registry. More...
 
::std::function< void()> addObjectAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add an object to the object registry. More...
 
template<template< typename > class P = ::std::promise>
auto addObjectAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Add an object to the object registry. More...
 
void addObjectWithType (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add an object to the object registry and explicitly specify its type. More...
 
::std::function< void()> addObjectWithTypeAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::std::string &type, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add an object to the object registry and explicitly specify its type. More...
 
template<template< typename > class P = ::std::promise>
auto addObjectWithTypeAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Add an object to the object registry and explicitly specify its type. More...
 
void enableServer (const ::std::string &id, bool enabled, const ::Ice::Context &context=::Ice::noExplicitContext)
 Enable or disable a server. More...
 
::std::function< void()> enableServerAsync (const ::std::string &id, bool enabled, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Enable or disable a server. More...
 
template<template< typename > class P = ::std::promise>
auto enableServerAsync (const ::std::string &id, bool enabled, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Enable or disable a server. More...
 
AdapterInfoSeq getAdapterInfo (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the adapter information for the replica group or adapter with the given id. More...
 
::std::function< void()> getAdapterInfoAsync (const ::std::string &id, ::std::function< void(::IceGrid::AdapterInfoSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the adapter information for the replica group or adapter with the given id. More...
 
template<template< typename > class P = ::std::promise>
auto getAdapterInfoAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::AdapterInfoSeq >>().get_future())
 Get the adapter information for the replica group or adapter with the given id. More...
 
::Ice::StringSeq getAllAdapterIds (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the adapter ids registered with IceGrid. More...
 
::std::function< void()> getAllAdapterIdsAsync (::std::function< void(::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the adapter ids registered with IceGrid. More...
 
template<template< typename > class P = ::std::promise>
auto getAllAdapterIdsAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::StringSeq >>().get_future())
 Get all the adapter ids registered with IceGrid. More...
 
::Ice::StringSeq getAllApplicationNames (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the IceGrid applications currently registered. More...
 
::std::function< void()> getAllApplicationNamesAsync (::std::function< void(::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the IceGrid applications currently registered. More...
 
template<template< typename > class P = ::std::promise>
auto getAllApplicationNamesAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::StringSeq >>().get_future())
 Get all the IceGrid applications currently registered. More...
 
::Ice::StringSeq getAllNodeNames (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the IceGrid nodes currently registered. More...
 
::std::function< void()> getAllNodeNamesAsync (::std::function< void(::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the IceGrid nodes currently registered. More...
 
template<template< typename > class P = ::std::promise>
auto getAllNodeNamesAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::StringSeq >>().get_future())
 Get all the IceGrid nodes currently registered. More...
 
ObjectInfoSeq getAllObjectInfos (const ::std::string &expr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the object info of all the registered objects whose stringified identities match the given expression. More...
 
::std::function< void()> getAllObjectInfosAsync (const ::std::string &expr, ::std::function< void(::IceGrid::ObjectInfoSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the object info of all the registered objects whose stringified identities match the given expression. More...
 
template<template< typename > class P = ::std::promise>
auto getAllObjectInfosAsync (const ::std::string &expr, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ObjectInfoSeq >>().get_future())
 Get the object info of all the registered objects whose stringified identities match the given expression. More...
 
::Ice::StringSeq getAllRegistryNames (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the IceGrid registries currently registered. More...
 
::std::function< void()> getAllRegistryNamesAsync (::std::function< void(::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the IceGrid registries currently registered. More...
 
template<template< typename > class P = ::std::promise>
auto getAllRegistryNamesAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::StringSeq >>().get_future())
 Get all the IceGrid registries currently registered. More...
 
::Ice::StringSeq getAllServerIds (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the server ids registered with IceGrid. More...
 
::std::function< void()> getAllServerIdsAsync (::std::function< void(::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get all the server ids registered with IceGrid. More...
 
template<template< typename > class P = ::std::promise>
auto getAllServerIdsAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::StringSeq >>().get_future())
 Get all the server ids registered with IceGrid. More...
 
ApplicationInfo getApplicationInfo (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get an application descriptor. More...
 
::std::function< void()> getApplicationInfoAsync (const ::std::string &name, ::std::function< void(::IceGrid::ApplicationInfo)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get an application descriptor. More...
 
template<template< typename > class P = ::std::promise>
auto getApplicationInfoAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ApplicationInfo >>().get_future())
 Get an application descriptor. More...
 
ApplicationDescriptor getDefaultApplicationDescriptor (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the default application descriptor. More...
 
::std::function< void()> getDefaultApplicationDescriptorAsync (::std::function< void(::IceGrid::ApplicationDescriptor)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the default application descriptor. More...
 
template<template< typename > class P = ::std::promise>
auto getDefaultApplicationDescriptorAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ApplicationDescriptor >>().get_future())
 Get the default application descriptor. More...
 
::std::shared_ptr<::Ice::ObjectPrxgetNodeAdmin (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to the IceGrid node's admin object. More...
 
::std::function< void()> getNodeAdminAsync (const ::std::string &name, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to the IceGrid node's admin object. More...
 
template<template< typename > class P = ::std::promise>
auto getNodeAdminAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
 Get a proxy to the IceGrid node's admin object. More...
 
::std::string getNodeHostname (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the hostname of this node. More...
 
::std::function< void()> getNodeHostnameAsync (const ::std::string &name, ::std::function< void(::std::string)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the hostname of this node. More...
 
template<template< typename > class P = ::std::promise>
auto getNodeHostnameAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::string >>().get_future())
 Get the hostname of this node. More...
 
NodeInfo getNodeInfo (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the node information for the node with the given name. More...
 
::std::function< void()> getNodeInfoAsync (const ::std::string &name, ::std::function< void(::IceGrid::NodeInfo)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the node information for the node with the given name. More...
 
template<template< typename > class P = ::std::promise>
auto getNodeInfoAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::NodeInfo >>().get_future())
 Get the node information for the node with the given name. More...
 
LoadInfo getNodeLoad (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the load averages of the node. More...
 
::std::function< void()> getNodeLoadAsync (const ::std::string &name, ::std::function< void(::IceGrid::LoadInfo)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the load averages of the node. More...
 
template<template< typename > class P = ::std::promise>
auto getNodeLoadAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::LoadInfo >>().get_future())
 Get the load averages of the node. More...
 
int getNodeProcessorSocketCount (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the number of physical processor sockets for the machine running the node with the given name. More...
 
::std::function< void()> getNodeProcessorSocketCountAsync (const ::std::string &name, ::std::function< void(int)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the number of physical processor sockets for the machine running the node with the given name. More...
 
template<template< typename > class P = ::std::promise>
auto getNodeProcessorSocketCountAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< int >>().get_future())
 Get the number of physical processor sockets for the machine running the node with the given name. More...
 
ObjectInfo getObjectInfo (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the object info for the object with the given identity. More...
 
::std::function< void()> getObjectInfoAsync (const ::Ice::Identity &id, ::std::function< void(::IceGrid::ObjectInfo)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the object info for the object with the given identity. More...
 
template<template< typename > class P = ::std::promise>
auto getObjectInfoAsync (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ObjectInfo >>().get_future())
 Get the object info for the object with the given identity. More...
 
ObjectInfoSeq getObjectInfosByType (const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the object info of all the registered objects with the given type. More...
 
::std::function< void()> getObjectInfosByTypeAsync (const ::std::string &type, ::std::function< void(::IceGrid::ObjectInfoSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the object info of all the registered objects with the given type. More...
 
template<template< typename > class P = ::std::promise>
auto getObjectInfosByTypeAsync (const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ObjectInfoSeq >>().get_future())
 Get the object info of all the registered objects with the given type. More...
 
::std::shared_ptr<::Ice::ObjectPrxgetRegistryAdmin (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to the IceGrid registry's admin object. More...
 
::std::function< void()> getRegistryAdminAsync (const ::std::string &name, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to the IceGrid registry's admin object. More...
 
template<template< typename > class P = ::std::promise>
auto getRegistryAdminAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
 Get a proxy to the IceGrid registry's admin object. More...
 
RegistryInfo getRegistryInfo (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the registry information for the registry with the given name. More...
 
::std::function< void()> getRegistryInfoAsync (const ::std::string &name, ::std::function< void(::IceGrid::RegistryInfo)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the registry information for the registry with the given name. More...
 
template<template< typename > class P = ::std::promise>
auto getRegistryInfoAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::RegistryInfo >>().get_future())
 Get the registry information for the registry with the given name. More...
 
::std::shared_ptr<::Ice::ObjectPrxgetServerAdmin (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to the server's admin object. More...
 
::std::function< void()> getServerAdminAsync (const ::std::string &id, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a proxy to the server's admin object. More...
 
template<template< typename > class P = ::std::promise>
auto getServerAdminAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
 Get a proxy to the server's admin object. More...
 
::std::string getServerAdminCategory (const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the category for server admin objects. More...
 
::std::function< void()> getServerAdminCategoryAsync (::std::function< void(::std::string)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the category for server admin objects. More...
 
template<template< typename > class P = ::std::promise>
auto getServerAdminCategoryAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::string >>().get_future())
 Get the category for server admin objects. More...
 
ServerInfo getServerInfo (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the server information for the server with the given id. More...
 
::std::function< void()> getServerInfoAsync (const ::std::string &id, ::std::function< void(::IceGrid::ServerInfo)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get the server information for the server with the given id. More...
 
template<template< typename > class P = ::std::promise>
auto getServerInfoAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ServerInfo >>().get_future())
 Get the server information for the server with the given id. More...
 
int getServerPid (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a server's system process id. More...
 
::std::function< void()> getServerPidAsync (const ::std::string &id, ::std::function< void(int)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a server's system process id. More...
 
template<template< typename > class P = ::std::promise>
auto getServerPidAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< int >>().get_future())
 Get a server's system process id. More...
 
ServerState getServerState (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a server's state. More...
 
::std::function< void()> getServerStateAsync (const ::std::string &id, ::std::function< void(::IceGrid::ServerState)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Get a server's state. More...
 
template<template< typename > class P = ::std::promise>
auto getServerStateAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceGrid::ServerState >>().get_future())
 Get a server's state. More...
 
::Ice::SliceChecksumDict getSliceChecksums (const ::Ice::Context &context=::Ice::noExplicitContext)
 Returns the checksums for the IceGrid Slice definitions. More...
 
::std::function< void()> getSliceChecksumsAsync (::std::function< void(::Ice::SliceChecksumDict)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Returns the checksums for the IceGrid Slice definitions. More...
 
template<template< typename > class P = ::std::promise>
auto getSliceChecksumsAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::SliceChecksumDict >>().get_future())
 Returns the checksums for the IceGrid Slice definitions. More...
 
void instantiateServer (const ::std::string &application, const ::std::string &node, const ServerInstanceDescriptor &desc, const ::Ice::Context &context=::Ice::noExplicitContext)
 Instantiate a server template from an application on the given node. More...
 
::std::function< void()> instantiateServerAsync (const ::std::string &application, const ::std::string &node, const ServerInstanceDescriptor &desc, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Instantiate a server template from an application on the given node. More...
 
template<template< typename > class P = ::std::promise>
auto instantiateServerAsync (const ::std::string &application, const ::std::string &node, const ServerInstanceDescriptor &desc, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Instantiate a server template from an application on the given node. More...
 
bool isServerEnabled (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Check if the server is enabled or disabled. More...
 
::std::function< void()> isServerEnabledAsync (const ::std::string &id, ::std::function< void(bool)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Check if the server is enabled or disabled. More...
 
template<template< typename > class P = ::std::promise>
auto isServerEnabledAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< bool >>().get_future())
 Check if the server is enabled or disabled. More...
 
void patchApplication (const ::std::string &name, bool shutdown, const ::Ice::Context &context=::Ice::noExplicitContext)
 Patch the given application data. More...
 
::std::function< void()> patchApplicationAsync (const ::std::string &name, bool shutdown, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Patch the given application data. More...
 
template<template< typename > class P = ::std::promise>
auto patchApplicationAsync (const ::std::string &name, bool shutdown, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Patch the given application data. More...
 
void patchServer (const ::std::string &id, bool shutdown, const ::Ice::Context &context=::Ice::noExplicitContext)
 Patch a server. More...
 
::std::function< void()> patchServerAsync (const ::std::string &id, bool shutdown, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Patch a server. More...
 
template<template< typename > class P = ::std::promise>
auto patchServerAsync (const ::std::string &id, bool shutdown, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Patch a server. More...
 
bool pingNode (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Ping an IceGrid node to see if it is active. More...
 
::std::function< void()> pingNodeAsync (const ::std::string &name, ::std::function< void(bool)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Ping an IceGrid node to see if it is active. More...
 
template<template< typename > class P = ::std::promise>
auto pingNodeAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< bool >>().get_future())
 Ping an IceGrid node to see if it is active. More...
 
bool pingRegistry (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Ping an IceGrid registry to see if it is active. More...
 
::std::function< void()> pingRegistryAsync (const ::std::string &name, ::std::function< void(bool)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Ping an IceGrid registry to see if it is active. More...
 
template<template< typename > class P = ::std::promise>
auto pingRegistryAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< bool >>().get_future())
 Ping an IceGrid registry to see if it is active. More...
 
void removeAdapter (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove the adapter with the given id. More...
 
::std::function< void()> removeAdapterAsync (const ::std::string &id, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove the adapter with the given id. More...
 
template<template< typename > class P = ::std::promise>
auto removeAdapterAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Remove the adapter with the given id. More...
 
void removeApplication (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove an application from IceGrid. More...
 
::std::function< void()> removeApplicationAsync (const ::std::string &name, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove an application from IceGrid. More...
 
template<template< typename > class P = ::std::promise>
auto removeApplicationAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Remove an application from IceGrid. More...
 
void removeObject (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove an object from the object registry. More...
 
::std::function< void()> removeObjectAsync (const ::Ice::Identity &id, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove an object from the object registry. More...
 
template<template< typename > class P = ::std::promise>
auto removeObjectAsync (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Remove an object from the object registry. More...
 
void sendSignal (const ::std::string &id, const ::std::string &signal, const ::Ice::Context &context=::Ice::noExplicitContext)
 Send signal to a server. More...
 
::std::function< void()> sendSignalAsync (const ::std::string &id, const ::std::string &signal, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Send signal to a server. More...
 
template<template< typename > class P = ::std::promise>
auto sendSignalAsync (const ::std::string &id, const ::std::string &signal, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Send signal to a server. More...
 
void shutdown (const ::Ice::Context &context=::Ice::noExplicitContext)
 Shut down the IceGrid registry. More...
 
::std::function< void()> shutdownAsync (::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Shut down the IceGrid registry. More...
 
template<template< typename > class P = ::std::promise>
auto shutdownAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Shut down the IceGrid registry. More...
 
void shutdownNode (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Shutdown an IceGrid node. More...
 
::std::function< void()> shutdownNodeAsync (const ::std::string &name, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Shutdown an IceGrid node. More...
 
template<template< typename > class P = ::std::promise>
auto shutdownNodeAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Shutdown an IceGrid node. More...
 
void shutdownRegistry (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
 Shutdown an IceGrid registry. More...
 
::std::function< void()> shutdownRegistryAsync (const ::std::string &name, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Shutdown an IceGrid registry. More...
 
template<template< typename > class P = ::std::promise>
auto shutdownRegistryAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Shutdown an IceGrid registry. More...
 
void startServer (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Start a server and wait for its activation. More...
 
::std::function< void()> startServerAsync (const ::std::string &id, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Start a server and wait for its activation. More...
 
template<template< typename > class P = ::std::promise>
auto startServerAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Start a server and wait for its activation. More...
 
void stopServer (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 Stop a server. More...
 
::std::function< void()> stopServerAsync (const ::std::string &id, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Stop a server. More...
 
template<template< typename > class P = ::std::promise>
auto stopServerAsync (const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Stop a server. More...
 
void syncApplication (const ApplicationDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext)
 Synchronize a deployed application with the given application descriptor. More...
 
::std::function< void()> syncApplicationAsync (const ApplicationDescriptor &descriptor, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Synchronize a deployed application with the given application descriptor. More...
 
template<template< typename > class P = ::std::promise>
auto syncApplicationAsync (const ApplicationDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Synchronize a deployed application with the given application descriptor. More...
 
void syncApplicationWithoutRestart (const ApplicationDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext)
 Synchronize a deployed application with the given application descriptor. More...
 
::std::function< void()> syncApplicationWithoutRestartAsync (const ApplicationDescriptor &descriptor, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Synchronize a deployed application with the given application descriptor. More...
 
template<template< typename > class P = ::std::promise>
auto syncApplicationWithoutRestartAsync (const ApplicationDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Synchronize a deployed application with the given application descriptor. More...
 
void updateApplication (const ApplicationUpdateDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext)
 Update a deployed application with the given update application descriptor. More...
 
::std::function< void()> updateApplicationAsync (const ApplicationUpdateDescriptor &descriptor, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Update a deployed application with the given update application descriptor. More...
 
template<template< typename > class P = ::std::promise>
auto updateApplicationAsync (const ApplicationUpdateDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Update a deployed application with the given update application descriptor. More...
 
void updateApplicationWithoutRestart (const ApplicationUpdateDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext)
 Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application. More...
 
::std::function< void()> updateApplicationWithoutRestartAsync (const ApplicationUpdateDescriptor &descriptor, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application. More...
 
template<template< typename > class P = ::std::promise>
auto updateApplicationWithoutRestartAsync (const ApplicationUpdateDescriptor &descriptor, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application. More...
 
void updateObject (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::Ice::Context &context=::Ice::noExplicitContext)
 Update an object in the object registry. More...
 
::std::function< void()> updateObjectAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Update an object in the object registry. More...
 
template<template< typename > class P = ::std::promise>
auto updateObjectAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &obj, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Update an object in the object registry. More...
 
- Public Member Functions inherited from Ice::Proxy< AdminPrx, ::Ice::ObjectPrx >
::std::shared_ptr< AdminPrx > ice_adapterId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for the adapter ID. More...
 
::std::shared_ptr< AdminPrx > ice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< AdminPrx > ice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< AdminPrx > ice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< AdminPrx > ice_compress (bool b) const
 Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...
 
::std::shared_ptr< AdminPrx > ice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< AdminPrx > ice_connectionId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for its connection ID. More...
 
::std::shared_ptr< AdminPrx > ice_context (const ::Ice::Context &context) const
 Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...
 
::std::shared_ptr< AdminPrx > ice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< AdminPrx > ice_encodingVersion (const ::Ice::EncodingVersion &version) const
 Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...
 
::std::shared_ptr< AdminPrx > ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< AdminPrx > ice_endpointSelection (::Ice::EndpointSelectionType type) const
 Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...
 
::std::shared_ptr< AdminPrx > ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
 Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...
 
::std::shared_ptr< AdminPrx > ice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< AdminPrx > ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
 Obtains a proxy that is identical to this proxy, except for the locator. More...
 
::std::shared_ptr< AdminPrx > ice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< AdminPrx > ice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< AdminPrx > ice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< AdminPrx > ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
 Obtains a proxy that is identical to this proxy, except for the router. More...
 
::std::shared_ptr< AdminPrx > ice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< AdminPrx > ice_timeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...
 
::std::shared_ptr< AdminPrx > ice_twoway () const
 Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this interface. More...
 

Detailed Description

The IceGrid administrative interface.

Allowing access to this interface is a security risk! Please see the IceGrid documentation for further information.

Member Function Documentation

◆ addApplication()

void IceGrid::AdminPrx::addApplication ( const ApplicationDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add an application to IceGrid.

Parameters
descriptorThe application descriptor.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ addApplicationAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::addApplicationAsync ( const ApplicationDescriptor descriptor,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add an application to IceGrid.

Parameters
descriptorThe application descriptor.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ addApplicationAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::addApplicationAsync ( const ApplicationDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Add an application to IceGrid.

Parameters
descriptorThe application descriptor.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ addObject()

void IceGrid::AdminPrx::addObject ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add an object to the object registry.

IceGrid will get the object type by calling ice_id on the given proxy. The object must be reachable.

Parameters
objThe object to be added to the registry.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the object can't be added. This might be raised if the invocation on the proxy to get the object type failed.
IceGrid::ObjectExistsExceptionRaised if the object is already registered.

◆ addObjectAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::addObjectAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add an object to the object registry.

IceGrid will get the object type by calling ice_id on the given proxy. The object must be reachable.

Parameters
objThe object to be added to the registry.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ addObjectAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::addObjectAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Add an object to the object registry.

IceGrid will get the object type by calling ice_id on the given proxy. The object must be reachable.

Parameters
objThe object to be added to the registry.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ addObjectWithType()

void IceGrid::AdminPrx::addObjectWithType ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::std::string &  type,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add an object to the object registry and explicitly specify its type.

Parameters
objThe object to be added to the registry.
typeThe object type.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if application deployment failed.
IceGrid::ObjectExistsExceptionRaised if the object is already registered.

◆ addObjectWithTypeAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::addObjectWithTypeAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::std::string &  type,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add an object to the object registry and explicitly specify its type.

Parameters
objThe object to be added to the registry.
typeThe object type.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ addObjectWithTypeAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::addObjectWithTypeAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::std::string &  type,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Add an object to the object registry and explicitly specify its type.

Parameters
objThe object to be added to the registry.
typeThe object type.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ enableServer()

void IceGrid::AdminPrx::enableServer ( const ::std::string &  id,
bool  enabled,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Enable or disable a server.

A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.

Parameters
idThe server id.
enabledTrue to enable the server, false to disable it.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ enableServerAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::enableServerAsync ( const ::std::string &  id,
bool  enabled,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Enable or disable a server.

A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.

Parameters
idThe server id.
enabledTrue to enable the server, false to disable it.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ enableServerAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::enableServerAsync ( const ::std::string &  id,
bool  enabled,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Enable or disable a server.

A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.

Parameters
idThe server id.
enabledTrue to enable the server, false to disable it.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAdapterInfo()

AdapterInfoSeq IceGrid::AdminPrx::getAdapterInfo ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the adapter information for the replica group or adapter with the given id.

Parameters
idThe adapter id.
contextThe Context map to send with the invocation.
Returns
A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
Exceptions
IceGrid::AdapterNotExistExceptionRaised if the adapter or replica group doesn't exist.

◆ getAdapterInfoAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAdapterInfoAsync ( const ::std::string &  id,
::std::function< void(::IceGrid::AdapterInfoSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the adapter information for the replica group or adapter with the given id.

Parameters
idThe adapter id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAdapterInfoAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAdapterInfoAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::AdapterInfoSeq>>().get_future())
inline

Get the adapter information for the replica group or adapter with the given id.

Parameters
idThe adapter id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAllAdapterIds()

::Ice::StringSeq IceGrid::AdminPrx::getAllAdapterIds ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get all the adapter ids registered with IceGrid.

Parameters
contextThe Context map to send with the invocation.
Returns
The adapter ids.

◆ getAllAdapterIdsAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAllAdapterIdsAsync ( ::std::function< void(::Ice::StringSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get all the adapter ids registered with IceGrid.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAllAdapterIdsAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAllAdapterIdsAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::StringSeq>>().get_future())
inline

Get all the adapter ids registered with IceGrid.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAllApplicationNames()

::Ice::StringSeq IceGrid::AdminPrx::getAllApplicationNames ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get all the IceGrid applications currently registered.

Parameters
contextThe Context map to send with the invocation.
Returns
The application names.

◆ getAllApplicationNamesAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAllApplicationNamesAsync ( ::std::function< void(::Ice::StringSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get all the IceGrid applications currently registered.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAllApplicationNamesAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAllApplicationNamesAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::StringSeq>>().get_future())
inline

Get all the IceGrid applications currently registered.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAllNodeNames()

::Ice::StringSeq IceGrid::AdminPrx::getAllNodeNames ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get all the IceGrid nodes currently registered.

Parameters
contextThe Context map to send with the invocation.
Returns
The node names.

◆ getAllNodeNamesAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAllNodeNamesAsync ( ::std::function< void(::Ice::StringSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get all the IceGrid nodes currently registered.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAllNodeNamesAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAllNodeNamesAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::StringSeq>>().get_future())
inline

Get all the IceGrid nodes currently registered.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAllObjectInfos()

ObjectInfoSeq IceGrid::AdminPrx::getAllObjectInfos ( const ::std::string &  expr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the object info of all the registered objects whose stringified identities match the given expression.

Parameters
exprThe expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
contextThe Context map to send with the invocation.
Returns
All the object infos with a stringified identity matching the given expression.

◆ getAllObjectInfosAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAllObjectInfosAsync ( const ::std::string &  expr,
::std::function< void(::IceGrid::ObjectInfoSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the object info of all the registered objects whose stringified identities match the given expression.

Parameters
exprThe expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAllObjectInfosAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAllObjectInfosAsync ( const ::std::string &  expr,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::ObjectInfoSeq>>().get_future())
inline

Get the object info of all the registered objects whose stringified identities match the given expression.

Parameters
exprThe expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAllRegistryNames()

::Ice::StringSeq IceGrid::AdminPrx::getAllRegistryNames ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get all the IceGrid registries currently registered.

Parameters
contextThe Context map to send with the invocation.
Returns
The registry names.

◆ getAllRegistryNamesAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAllRegistryNamesAsync ( ::std::function< void(::Ice::StringSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get all the IceGrid registries currently registered.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAllRegistryNamesAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAllRegistryNamesAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::StringSeq>>().get_future())
inline

Get all the IceGrid registries currently registered.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getAllServerIds()

::Ice::StringSeq IceGrid::AdminPrx::getAllServerIds ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get all the server ids registered with IceGrid.

Parameters
contextThe Context map to send with the invocation.
Returns
The server ids.

◆ getAllServerIdsAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getAllServerIdsAsync ( ::std::function< void(::Ice::StringSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get all the server ids registered with IceGrid.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAllServerIdsAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getAllServerIdsAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::StringSeq>>().get_future())
inline

Get all the server ids registered with IceGrid.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getApplicationInfo()

ApplicationInfo IceGrid::AdminPrx::getApplicationInfo ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get an application descriptor.

Parameters
nameThe application name.
contextThe Context map to send with the invocation.
Returns
The application descriptor.
Exceptions
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ getApplicationInfoAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getApplicationInfoAsync ( const ::std::string &  name,
::std::function< void(::IceGrid::ApplicationInfo)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get an application descriptor.

Parameters
nameThe application name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getApplicationInfoAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getApplicationInfoAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::ApplicationInfo>>().get_future())
inline

Get an application descriptor.

Parameters
nameThe application name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getDefaultApplicationDescriptor()

ApplicationDescriptor IceGrid::AdminPrx::getDefaultApplicationDescriptor ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get the default application descriptor.

Parameters
contextThe Context map to send with the invocation.
Returns
The default application descriptor.
Exceptions
IceGrid::DeploymentExceptionRaised if the default application descriptor can't be accessed or is invalid.

◆ getDefaultApplicationDescriptorAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getDefaultApplicationDescriptorAsync ( ::std::function< void(::IceGrid::ApplicationDescriptor)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the default application descriptor.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getDefaultApplicationDescriptorAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getDefaultApplicationDescriptorAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::IceGrid::ApplicationDescriptor>>().get_future())
inline

Get the default application descriptor.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getNodeAdmin()

::std::shared_ptr<::Ice::ObjectPrx> IceGrid::AdminPrx::getNodeAdmin ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a proxy to the IceGrid node's admin object.

Parameters
nameThe IceGrid node name
contextThe Context map to send with the invocation.
Returns
A proxy to the IceGrid node's admin object
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeAdminAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getNodeAdminAsync ( const ::std::string &  name,
::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a proxy to the IceGrid node's admin object.

Parameters
nameThe IceGrid node name
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getNodeAdminAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getNodeAdminAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())
inline

Get a proxy to the IceGrid node's admin object.

Parameters
nameThe IceGrid node name
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getNodeHostname()

::std::string IceGrid::AdminPrx::getNodeHostname ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the hostname of this node.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The node hostname.
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeHostnameAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getNodeHostnameAsync ( const ::std::string &  name,
::std::function< void(::std::string)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the hostname of this node.

Parameters
nameThe node name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getNodeHostnameAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getNodeHostnameAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::std::string>>().get_future())
inline

Get the hostname of this node.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getNodeInfo()

NodeInfo IceGrid::AdminPrx::getNodeInfo ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the node information for the node with the given name.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The node information.
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeInfoAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getNodeInfoAsync ( const ::std::string &  name,
::std::function< void(::IceGrid::NodeInfo)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the node information for the node with the given name.

Parameters
nameThe node name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getNodeInfoAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getNodeInfoAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::NodeInfo>>().get_future())
inline

Get the node information for the node with the given name.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getNodeLoad()

LoadInfo IceGrid::AdminPrx::getNodeLoad ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the load averages of the node.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The node load information.
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeLoadAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getNodeLoadAsync ( const ::std::string &  name,
::std::function< void(::IceGrid::LoadInfo)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the load averages of the node.

Parameters
nameThe node name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getNodeLoadAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getNodeLoadAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::LoadInfo>>().get_future())
inline

Get the load averages of the node.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getNodeProcessorSocketCount()

int IceGrid::AdminPrx::getNodeProcessorSocketCount ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the number of physical processor sockets for the machine running the node with the given name.

Note that this method will return 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The number of processor sockets or 1 if the number of sockets can't determined.
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeProcessorSocketCountAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getNodeProcessorSocketCountAsync ( const ::std::string &  name,
::std::function< void(int)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the number of physical processor sockets for the machine running the node with the given name.

Note that this method will return 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.

Parameters
nameThe node name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getNodeProcessorSocketCountAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getNodeProcessorSocketCountAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<int>>().get_future())
inline

Get the number of physical processor sockets for the machine running the node with the given name.

Note that this method will return 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getObjectInfo()

ObjectInfo IceGrid::AdminPrx::getObjectInfo ( const ::Ice::Identity id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the object info for the object with the given identity.

Parameters
idThe identity of the object.
contextThe Context map to send with the invocation.
Returns
The object info.
Exceptions
IceGrid::ObjectNotRegisteredExceptionRaised if the object isn't registered with the registry.

◆ getObjectInfoAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getObjectInfoAsync ( const ::Ice::Identity id,
::std::function< void(::IceGrid::ObjectInfo)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the object info for the object with the given identity.

Parameters
idThe identity of the object.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getObjectInfoAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getObjectInfoAsync ( const ::Ice::Identity id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::ObjectInfo>>().get_future())
inline

Get the object info for the object with the given identity.

Parameters
idThe identity of the object.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getObjectInfosByType()

ObjectInfoSeq IceGrid::AdminPrx::getObjectInfosByType ( const ::std::string &  type,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the object info of all the registered objects with the given type.

Parameters
typeThe type of the object.
contextThe Context map to send with the invocation.
Returns
The object infos.

◆ getObjectInfosByTypeAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getObjectInfosByTypeAsync ( const ::std::string &  type,
::std::function< void(::IceGrid::ObjectInfoSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the object info of all the registered objects with the given type.

Parameters
typeThe type of the object.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getObjectInfosByTypeAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getObjectInfosByTypeAsync ( const ::std::string &  type,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::ObjectInfoSeq>>().get_future())
inline

Get the object info of all the registered objects with the given type.

Parameters
typeThe type of the object.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getRegistryAdmin()

::std::shared_ptr<::Ice::ObjectPrx> IceGrid::AdminPrx::getRegistryAdmin ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a proxy to the IceGrid registry's admin object.

Parameters
nameThe registry name
contextThe Context map to send with the invocation.
Returns
A proxy to the IceGrid registry's admin object
Exceptions
IceGrid::RegistryNotExistExceptionRaised if the registry doesn't exist.

◆ getRegistryAdminAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getRegistryAdminAsync ( const ::std::string &  name,
::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a proxy to the IceGrid registry's admin object.

Parameters
nameThe registry name
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getRegistryAdminAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getRegistryAdminAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())
inline

Get a proxy to the IceGrid registry's admin object.

Parameters
nameThe registry name
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getRegistryInfo()

RegistryInfo IceGrid::AdminPrx::getRegistryInfo ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the registry information for the registry with the given name.

Parameters
nameThe registry name.
contextThe Context map to send with the invocation.
Returns
The registry information.
Exceptions
IceGrid::RegistryNotExistExceptionRaised if the registry doesn't exist.
IceGrid::RegistryUnreachableExceptionRaised if the registry could not be reached.

◆ getRegistryInfoAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getRegistryInfoAsync ( const ::std::string &  name,
::std::function< void(::IceGrid::RegistryInfo)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the registry information for the registry with the given name.

Parameters
nameThe registry name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getRegistryInfoAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getRegistryInfoAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::RegistryInfo>>().get_future())
inline

Get the registry information for the registry with the given name.

Parameters
nameThe registry name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getServerAdmin()

::std::shared_ptr<::Ice::ObjectPrx> IceGrid::AdminPrx::getServerAdmin ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a proxy to the server's admin object.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
A proxy to the server's admin object
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ getServerAdminAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getServerAdminAsync ( const ::std::string &  id,
::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a proxy to the server's admin object.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getServerAdminAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getServerAdminAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())
inline

Get a proxy to the server's admin object.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getServerAdminCategory()

::std::string IceGrid::AdminPrx::getServerAdminCategory ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Get the category for server admin objects.

You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.

Parameters
contextThe Context map to send with the invocation.
Returns
The category for server admin objects.

◆ getServerAdminCategoryAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getServerAdminCategoryAsync ( ::std::function< void(::std::string)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the category for server admin objects.

You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getServerAdminCategoryAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getServerAdminCategoryAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::std::string>>().get_future())
inline

Get the category for server admin objects.

You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getServerInfo()

ServerInfo IceGrid::AdminPrx::getServerInfo ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the server information for the server with the given id.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The server information.
Exceptions
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ getServerInfoAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getServerInfoAsync ( const ::std::string &  id,
::std::function< void(::IceGrid::ServerInfo)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get the server information for the server with the given id.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getServerInfoAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getServerInfoAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::ServerInfo>>().get_future())
inline

Get the server information for the server with the given id.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getServerPid()

int IceGrid::AdminPrx::getServerPid ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a server's system process id.

The process id is operating system dependent.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The server's process id.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ getServerPidAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getServerPidAsync ( const ::std::string &  id,
::std::function< void(int)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a server's system process id.

The process id is operating system dependent.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getServerPidAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getServerPidAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<int>>().get_future())
inline

Get a server's system process id.

The process id is operating system dependent.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getServerState()

ServerState IceGrid::AdminPrx::getServerState ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a server's state.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The server state.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ getServerStateAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getServerStateAsync ( const ::std::string &  id,
::std::function< void(::IceGrid::ServerState)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Get a server's state.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getServerStateAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getServerStateAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<::IceGrid::ServerState>>().get_future())
inline

Get a server's state.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ getSliceChecksums()

::Ice::SliceChecksumDict IceGrid::AdminPrx::getSliceChecksums ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Returns the checksums for the IceGrid Slice definitions.

Parameters
contextThe Context map to send with the invocation.
Returns
A dictionary mapping Slice type ids to their checksums.

◆ getSliceChecksumsAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::getSliceChecksumsAsync ( ::std::function< void(::Ice::SliceChecksumDict)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Returns the checksums for the IceGrid Slice definitions.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getSliceChecksumsAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::getSliceChecksumsAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::SliceChecksumDict>>().get_future())
inline

Returns the checksums for the IceGrid Slice definitions.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceGrid::AdminPrx::ice_staticId ( )
static

Obtains the Slice type ID of this interface.

Returns
The fully-scoped type ID.

◆ instantiateServer()

void IceGrid::AdminPrx::instantiateServer ( const ::std::string &  application,
const ::std::string &  node,
const ServerInstanceDescriptor desc,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Instantiate a server template from an application on the given node.

Parameters
applicationThe application name.
nodeThe name of the node where the server will be deployed.
descThe descriptor of the server instance to deploy.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::DeploymentExceptionRaised if server instantiation failed.

◆ instantiateServerAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::instantiateServerAsync ( const ::std::string &  application,
const ::std::string &  node,
const ServerInstanceDescriptor desc,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Instantiate a server template from an application on the given node.

Parameters
applicationThe application name.
nodeThe name of the node where the server will be deployed.
descThe descriptor of the server instance to deploy.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ instantiateServerAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::instantiateServerAsync ( const ::std::string &  application,
const ::std::string &  node,
const ServerInstanceDescriptor desc,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Instantiate a server template from an application on the given node.

Parameters
applicationThe application name.
nodeThe name of the node where the server will be deployed.
descThe descriptor of the server instance to deploy.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ isServerEnabled()

bool IceGrid::AdminPrx::isServerEnabled ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Check if the server is enabled or disabled.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
True if the server is enabled.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ isServerEnabledAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::isServerEnabledAsync ( const ::std::string &  id,
::std::function< void(bool)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Check if the server is enabled or disabled.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ isServerEnabledAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::isServerEnabledAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<bool>>().get_future())
inline

Check if the server is enabled or disabled.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ patchApplication()

void IceGrid::AdminPrx::patchApplication ( const ::std::string &  name,
bool  shutdown,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Patch the given application data.

Parameters
nameThe application name.
shutdownIf true, the servers depending on the data to patch will be shut down if necessary.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::PatchExceptionRaised if the patch failed.

◆ patchApplicationAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::patchApplicationAsync ( const ::std::string &  name,
bool  shutdown,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Patch the given application data.

Parameters
nameThe application name.
shutdownIf true, the servers depending on the data to patch will be shut down if necessary.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ patchApplicationAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::patchApplicationAsync ( const ::std::string &  name,
bool  shutdown,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Patch the given application data.

Parameters
nameThe application name.
shutdownIf true, the servers depending on the data to patch will be shut down if necessary.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ patchServer()

void IceGrid::AdminPrx::patchServer ( const ::std::string &  id,
bool  shutdown,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Patch a server.

Parameters
idThe server id.
shutdownIf true, servers depending on the data to patch will be shut down if necessary.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::PatchExceptionRaised if the patch failed.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ patchServerAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::patchServerAsync ( const ::std::string &  id,
bool  shutdown,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Patch a server.

Parameters
idThe server id.
shutdownIf true, servers depending on the data to patch will be shut down if necessary.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ patchServerAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::patchServerAsync ( const ::std::string &  id,
bool  shutdown,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Patch a server.

Parameters
idThe server id.
shutdownIf true, servers depending on the data to patch will be shut down if necessary.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ pingNode()

bool IceGrid::AdminPrx::pingNode ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Ping an IceGrid node to see if it is active.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
true if the node ping succeeded, false otherwise.
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.

◆ pingNodeAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::pingNodeAsync ( const ::std::string &  name,
::std::function< void(bool)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Ping an IceGrid node to see if it is active.

Parameters
nameThe node name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ pingNodeAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::pingNodeAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<bool>>().get_future())
inline

Ping an IceGrid node to see if it is active.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ pingRegistry()

bool IceGrid::AdminPrx::pingRegistry ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Ping an IceGrid registry to see if it is active.

Parameters
nameThe registry name.
contextThe Context map to send with the invocation.
Returns
true if the registry ping succeeded, false otherwise.
Exceptions
IceGrid::RegistryNotExistExceptionRaised if the registry doesn't exist.

◆ pingRegistryAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::pingRegistryAsync ( const ::std::string &  name,
::std::function< void(bool)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Ping an IceGrid registry to see if it is active.

Parameters
nameThe registry name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ pingRegistryAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::pingRegistryAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<bool>>().get_future())
inline

Ping an IceGrid registry to see if it is active.

Parameters
nameThe registry name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ removeAdapter()

void IceGrid::AdminPrx::removeAdapter ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove the adapter with the given id.

Parameters
idThe adapter id.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AdapterNotExistExceptionRaised if the adapter doesn't exist.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ removeAdapterAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::removeAdapterAsync ( const ::std::string &  id,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove the adapter with the given id.

Parameters
idThe adapter id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ removeAdapterAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::removeAdapterAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Remove the adapter with the given id.

Parameters
idThe adapter id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ removeApplication()

void IceGrid::AdminPrx::removeApplication ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove an application from IceGrid.

Parameters
nameThe application name.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ removeApplicationAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::removeApplicationAsync ( const ::std::string &  name,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove an application from IceGrid.

Parameters
nameThe application name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ removeApplicationAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::removeApplicationAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Remove an application from IceGrid.

Parameters
nameThe application name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ removeObject()

void IceGrid::AdminPrx::removeObject ( const ::Ice::Identity id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove an object from the object registry.

Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.

Parameters
idThe identity of the object to be removed from the registry.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the object can't be removed. This might happen if the object was added with a deployment descriptor.
IceGrid::ObjectNotRegisteredExceptionRaised if the object isn't registered with the registry.

◆ removeObjectAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::removeObjectAsync ( const ::Ice::Identity id,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove an object from the object registry.

Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.

Parameters
idThe identity of the object to be removed from the registry.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ removeObjectAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::removeObjectAsync ( const ::Ice::Identity id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Remove an object from the object registry.

Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.

Parameters
idThe identity of the object to be removed from the registry.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ sendSignal()

void IceGrid::AdminPrx::sendSignal ( const ::std::string &  id,
const ::std::string &  signal,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Send signal to a server.

Parameters
idThe server id.
signalThe signal, for example SIGTERM or 15.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::BadSignalExceptionRaised if the signal is not recognized by the target server.
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.

◆ sendSignalAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::sendSignalAsync ( const ::std::string &  id,
const ::std::string &  signal,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Send signal to a server.

Parameters
idThe server id.
signalThe signal, for example SIGTERM or 15.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ sendSignalAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::sendSignalAsync ( const ::std::string &  id,
const ::std::string &  signal,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Send signal to a server.

Parameters
idThe server id.
signalThe signal, for example SIGTERM or 15.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ shutdown()

void IceGrid::AdminPrx::shutdown ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Shut down the IceGrid registry.

Parameters
contextThe Context map to send with the invocation.

◆ shutdownAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::shutdownAsync ( ::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Shut down the IceGrid registry.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ shutdownAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::shutdownAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<void>>().get_future())
inline

Shut down the IceGrid registry.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ shutdownNode()

void IceGrid::AdminPrx::shutdownNode ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Shutdown an IceGrid node.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::NodeNotExistExceptionRaised if the node doesn't exist.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.

◆ shutdownNodeAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::shutdownNodeAsync ( const ::std::string &  name,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Shutdown an IceGrid node.

Parameters
nameThe node name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ shutdownNodeAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::shutdownNodeAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Shutdown an IceGrid node.

Parameters
nameThe node name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ shutdownRegistry()

void IceGrid::AdminPrx::shutdownRegistry ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Shutdown an IceGrid registry.

Parameters
nameThe registry name.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::RegistryNotExistExceptionRaised if the registry doesn't exist.
IceGrid::RegistryUnreachableExceptionRaised if the registry could not be reached.

◆ shutdownRegistryAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::shutdownRegistryAsync ( const ::std::string &  name,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Shutdown an IceGrid registry.

Parameters
nameThe registry name.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ shutdownRegistryAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::shutdownRegistryAsync ( const ::std::string &  name,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Shutdown an IceGrid registry.

Parameters
nameThe registry name.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ startServer()

void IceGrid::AdminPrx::startServer ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Start a server and wait for its activation.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.
IceGrid::ServerStartExceptionRaised if the server couldn't be started.

◆ startServerAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::startServerAsync ( const ::std::string &  id,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Start a server and wait for its activation.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ startServerAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::startServerAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Start a server and wait for its activation.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ stopServer()

void IceGrid::AdminPrx::stopServer ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Stop a server.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableExceptionRaised if the node could not be reached.
IceGrid::ServerNotExistExceptionRaised if the server doesn't exist.
IceGrid::ServerStopExceptionRaised if the server couldn't be stopped.

◆ stopServerAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::stopServerAsync ( const ::std::string &  id,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Stop a server.

Parameters
idThe server id.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ stopServerAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::stopServerAsync ( const ::std::string &  id,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Stop a server.

Parameters
idThe server id.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ syncApplication()

void IceGrid::AdminPrx::syncApplication ( const ApplicationDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor.

Parameters
descriptorThe application descriptor.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ syncApplicationAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::syncApplicationAsync ( const ApplicationDescriptor descriptor,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor.

Parameters
descriptorThe application descriptor.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ syncApplicationAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::syncApplicationAsync ( const ApplicationDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor.

Parameters
descriptorThe application descriptor.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ syncApplicationWithoutRestart()

void IceGrid::AdminPrx::syncApplicationWithoutRestart ( const ApplicationDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters
descriptorThe application descriptor.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ syncApplicationWithoutRestartAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::syncApplicationWithoutRestartAsync ( const ApplicationDescriptor descriptor,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters
descriptorThe application descriptor.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ syncApplicationWithoutRestartAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::syncApplicationWithoutRestartAsync ( const ApplicationDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters
descriptorThe application descriptor.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ updateApplication()

void IceGrid::AdminPrx::updateApplication ( const ApplicationUpdateDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Update a deployed application with the given update application descriptor.

Parameters
descriptorThe update descriptor.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ updateApplicationAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::updateApplicationAsync ( const ApplicationUpdateDescriptor descriptor,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Update a deployed application with the given update application descriptor.

Parameters
descriptorThe update descriptor.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ updateApplicationAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::updateApplicationAsync ( const ApplicationUpdateDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Update a deployed application with the given update application descriptor.

Parameters
descriptorThe update descriptor.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ updateApplicationWithoutRestart()

void IceGrid::AdminPrx::updateApplicationWithoutRestart ( const ApplicationUpdateDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.

If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters
descriptorThe update descriptor.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistExceptionRaised if the application doesn't exist.
IceGrid::DeploymentExceptionRaised if application deployment failed.

◆ updateApplicationWithoutRestartAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::updateApplicationWithoutRestartAsync ( const ApplicationUpdateDescriptor descriptor,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.

If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters
descriptorThe update descriptor.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ updateApplicationWithoutRestartAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::updateApplicationWithoutRestartAsync ( const ApplicationUpdateDescriptor descriptor,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.

If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters
descriptorThe update descriptor.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ updateObject()

void IceGrid::AdminPrx::updateObject ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Update an object in the object registry.

Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.

Parameters
objThe object to be updated to the registry.
contextThe Context map to send with the invocation.
Exceptions
IceGrid::DeploymentExceptionRaised if the object can't be updated. This might happen if the object was added with a deployment descriptor.
IceGrid::ObjectNotRegisteredExceptionRaised if the object isn't registered with the registry.

◆ updateObjectAsync() [1/2]

::std::function<void()> IceGrid::AdminPrx::updateObjectAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Update an object in the object registry.

Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.

Parameters
objThe object to be updated to the registry.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ updateObjectAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::AdminPrx::updateObjectAsync ( const ::std::shared_ptr<::Ice::ObjectPrx > &  obj,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Update an object in the object registry.

Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.

Parameters
objThe object to be updated to the registry.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

The documentation for this class was generated from the following file: