ERC CISST - cisst software

mtsProxyBaseCommon< _proxyOwner > Class Template Reference

Inheritance diagram for mtsProxyBaseCommon< _proxyOwner >:

Inheritance graph
[legend]
Collaboration diagram for mtsProxyBaseCommon< _proxyOwner >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class _proxyOwner>
class mtsProxyBaseCommon< _proxyOwner >

Definition at line 62 of file mtsProxyBaseCommon.h.

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Classes


Member Enumeration Documentation

template<class _proxyOwner>
enum mtsProxyBaseCommon::ProxyType

Typedef for proxy type.

Definition at line 66 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
enum mtsProxyBaseCommon::ProxyStateType

The proxy status definition. This definition is adopted from mtsTask.h with slight modification.

PROXY_CONSTRUCTED -- Set by mtsProxyBaseCommon constructor. Initial state. PROXY_INITIALIZING -- Set by either mtsProxyBaseServer::IceInitialize() or mtsProxyBaseClient::IceInitialize(). This state means a proxy object is created but not yet successfully initialized. PROXY_READY -- Set by either mtsProxyBaseServer::IceInitialize() or mtsProxyBaseClient::IceInitialize(). This state represents that a proxy object is successfully initialized and is ready to run. PROXY_ACTIVE -- Set by either mtsProxyBaseServer::SetAsActiveProxy() or mtsProxyBaseClient::SetAsActiveProxy(). If a proxy is in this state, it is running and can process events. PROXY_FINISHING -- Set by either mtsProxyBaseServer::Stop() or mtsProxyBaseClient::Stop() before trying to stop ICE proxy processing. PROXY_FINISHED -- Set by either mtsProxyBaseServer::Stop() or mtsProxyBaseClient::Stop() after successful clean-up.

Definition at line 91 of file mtsProxyBaseCommon.h.


Constructor & Destructor Documentation

template<class _proxyOwner>
mtsProxyBaseCommon< _proxyOwner >::mtsProxyBaseCommon ( const std::string &  propertyFileName,
const ProxyType proxyType 
) [inline]

Constructor

Definition at line 298 of file mtsProxyBaseCommon.h.


Member Function Documentation

template<class _proxyOwner>
void mtsProxyBaseCommon< _proxyOwner >::SetAsActiveProxy ( void   )  [inline, protected]

Change the proxy state as active.

Definition at line 117 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
void mtsProxyBaseCommon< _proxyOwner >::ChangeProxyState ( const enum ProxyStateType  newProxyState  )  [inline, protected]

Helper function to change the proxy state in a thread-safe manner

Definition at line 232 of file mtsProxyBaseCommon.h.

Referenced by mtsProxyBaseServer< mtsComponentProxy, mtsComponentInterfaceProxy::ComponentInterfaceClientPrx, unsigned int >::IceInitialize(), mtsProxyBaseClient< mtsManagerLocal >::IceInitialize(), and mtsProxyBaseServer< mtsComponentProxy, mtsComponentInterfaceProxy::ComponentInterfaceClientPrx, unsigned int >::Stop().

template<class _proxyOwner>
virtual void mtsProxyBaseCommon< _proxyOwner >::IceInitialize ( void   )  [inline, protected, virtual]

Initialize Ice module.

Definition at line 258 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
virtual void mtsProxyBaseCommon< _proxyOwner >::IceCleanup ( void   )  [inline, protected, virtual]

Ice module clean up

Definition at line 278 of file mtsProxyBaseCommon.h.

Referenced by mtsProxyBaseClient< mtsManagerLocal >::Stop().

template<class _proxyOwner>
std::string mtsProxyBaseCommon< _proxyOwner >::GetGUID (  )  [inline, protected]

Return the global unique id of this object. Currently, IceUtil::generateUUID() is used to set the id which is guaranteed to be unique across networks by ICE. We can also use a combination of IP address (or MAC address), process id, and object id (or a pointer to this object) as the GUID.

Definition at line 289 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
virtual bool mtsProxyBaseCommon< _proxyOwner >::Start ( _proxyOwner *  proxyOwner  )  [pure virtual]

Initialize and start the proxy (returns immediately).

template<class _proxyOwner>
void mtsProxyBaseCommon< _proxyOwner >::Deactivate ( void   )  [inline]

Deactivate this proxy

Definition at line 318 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
virtual void mtsProxyBaseCommon< _proxyOwner >::Stop (  )  [pure virtual]

Terminate the proxy.

template<class _proxyOwner>
virtual void mtsProxyBaseCommon< _proxyOwner >::SetProxyOwner ( _proxyOwner *  proxyOwner,
const std::string &  suffix = "" 
) [inline, virtual]

Set proxy owner and this proxy's name

Definition at line 326 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
bool mtsProxyBaseCommon< _proxyOwner >::IsActiveProxy ( void   )  const [inline]

Check if this proxy is active

Definition at line 340 of file mtsProxyBaseCommon.h.

Referenced by mtsManagerProxyServer::ManagerServerI::IsActiveProxy().

template<class _proxyOwner>
std::string mtsProxyBaseCommon< _proxyOwner >::GetProxyName (  )  const [inline]

Get the name of this proxy

Definition at line 345 of file mtsProxyBaseCommon.h.


Member Data Documentation

template<class _proxyOwner>
_proxyOwner* mtsProxyBaseCommon< _proxyOwner >::ProxyOwner [protected]

Proxy owner

Definition at line 102 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
ProxyType mtsProxyBaseCommon< _proxyOwner >::ProxyTypeMember [protected]

Proxy type: PROXY_SERVER or PROXY_CLIENT

Definition at line 105 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
std::string mtsProxyBaseCommon< _proxyOwner >::ProxyName [protected]

Proxy Name. Internally set as the name of this proxy owner's

Definition at line 108 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
ProxyStateType mtsProxyBaseCommon< _proxyOwner >::ProxyState [protected]

Proxy state

Definition at line 114 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
osaMutex mtsProxyBaseCommon< _proxyOwner >::StateChange [protected]

Mutex to change proxy state

Definition at line 219 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
bool mtsProxyBaseCommon< _proxyOwner >::InitSuccessFlag [protected]

The flag which is true if a proxy is properly initialized

Definition at line 222 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
osaThread mtsProxyBaseCommon< _proxyOwner >::WorkerThread [protected]

The worker thread that actually runs a proxy.

Definition at line 225 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
ProxyWorker<_proxyOwner> mtsProxyBaseCommon< _proxyOwner >::ProxyWorkerInfo [protected]

The arguments container used for thread creation

Definition at line 228 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
std::string mtsProxyBaseCommon< _proxyOwner >::IcePropertyFileName [protected]

The name of a property file that configures proxy connection settings.

Definition at line 243 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
Ice::InitializationData mtsProxyBaseCommon< _proxyOwner >::IceInitData [protected]

Ice initialization data

Definition at line 246 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
Ice::CommunicatorPtr mtsProxyBaseCommon< _proxyOwner >::IceCommunicator [protected]

The proxy communicator.

Definition at line 249 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
Ice::LoggerPtr mtsProxyBaseCommon< _proxyOwner >::IceLogger [protected]

The Ice default logger.

Definition at line 252 of file mtsProxyBaseCommon.h.

template<class _proxyOwner>
std::string mtsProxyBaseCommon< _proxyOwner >::IceGUID [protected]

The global unique id of this Ice object.

Definition at line 255 of file mtsProxyBaseCommon.h.


The documentation for this class was generated from the following file:
erc-cisst-devel<at>lists.johnshopkins.edu