An extension of Ice::Application that makes it easy to write Glacier2 applications. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::Application:

Collaboration diagram for Glacier2::Application:

[legend]

Public Member Functions
	Application (const Application &)=delete
	Application (Ice::SignalPolicy=Ice::SignalPolicy::HandleSignals)
	Initializes an instance that calls Ice::Communicator::shutdown if a signal is received.
virtual Glacier2::SessionPrxPtr	createSession ()=0
	Creates a new Glacier2 session.
Application &	operator= (const Application &)=delete
virtual int	runWithSession (int argc, char *argv[])=0
	Called once the communicator has been initialized and the Glacier2 session has been established.
virtual void	sessionDestroyed ()
	Called when the session refresh thread detects that the session has been destroyed.
Public Member Functions inherited from Ice::Application
	Application (SignalPolicy policy=SignalPolicy::HandleSignals)
	The constructor configures the signal handling behavior.
virtual void	interruptCallback (int signal)
	Override this method to provide a custom application interrupt hook.
int	main (const StringSeq &args, const InitializationData &initData=InitializationData(), int version=30711)
	Call this main() from the global main().
int	main (const StringSeq &args, const std::string &configFile, int version=30711)
	Call this main() from the global main().
int	main (int argc, const char *const argv[], const InitializationData &initData=InitializationData(), int version=30711)
	Call this main() from the global main().
int	main (int argc, const char *const argv[], const std::string &configFile, int version=30711)
	Call this main() from the global main().
virtual	~Application ()

Static Public Member Functions
static Ice::ObjectPrxPtr	addWithUUID (const Ice::ObjectPtr &servant)
	Adds a servant to the callback object adapter's Active Servant Map with a UUID.
static std::string	categoryForClient ()
	Returns the category to be used in the identities of all of the client's callback objects.
static Ice::Identity	createCallbackIdentity (const std::string &)
	Create a new Ice identity for callback objects with the given identity name field.
static Ice::ObjectAdapterPtr	objectAdapter ()
	Creates an object adapter for callback objects.
static void	restart ()
	Called to restart the application's Glacier2 session.
static Glacier2::RouterPrxPtr	router ()
	Returns the Glacier2 router proxy.
static Glacier2::SessionPrxPtr	session ()
	Returns the Glacier2 session proxy.
Static Public Member Functions inherited from Ice::Application
static const char *	appName ()
	Obtains the application name, i.e., argv[0].
static void	callbackOnInterrupt ()
	Configures the application to invoke interruptCallback when a signal occurs, thereby giving the subclass responsibility for handling the signal.
static CommunicatorPtr	communicator ()
	Obtains the application's Communicator instance.
static void	destroyOnInterrupt ()
	Configures the application to destroy the communicator when one of the monitored signals is raised.
static void	holdInterrupt ()
	Configures the application to ignore (but remember) a signal.
static void	ignoreInterrupt ()
	Configures the application to ignore signals.
static bool	interrupted ()
	Indicates whether a signal handler was triggered.
static void	releaseInterrupt ()
	Processes a stored signal (if any) using the current signal handling configuration.
static void	shutdownOnInterrupt ()
	Configures the application to shut down the communicator when one of the monitored signals is raised.

Protected Member Functions
virtual int	doMain (int argc, char *argv[], const Ice::InitializationData &initData, int version)
	Helper function that implements the application logic.

Additional Inherited Members
Static Protected Attributes inherited from Ice::Application
static Application *	_application
	The singleton instance.
static std::string	_appName
	The application's name.
static bool	_callbackInProgress
	True if a signal handling callback is currently executing.
static CommunicatorPtr	_communicator
	The application's communicator.
static IceUtil::Cond	_condVar
	Used to synchronize the main thread and the CtrlCHandler thread.
static bool	_destroyed
	True if the communicator has been destroyed.
static bool	_interrupted
	True if an interrupt signal was received.
static IceUtil::Mutex	_mutex
	Used to synchronize the main thread and the CtrlCHandler thread.
static SignalPolicy	_signalPolicy
	The signal-handling policy specified at construction.

Detailed Description

An extension of Ice::Application that makes it easy to write Glacier2 applications.

Applications must create a derived class that implements the createSession and runWithSession methods.

The base class invokes createSession to create a new Glacier2 session and then invokes runWithSession in which the subclass performs its application logic. The base class automatically destroys the session when runWithSession returns.

If runWithSession calls restart or raises any of the exceptions Ice::ConnectionRefusedException, Ice::ConnectionLostException, Ice::UnknownLocalException, Ice::RequestFailedException, or Ice::TimeoutException, the base class destroys the current session and restarts the application with another call to createSession followed by runWithSession.

The application can optionally override the sessionDestroyed callback method if it needs to take action when connectivity with the Glacier2 router is lost.

A program can contain only one instance of this class.

Constructor & Destructor Documentation

◆ Application() [1/2]

Glacier2::Application::Application ( Ice::SignalPolicy = Ice::SignalPolicy::HandleSignals )

Initializes an instance that calls Ice::Communicator::shutdown if a signal is received.

◆ Application() [2/2]

Glacier2::Application::Application ( const Application & )

delete

Member Function Documentation

◆ addWithUUID()

Ice::ObjectPrxPtr Glacier2::Application::addWithUUID ( const Ice::ObjectPtr & servant )

static

Adds a servant to the callback object adapter's Active Servant Map with a UUID.

Parameters

servant The servant to add.

Returns: The proxy for the servant.

◆ categoryForClient()

std::string Glacier2::Application::categoryForClient ( )

static

Returns the category to be used in the identities of all of the client's callback objects.

Clients must use this category for the router to forward callback requests to the intended client.

Returns: The category.

Exceptions

SessionNotExistException No session exists.

◆ createCallbackIdentity()

Ice::Identity Glacier2::Application::createCallbackIdentity ( const std::string & )

static

Create a new Ice identity for callback objects with the given identity name field.

Returns: The identity.

◆ createSession()

virtual Glacier2::SessionPrxPtr Glacier2::Application::createSession ( )

pure virtual

Creates a new Glacier2 session.

A call to createSession always precedes a call to runWithSession. If Ice::LocalException is thrown from this method, the application is terminated.

Returns: The Glacier2 session.

◆ doMain()

virtual int Glacier2::Application::doMain	(	int	argc,
		char *	argv[],
		const Ice::InitializationData &	initData,
		int	version )

protectedvirtual

Helper function that implements the application logic.

Reimplemented from Ice::Application.

◆ objectAdapter()

Ice::ObjectAdapterPtr Glacier2::Application::objectAdapter ( )

static

Creates an object adapter for callback objects.

Returns: The object adapter.

◆ operator=()

Application & Glacier2::Application::operator= ( const Application & )

delete

◆ restart()

void Glacier2::Application::restart ( )

static

Called to restart the application's Glacier2 session.

This method never returns. The exception produce an application restart when called from the Application main thread.

Exceptions

RestartSessionException This exception is always thrown.

◆ router()

Glacier2::RouterPrxPtr Glacier2::Application::router ( )

static

Returns the Glacier2 router proxy.

Returns: The router proxy.

◆ runWithSession()

virtual int Glacier2::Application::runWithSession	(	int	argc,
		char *	argv[] )

pure virtual

Called once the communicator has been initialized and the Glacier2 session has been established.

A derived class must implement runWithSession, which is the application's starting method.

Parameters

argc	The number of elements in argv.
argv	The argument vector for the application. `Application` scans the argument vector passed to `main` for options that are specific to the Ice run time and removes them; therefore, the vector passed to `run` is free from Ice-related options and contains only options and arguments that are application-specific.

Returns: The runWithSession method should return zero for successful termination, and non-zero otherwise. Application.main returns the value returned by runWithSession.

◆ session()

Glacier2::SessionPrxPtr Glacier2::Application::session ( )

static

Returns the Glacier2 session proxy.

Returns: The session proxy.

◆ sessionDestroyed()

virtual void Glacier2::Application::sessionDestroyed ( )

virtual

Called when the session refresh thread detects that the session has been destroyed.

A subclass can override this method to take action after the loss of connectivity with the Glacier2 router. This method is called according to the Ice invocation dipsatch rules (in other words, it uses the same rules as an servant upcall or AMI callback).

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

Glacier2/Application.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Application() [1/2]

◆ Application() [2/2]

Member Function Documentation

◆ addWithUUID()

◆ categoryForClient()

◆ createCallbackIdentity()

◆ createSession()

◆ doMain()

◆ objectAdapter()

◆ operator=()

◆ restart()

◆ router()

◆ runWithSession()

◆ session()

◆ sessionDestroyed()