IceBox::ServiceManagerPrx Class Reference

Administers a set of Service instances. More...

#include <IceBox/IceBox.h>

Inheritance diagram for IceBox::ServiceManagerPrx:

Collaboration diagram for IceBox::ServiceManagerPrx:

Public Member Functions
void	addObserver (const ::std::shared_ptr< ServiceObserverPrx > &observer, const ::Ice::Context &context=::Ice::noExplicitContext)
	Registers a new observer with the ServiceManager.
::std::function< void()>	addObserverAsync (const ::std::shared_ptr< ServiceObserverPrx > &observer, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Registers a new observer with the ServiceManager.
template<template< typename > class P = ::std::promise>
auto	addObserverAsync (const ::std::shared_ptr< ServiceObserverPrx > &observer, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Registers a new observer with the ServiceManager.
::Ice::SliceChecksumDict	getSliceChecksums (const ::Ice::Context &context=::Ice::noExplicitContext)
	Returns the checksums for the IceBox Slice definitions.
::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 IceBox Slice definitions.
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 IceBox Slice definitions.
void	shutdown (const ::Ice::Context &context=::Ice::noExplicitContext)
	Shut down all services.
::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 all services.
template<template< typename > class P = ::std::promise>
auto	shutdownAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Shut down all services.
void	startService (const ::std::string &service, const ::Ice::Context &context=::Ice::noExplicitContext)
	Start an individual service.
::std::function< void()>	startServiceAsync (const ::std::string &service, ::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 an individual service.
template<template< typename > class P = ::std::promise>
auto	startServiceAsync (const ::std::string &service, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Start an individual service.
void	stopService (const ::std::string &service, const ::Ice::Context &context=::Ice::noExplicitContext)
	Stop an individual service.
::std::function< void()>	stopServiceAsync (const ::std::string &service, ::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 an individual service.
template<template< typename > class P = ::std::promise>
auto	stopServiceAsync (const ::std::string &service, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Stop an individual service.
Public Member Functions inherited from Ice::Proxy< ServiceManagerPrx, ::Ice::ObjectPrx >
::std::shared_ptr< ServiceManagerPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID.
::std::shared_ptr< ServiceManagerPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations.
::std::shared_ptr< ServiceManagerPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations.
::std::shared_ptr< ServiceManagerPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization.
::std::shared_ptr< ServiceManagerPrx >	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.
::std::shared_ptr< ServiceManagerPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching.
::std::shared_ptr< ServiceManagerPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID.
::std::shared_ptr< ServiceManagerPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context.
::std::shared_ptr< ServiceManagerPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations.
::std::shared_ptr< ServiceManagerPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
::std::shared_ptr< ServiceManagerPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints.
::std::shared_ptr< ServiceManagerPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy.
::std::shared_ptr< ServiceManagerPrx >	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.
::std::shared_ptr< ServiceManagerPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout.
::std::shared_ptr< ServiceManagerPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator.
::std::shared_ptr< ServiceManagerPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout.
::std::shared_ptr< ServiceManagerPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations.
::std::shared_ptr< ServiceManagerPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy.
::std::shared_ptr< ServiceManagerPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router.
::std::shared_ptr< ServiceManagerPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints.
::std::shared_ptr< ServiceManagerPrx >	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.
::std::shared_ptr< ServiceManagerPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations.

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface.

Detailed Description

Administers a set of Service instances.

See also

Service

Member Function Documentation

addObserver()

void IceBox::ServiceManagerPrx::addObserver ( const ::std::shared_ptr< ServiceObserverPrx > & observer, const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Registers a new observer with the ServiceManager.

Parameters

observer	The new observer
context	The Context map to send with the invocation.

addObserverAsync() [1/2]

::std::function< void()> IceBox::ServiceManagerPrx::addObserverAsync ( const ::std::shared_ptr< ServiceObserverPrx > & observer, ::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

Registers a new observer with the ServiceManager.

Parameters

observer	The new observer
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

addObserverAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceBox::ServiceManagerPrx::addObserverAsync ( const ::std::shared_ptr< ServiceObserverPrx > & observer, const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

Registers a new observer with the ServiceManager.

Parameters

observer	The new observer
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

getSliceChecksums()

::Ice::SliceChecksumDict IceBox::ServiceManagerPrx::getSliceChecksums ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Returns the checksums for the IceBox Slice definitions.

Parameters

context

The Context map to send with the invocation.

Returns

A dictionary mapping Slice type ids to their checksums.

getSliceChecksumsAsync() [1/2]

::std::function< void()> IceBox::ServiceManagerPrx::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 IceBox Slice definitions.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The 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 IceBox::ServiceManagerPrx::getSliceChecksumsAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval< P<::Ice::SliceChecksumDict > >().get_future())

inline

Returns the checksums for the IceBox Slice definitions.

Parameters

context

The Context map to send with the invocation.

Returns

The future object for the invocation.

ice_staticId()

const ::std::string & IceBox::ServiceManagerPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns

The fully-scoped type ID.

shutdown()

void IceBox::ServiceManagerPrx::shutdown ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Shut down all services.

This causes stop to be invoked on all configured services.

Parameters

context

The Context map to send with the invocation.

shutdownAsync() [1/2]

::std::function< void()> IceBox::ServiceManagerPrx::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 all services.

This causes stop to be invoked on all configured services.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The 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 IceBox::ServiceManagerPrx::shutdownAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

Shut down all services.

This causes stop to be invoked on all configured services.

Parameters

context

The Context map to send with the invocation.

Returns

The future object for the invocation.

startService()

void IceBox::ServiceManagerPrx::startService ( const ::std::string & service, const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Start an individual service.

Parameters

service	The service name.
context	The Context map to send with the invocation.

Exceptions

IceBox::AlreadyStartedException	If the service is already running.
IceBox::NoSuchServiceException	If no service could be found with the given name.

startServiceAsync() [1/2]

::std::function< void()> IceBox::ServiceManagerPrx::startServiceAsync ( const ::std::string & service, ::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 an individual service.

Parameters

service	The service name.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

startServiceAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceBox::ServiceManagerPrx::startServiceAsync ( const ::std::string & service, const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

Start an individual service.

Parameters

service	The service name.
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

stopService()

void IceBox::ServiceManagerPrx::stopService ( const ::std::string & service, const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Stop an individual service.

Parameters

service	The service name.
context	The Context map to send with the invocation.

Exceptions

IceBox::AlreadyStoppedException	If the service is already stopped.
IceBox::NoSuchServiceException	If no service could be found with the given name.

stopServiceAsync() [1/2]

::std::function< void()> IceBox::ServiceManagerPrx::stopServiceAsync ( const ::std::string & service, ::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 an individual service.

Parameters

service	The service name.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

stopServiceAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceBox::ServiceManagerPrx::stopServiceAsync ( const ::std::string & service, const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

Stop an individual service.

Parameters

service	The service name.
context	The 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:

• generated/cpp11/x64/Release/IceBox/IceBox.h