IceBox::ServiceManager Class Reference

Administers a set of Service instances. More...

#include <IceBox/IceBox.h>

Inheritance diagram for IceBox::ServiceManager:

Collaboration diagram for IceBox::ServiceManager:

Public Types
using	ProxyType = ServiceManagerPrx

Public Member Functions
virtual void	addObserver (::std::shared_ptr< ServiceObserverPrx > observer, const ::Ice::Current &current)=0
	Registers a new observer with the ServiceManager.
virtual::Ice::SliceChecksumDict	getSliceChecksums (const ::Ice::Current &current) const =0
	Returns the checksums for the IceBox Slice definitions.
virtual::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (::std::string id, const ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID.
virtual void	shutdown (const ::Ice::Current &current)=0
	Shut down all services.
virtual void	startService (::std::string service, const ::Ice::Current &current)=0
	Start an individual service.
virtual void	stopService (::std::string service, const ::Ice::Current &current)=0
	Stop an individual service.
Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant.
virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface.
virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached.
virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type.

Detailed Description

Administers a set of Service instances.

See also

Service

Member Typedef Documentation

ProxyType

using IceBox::ServiceManager::ProxyType = ServiceManagerPrx

Member Function Documentation

addObserver()

virtual void IceBox::ServiceManager::addObserver ( ::std::shared_ptr< ServiceObserverPrx > observer, const ::Ice::Current & current )

pure virtual

Registers a new observer with the ServiceManager.

Parameters

observer	The new observer
current	The Current object for the invocation.

getSliceChecksums()

virtual::Ice::SliceChecksumDict IceBox::ServiceManager::getSliceChecksums ( const ::Ice::Current & current ) const

pure virtual

Returns the checksums for the IceBox Slice definitions.

Parameters

current

The Current object for the invocation.

Returns

A dictionary mapping Slice type ids to their checksums.

ice_id()

virtual::std::string IceBox::ServiceManager::ice_id ( const ::Ice::Current & current ) const

override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current

The Current object for the invocation.

Returns

A fully-scoped type ID.

ice_ids()

virtual ::std::vector<::std::string > IceBox::ServiceManager::ice_ids ( const ::Ice::Current & current ) const

override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current

The Current object for the invocation.

Returns

A list of fully-scoped type IDs.

ice_isA()

virtual bool IceBox::ServiceManager::ice_isA ( ::std::string id, const ::Ice::Current & current ) const

overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns

True if this object supports the interface, false, otherwise.

ice_staticId()

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

static

Obtains the Slice type ID corresponding to this class.

Returns

A fully-scoped type ID.

shutdown()

virtual void IceBox::ServiceManager::shutdown ( const ::Ice::Current & current )

pure virtual

Shut down all services.

This causes stop to be invoked on all configured services.

Parameters

current

The Current object for the invocation.

startService()

virtual void IceBox::ServiceManager::startService ( ::std::string service, const ::Ice::Current & current )

pure virtual

Start an individual service.

Parameters

service	The service name.
current	The Current object for the invocation.

Exceptions

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

stopService()

virtual void IceBox::ServiceManager::stopService ( ::std::string service, const ::Ice::Current & current )

pure virtual

Stop an individual service.

Parameters

service	The service name.
current	The Current object for the invocation.

Exceptions

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

---

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

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