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

This interface allows applications to monitor IceGrid well-known objects. More...

#include <IceGrid/IceGrid.h>

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

Public Member Functions

void objectAdded (const ObjectInfo &info, const ::Ice::Context &context=::Ice::noExplicitContext)
 The objectAdded operation is called to notify an observer when an object was added to the Admin interface. More...
 
::std::function< void()> objectAddedAsync (const ObjectInfo &info, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 The objectAdded operation is called to notify an observer when an object was added to the Admin interface. More...
 
template<template< typename > class P = ::std::promise>
auto objectAddedAsync (const ObjectInfo &info, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 The objectAdded operation is called to notify an observer when an object was added to the Admin interface. More...
 
void objectInit (const ObjectInfoSeq &objects, const ::Ice::Context &context=::Ice::noExplicitContext)
 objectInit is called after the registration of an observer to indicate the state of the registry. More...
 
::std::function< void()> objectInitAsync (const ObjectInfoSeq &objects, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 objectInit is called after the registration of an observer to indicate the state of the registry. More...
 
template<template< typename > class P = ::std::promise>
auto objectInitAsync (const ObjectInfoSeq &objects, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 objectInit is called after the registration of an observer to indicate the state of the registry. More...
 
void objectRemoved (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext)
 objectRemoved is called to notify an observer when an object registered with the Admin interface was removed. More...
 
::std::function< void()> objectRemovedAsync (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)
 objectRemoved is called to notify an observer when an object registered with the Admin interface was removed. More...
 
template<template< typename > class P = ::std::promise>
auto objectRemovedAsync (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 objectRemoved is called to notify an observer when an object registered with the Admin interface was removed. More...
 
void objectUpdated (const ObjectInfo &info, const ::Ice::Context &context=::Ice::noExplicitContext)
 objectUpdated is called to notify an observer when an object registered with the Admin interface was updated. More...
 
::std::function< void()> objectUpdatedAsync (const ObjectInfo &info, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 objectUpdated is called to notify an observer when an object registered with the Admin interface was updated. More...
 
template<template< typename > class P = ::std::promise>
auto objectUpdatedAsync (const ObjectInfo &info, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 objectUpdated is called to notify an observer when an object registered with the Admin interface was updated. More...
 
- Public Member Functions inherited from Ice::Proxy< ObjectObserverPrx, ::Ice::ObjectPrx >
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > ice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< ObjectObserverPrx > ice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< ObjectObserverPrx > ice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > ice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > 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< ObjectObserverPrx > ice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > 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< ObjectObserverPrx > ice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > ice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< ObjectObserverPrx > ice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< ObjectObserverPrx > ice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > ice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< ObjectObserverPrx > 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< ObjectObserverPrx > 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

This interface allows applications to monitor IceGrid well-known objects.

Member Function Documentation

◆ ice_staticId()

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

Obtains the Slice type ID of this interface.

Returns
The fully-scoped type ID.

◆ objectAdded()

void IceGrid::ObjectObserverPrx::objectAdded ( const ObjectInfo info,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

The objectAdded operation is called to notify an observer when an object was added to the Admin interface.

Parameters
infoThe details of the added object.
contextThe Context map to send with the invocation.

◆ objectAddedAsync() [1/2]

::std::function<void()> IceGrid::ObjectObserverPrx::objectAddedAsync ( const ObjectInfo info,
::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

The objectAdded operation is called to notify an observer when an object was added to the Admin interface.

Parameters
infoThe details of the added 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.

◆ objectAddedAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::ObjectObserverPrx::objectAddedAsync ( const ObjectInfo info,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

The objectAdded operation is called to notify an observer when an object was added to the Admin interface.

Parameters
infoThe details of the added object.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ objectInit()

void IceGrid::ObjectObserverPrx::objectInit ( const ObjectInfoSeq objects,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

objectInit is called after the registration of an observer to indicate the state of the registry.

Parameters
objectsThe objects registered with the Admin interface (not through the deployment mechanism).
contextThe Context map to send with the invocation.

◆ objectInitAsync() [1/2]

::std::function<void()> IceGrid::ObjectObserverPrx::objectInitAsync ( const ObjectInfoSeq objects,
::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

objectInit is called after the registration of an observer to indicate the state of the registry.

Parameters
objectsThe objects registered with the Admin interface (not through the deployment mechanism).
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.

◆ objectInitAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::ObjectObserverPrx::objectInitAsync ( const ObjectInfoSeq objects,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

objectInit is called after the registration of an observer to indicate the state of the registry.

Parameters
objectsThe objects registered with the Admin interface (not through the deployment mechanism).
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ objectRemoved()

void IceGrid::ObjectObserverPrx::objectRemoved ( const ::Ice::Identity id,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

objectRemoved is called to notify an observer when an object registered with the Admin interface was removed.

Parameters
idThe identity of the removed object.
contextThe Context map to send with the invocation.

◆ objectRemovedAsync() [1/2]

::std::function<void()> IceGrid::ObjectObserverPrx::objectRemovedAsync ( 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

objectRemoved is called to notify an observer when an object registered with the Admin interface was removed.

Parameters
idThe identity of the removed 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.

◆ objectRemovedAsync() [2/2]

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

objectRemoved is called to notify an observer when an object registered with the Admin interface was removed.

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

◆ objectUpdated()

void IceGrid::ObjectObserverPrx::objectUpdated ( const ObjectInfo info,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

objectUpdated is called to notify an observer when an object registered with the Admin interface was updated.

Parameters
infoThe details of the updated object.
contextThe Context map to send with the invocation.

◆ objectUpdatedAsync() [1/2]

::std::function<void()> IceGrid::ObjectObserverPrx::objectUpdatedAsync ( const ObjectInfo info,
::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

objectUpdated is called to notify an observer when an object registered with the Admin interface was updated.

Parameters
infoThe details of the updated 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.

◆ objectUpdatedAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto IceGrid::ObjectObserverPrx::objectUpdatedAsync ( const ObjectInfo info,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

objectUpdated is called to notify an observer when an object registered with the Admin interface was updated.

Parameters
infoThe details of the updated object.
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: