The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCFRemote::AbstractDistributedApplication Class Reference

Class AbstractDistributedApplication documentation. More...

#include <AbstractDistributedApplication.h>

Inheritance diagram for VCFRemote::AbstractDistributedApplication:

List of all members.

Public Member Functions
virtual	~AbstractDistributedApplication ()
virtual bool	initApplication ()
	Allows you to initialize your application's data.
virtual bool	notifyDistributedClassServer (const bool &startup)
	notifies the Distributed Class Server we are starting up or shutting down, depending on the value of startup
virtual void	processCommandLine (std::vector< VCF::String > &commandLine)
	processes the command line.
virtual void	processCommandLineArgument (const VCF::String arg)
	processes a command line argument.
virtual VCF::Enumerator< VCF::Object * > *	getInstantiatedObjects ()
virtual void	terminateAppplication ()
	this is where the app terminates.
virtual bool	registerClasses ()
	register all classes with the Distributed CLass Server here
virtual bool	unRegisterClasses ()
	unregister all classes with the Distributed CLass Server here
virtual VCF::String	getUsageString ()
virtual void	runDistributedApp ()
	the apps main execution point.
virtual void	onDataReceived (VCFNet::SocketEvent *event)
virtual void	onClientConnected (VCFNet::SocketEvent *event)
virtual void	onClientDisconnected (VCFNet::SocketEvent *event)
Protected Member Functions
	AbstractDistributedApplication ()
	protected constructor to prevent instantiation outside of a deriving class
Protected Attributes
VCFNet::Socket	sock_
AppInfo *	appInfo_
std::map< int, VCF::Object * >	instObjectList_
std::map< VCF::String, int >	unMarshalledArgTypes_
VCF::EnumeratorMapContainer< std::map< int, VCF::Object * >, VCF::Object * >	instObjectContainer_
Classes
class	DistributedAppListener

---

Detailed Description

Class AbstractDistributedApplication documentation.

---

Constructor & Destructor Documentation

virtual VCFRemote::AbstractDistributedApplication::~AbstractDistributedApplication (   )  [virtual]

VCFRemote::AbstractDistributedApplication::AbstractDistributedApplication (   )  [protected]

protected constructor to prevent instantiation outside of a deriving class

---

Member Function Documentation

virtual VCF::Enumerator<VCF::Object*>* VCFRemote::AbstractDistributedApplication::getInstantiatedObjects (   )  [virtual]

Implements VCFRemote::DistributedApplication.

virtual VCF::String VCFRemote::AbstractDistributedApplication::getUsageString (   )  [virtual]

Implements VCFRemote::DistributedApplication.

virtual bool VCFRemote::AbstractDistributedApplication::initApplication (   )  [virtual]

Allows you to initialize your application's data. This gets called after the processCommandLine Returns: bool return false to indicate the initialization routines failed - the app will then attempt to close down nicely by calling terminateAppplication(), and then exiting. Implements VCFRemote::DistributedApplication.

virtual bool VCFRemote::AbstractDistributedApplication::notifyDistributedClassServer (  const bool &  startup  )  [virtual]

notifies the Distributed Class Server we are starting up or shutting down, depending on the value of startup Parameters: bool  startup - true, we are starting up, false, we are shutting down Implements VCFRemote::DistributedApplication.

virtual void VCFRemote::AbstractDistributedApplication::onClientConnected (  VCFNet::SocketEvent *  event  )  [virtual]

virtual void VCFRemote::AbstractDistributedApplication::onClientDisconnected (  VCFNet::SocketEvent *  event  )  [virtual]

virtual void VCFRemote::AbstractDistributedApplication::onDataReceived (  VCFNet::SocketEvent *  event  )  [virtual]

virtual void VCFRemote::AbstractDistributedApplication::processCommandLine (  std::vector< VCF::String > &  commandLine  )  [virtual]

processes the command line. calls processCommandLineArgument() for each arument in the commandLine Implements VCFRemote::DistributedApplication.

virtual void VCFRemote::AbstractDistributedApplication::processCommandLineArgument (  const VCF::String  arg  )  [virtual]

processes a command line argument. The default implementation searches for the presence of -register or -unregister in the arg and calls the registerClasses() or unRegisterClasses() accordingly.

virtual bool VCFRemote::AbstractDistributedApplication::registerClasses (   )  [virtual]

register all classes with the Distributed CLass Server here Implements VCFRemote::DistributedApplication.

virtual void VCFRemote::AbstractDistributedApplication::runDistributedApp (   )  [virtual]

the apps main execution point. Any code you would have put in your main(...) function, you should put in here Implements VCFRemote::DistributedApplication.

virtual void VCFRemote::AbstractDistributedApplication::terminateAppplication (   )  [virtual]

this is where the app terminates. Do pre-destructor clean up here Implements VCFRemote::DistributedApplication.

virtual bool VCFRemote::AbstractDistributedApplication::unRegisterClasses (   )  [virtual]

unregister all classes with the Distributed CLass Server here Implements VCFRemote::DistributedApplication.

---

Member Data Documentation

AppInfo* VCFRemote::AbstractDistributedApplication::appInfo_ [protected]

VCF::EnumeratorMapContainer<std::map<int,VCF::Object*>,VCF::Object*> VCFRemote::AbstractDistributedApplication::instObjectContainer_ [protected]

std::map<int,VCF::Object*> VCFRemote::AbstractDistributedApplication::instObjectList_ [protected]

VCFNet::Socket VCFRemote::AbstractDistributedApplication::sock_ [protected]

std::map<VCF::String,int> VCFRemote::AbstractDistributedApplication::unMarshalledArgTypes_ [protected]

---

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

• vcf/RemoteObjectKit/AbstractDistributedApplication.h

Comments or Suggestions?    License Information