ERC CISST - cisst software

mtsManagerProxyServer Class Reference

Inheritance diagram for mtsManagerProxyServer:

[legend]Collaboration diagram for mtsManagerProxyServer:

[legend]List of all members.

Detailed Description

Definition at line 32 of file mtsManagerProxyServer.h.

Public Member Functions

mtsManagerProxyServer (const std::string &adapterName, const std::string &communicatorID)
bool Start (mtsManagerGlobal *owner)
void Stop ()
void ConstructConnectionStringSet (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName,::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool CreateComponentProxy (const std::string &componentProxyName, const std::string &listenerID="")
bool RemoveComponentProxy (const std::string &componentProxyName, const std::string &listenerID="")
bool CreateInterfaceProvidedProxy (const std::string &serverComponentProxyName, const InterfaceProvidedDescription &providedInterfaceDescription, const std::string &listenerID="")
bool CreateInterfaceRequiredProxy (const std::string &clientComponentProxyName, const InterfaceRequiredDescription &requiredInterfaceDescription, const std::string &listenerID="")
bool RemoveInterfaceProvidedProxy (const std::string &clientComponentProxyName, const std::string &providedInterfaceProxyName, const std::string &listenerID="")
bool RemoveInterfaceRequiredProxy (const std::string &serverComponentProxyName, const std::string &requiredInterfaceProxyName, const std::string &listenerID="")
bool ConnectServerSideInterface (const unsigned int connectionID, const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName, const std::string &listenerID="")
bool ConnectClientSideInterface (const unsigned int connectionID, const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName, const std::string &listenerID="")
bool GetInterfaceProvidedDescription (const std::string &serverComponentName, const std::string &providedInterfaceName, InterfaceProvidedDescription &providedInterfaceDescription, const std::string &listenerID="")
bool GetInterfaceRequiredDescription (const std::string &componentName, const std::string &requiredInterfaceName, InterfaceRequiredDescription &requiredInterfaceDescription, const std::string &listenerID="")
const std::string GetProcessName (const std::string &listenerID="") const
void GetNamesOfCommands (std::vector< std::string > &namesOfCommands, const std::string &componentName, const std::string &providedInterfaceName, const std::string &listenerID="")
void GetNamesOfEventGenerators (std::vector< std::string > &namesOfEventGenerators, const std::string &componentName, const std::string &providedInterfaceName, const std::string &listenerID="")
void GetNamesOfFunctions (std::vector< std::string > &namesOfFunctions, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &listenerID="")
void GetNamesOfEventHandlers (std::vector< std::string > &namesOfEventHandlers, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &listenerID="")
void GetDescriptionOfCommand (std::string &description, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const std::string &listenerID="")
void GetDescriptionOfEventGenerator (std::string &description, const std::string &componentName, const std::string &providedInterfaceName, const std::string &eventGeneratorName, const std::string &listenerID="")
void GetDescriptionOfFunction (std::string &description, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &functionName, const std::string &listenerID="")
void GetDescriptionOfEventHandler (std::string &description, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &eventHandlerName, const std::string &listenerID="")
void GetArgumentInformation (std::string &argumentName, std::vector< std::string > &signalNames, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const std::string &listenerID="")
void GetValuesOfCommand (SetOfValues &values, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const int scalarIndex, const std::string &listenerID="")
int GetTotalNumberOfInterfaces (const std::string &componentName, const std::string &listenerID="")
void SendTestMessageFromServerToClient (const std::string &str)
bool SendCreateComponentProxy (const std::string &componentProxyName, const std::string &clientID)
bool SendRemoveComponentProxy (const std::string &componentProxyName, const std::string &clientID)
bool SendCreateInterfaceProvidedProxy (const std::string &serverComponentProxyName, const::mtsManagerProxy::InterfaceProvidedDescription &providedInterfaceDescription, const std::string &clientID)
bool SendCreateInterfaceRequiredProxy (const std::string &clientComponentProxyName, const::mtsManagerProxy::InterfaceRequiredDescription &requiredInterfaceDescription, const std::string &clientID)
bool SendRemoveInterfaceProvidedProxy (const std::string &clientComponentProxyName, const std::string &providedInterfaceProxyName, const std::string &clientID)
bool SendRemoveInterfaceRequiredProxy (const std::string &serverComponentProxyName, const std::string &requiredInterfaceProxyName, const std::string &clientID)
bool SendConnectServerSideInterface (const unsigned int connectionID, const::mtsManagerProxy::ConnectionStringSet &connectionStrings, const std::string &clientID)
bool SendConnectClientSideInterface (::Ice::Int connectionID, const ::mtsManagerProxy::ConnectionStringSet &connectionStrings, const std::string &clientID)
bool SendGetInterfaceProvidedDescription (const std::string &serverComponentName, const std::string &providedInterfaceName,::mtsManagerProxy::InterfaceProvidedDescription &providedInterfaceDescription, const std::string &clientID)
bool SendGetInterfaceRequiredDescription (const std::string &componentName, const std::string &requiredInterfaceName,::mtsManagerProxy::InterfaceRequiredDescription &requiredInterfaceDescription, const std::string &clientID)
void SendGetNamesOfCommands (std::vector< std::string > &namesOfCommands, const std::string &componentName, const std::string &providedInterfaceName, const std::string &clientID)
void SendGetNamesOfEventGenerators (std::vector< std::string > &namesOfEventGenerators, const std::string &componentName, const std::string &providedInterfaceName, const std::string &clientID)
void SendGetNamesOfFunctions (std::vector< std::string > &namesOfFunctions, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &clientID)
void SendGetNamesOfEventHandlers (std::vector< std::string > &namesOfEventHandlers, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &clientID)
void SendGetDescriptionOfCommand (std::string &description, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const std::string &clientID)
void SendGetDescriptionOfEventGenerator (std::string &description, const std::string &componentName, const std::string &providedInterfaceName, const std::string &eventGeneratorName, const std::string &clientID)
void SendGetDescriptionOfFunction (std::string &description, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &functionName, const std::string &clientID)
void SendGetDescriptionOfEventHandler (std::string &description, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &eventHandlerName, const std::string &clientID)
void SendGetArgumentInformation (std::string &argumentName, std::vector< std::string > &signalNames, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const std::string &clientID)
void SendGetValuesOfCommand (SetOfValues &values, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const int scalarIndex, const std::string &clientID)
std::string SendGetProcessName (const std::string &clientID)
::Ice::Int SendGetCurrentInterfaceCount (const std::string &componentName, const std::string &clientID)

Static Public Member Functions

static void ConvertInterfaceProvidedDescription (const::mtsManagerProxy::InterfaceProvidedDescription &src, InterfaceProvidedDescription &dest)
static void ConvertInterfaceRequiredDescription (const::mtsManagerProxy::InterfaceRequiredDescription &src, InterfaceRequiredDescription &dest)
static void ConvertValuesOfCommand (const::mtsManagerProxy::SetOfValues &src, mtsManagerLocalInterface::SetOfValues &dest)
static void ConstructInterfaceProvidedDescriptionFrom (const InterfaceProvidedDescription &src,::mtsManagerProxy::InterfaceProvidedDescription &dest)
static void ConstructInterfaceRequiredDescriptionFrom (const InterfaceRequiredDescription &src,::mtsManagerProxy::InterfaceRequiredDescription &dest)
static void ConstructValuesOfCommand (const mtsManagerLocalInterface::SetOfValues &src,::mtsManagerProxy::SetOfValues &dest)
static std::string GetConnectionIDKey ()
static std::string GetManagerCommunicatorID ()
static std::string GetConfigFullName (const std::string &propertyFileName)
static std::string GetGCMPortNumberAsString ()
static int GetGCMConnectTimeout ()

Protected Types

typedef IceUtil::Handle< ManagerServerI > ManagerServerIPtr

Protected Member Functions

Ice::ObjectPtr CreateServant ()
void StartServer ()
ManagerClientProxyType * GetNetworkProxyClient (const ClientIDType clientID)
void MonitorConnections ()
void ConnectCheckTimeout ()
bool OnClientDisconnect (const ClientIDType clientID)
void ReceiveTestMessageFromClientToServer (const ConnectionIDType &connectionID, const std::string &str)
bool ReceiveAddClient (const ConnectionIDType &connectionID, const std::string &connectingProxyName, ManagerClientProxyType &clientProxy)
void ReceiveShutdown (const::Ice::Current &)
bool ReceiveAddProcess (const std::string &processName)
bool ReceiveFindProcess (const std::string &processName) const
bool ReceiveRemoveProcess (const std::string &processName)
bool ReceiveAddComponent (const std::string &processName, const std::string &componentName)
bool ReceiveFindComponent (const std::string &processName, const std::string &componentName) const
bool ReceiveRemoveComponent (const std::string &processName, const std::string &componentName)
bool ReceiveAddInterfaceProvided (const std::string &processName, const std::string &componentName, const std::string &interfaceName, bool isProxyInterface)
bool ReceiveFindInterfaceProvided (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
bool ReceiveRemoveInterfaceProvided (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
bool ReceiveAddInterfaceRequired (const std::string &processName, const std::string &componentName, const std::string &interfaceName, bool isProxyInterface)
bool ReceiveFindInterfaceRequired (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
bool ReceiveRemoveInterfaceRequired (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
::Ice::Int ReceiveConnect (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool ReceiveConnectConfirm (::Ice::Int connectionSessionID)
bool ReceiveDisconnect (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool ReceiveSetInterfaceProvidedProxyAccessInfo (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet, const std::string &endpointInfo)
bool ReceiveGetInterfaceProvidedProxyAccessInfo (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet, std::string &endpointInfo)
bool ReceiveInitiateConnect (const unsigned int connectionID, const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool ReceiveConnectServerSideInterfaceRequest (const unsigned int connectionID, const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)

Static Protected Member Functions

static void Runner (ThreadArguments< mtsManagerGlobal > *arguments)

Protected Attributes

ManagerServerIPtr Sender

Static Protected Attributes

static unsigned int InstanceCounter
static std::string ConnectionIDKey
static std::string ManagerCommunicatorID

Friends

class mtsManagerGlobal

Classes

class ManagerServerI

Constructor & Destructor Documentation

mtsManagerProxyServer::mtsManagerProxyServer	(	const std::string &	adapterName,
		const std::string &	communicatorID
	)

Constructor and destructor

Member Function Documentation

Ice::ObjectPtr mtsManagerProxyServer::CreateServant ( ) [inline, protected, virtual]

Create a servant

Implements mtsProxyBaseServer< mtsManagerGlobal, mtsManagerProxy::ManagerClientPrx, std::string >.

Definition at line 66 of file mtsManagerProxyServer.h.

void mtsManagerProxyServer::StartServer ( ) [protected]

Start a send thread and wait for shutdown (this is a blocking method).

static void mtsManagerProxyServer::Runner ( ThreadArguments< mtsManagerGlobal > * arguments ) [static, protected]

Thread runner

ManagerClientProxyType* mtsManagerProxyServer::GetNetworkProxyClient ( const ClientIDType clientID ) [protected]

Get a network proxy client using clientID. If no network proxy client with the clientID found or inactive proxy, this method returns NULL.

void mtsManagerProxyServer::MonitorConnections ( ) [inline, protected]

Monitor all the current connections

Definition at line 82 of file mtsManagerProxyServer.h.

void mtsManagerProxyServer::ConnectCheckTimeout ( ) [protected]

Check connection timeout

bool mtsManagerProxyServer::OnClientDisconnect ( const ClientIDType clientID ) [protected]

Event handler for client's disconnect event

void mtsManagerProxyServer::ReceiveTestMessageFromClientToServer	(	const ConnectionIDType &	connectionID,
		const std::string &	str
	)			`[protected]`

Test method

bool mtsManagerProxyServer::ReceiveAddClient	(	const ConnectionIDType &	connectionID,
		const std::string &	connectingProxyName,
		ManagerClientProxyType &	clientProxy
	)			`[protected]`

When a new client connects, add it to the client management list.

void mtsManagerProxyServer::ReceiveShutdown ( const ::Ice::Current & ) [protected]

Shutdown this session; prepare shutdown for safe and clean termination.

bool mtsManagerProxyServer::ReceiveAddProcess ( const std::string & processName ) [protected]

Process Management

bool mtsManagerProxyServer::ReceiveAddComponent	(	const std::string &	processName,
		const std::string &	componentName
	)			`[protected]`

Component Management

::Ice::Int mtsManagerProxyServer::ReceiveConnect ( const ::mtsManagerProxy::ConnectionStringSet & connectionStringSet ) [protected]

Connection Management

bool mtsManagerProxyServer::ReceiveSetInterfaceProvidedProxyAccessInfo	(	const ::mtsManagerProxy::ConnectionStringSet &	connectionStringSet,
		const std::string &	endpointInfo
	)			`[protected]`

Networking

bool mtsManagerProxyServer::Start ( mtsManagerGlobal * owner ) [virtual]

Entry point to run a proxy

Implements mtsProxyBaseServer< mtsManagerGlobal, mtsManagerProxy::ManagerClientPrx, std::string >.

void mtsManagerProxyServer::Stop ( ) [virtual]

Stop the proxy (clean up thread-related resources)

Reimplemented from mtsProxyBaseServer< mtsManagerGlobal, mtsManagerProxy::ManagerClientPrx, std::string >.

void mtsManagerProxyServer::ConstructConnectionStringSet	(	const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName,
		::mtsManagerProxy::ConnectionStringSet &	connectionStringSet
	)

Construct mtsManagerProxy::ConnectionStringSet structure

static void mtsManagerProxyServer::ConvertInterfaceProvidedDescription	(	const ::mtsManagerProxy::InterfaceProvidedDescription &	src,
		InterfaceProvidedDescription &	dest
	)			`[static]`

Data structure converters

const std::string mtsManagerProxyServer::GetProcessName ( const std::string & listenerID = "" ) const [virtual]

Returns a name of this local component manager

Implements mtsManagerLocalInterface.

void mtsManagerProxyServer::SendTestMessageFromServerToClient ( const std::string & str )

Test method: broadcast string to all clients connected

bool mtsManagerProxyServer::SendCreateComponentProxy	(	const std::string &	componentProxyName,
		const std::string &	clientID
	)

Proxy object control (creation and removal)

bool mtsManagerProxyServer::SendConnectServerSideInterface	(	const unsigned int	connectionID,
		const ::mtsManagerProxy::ConnectionStringSet &	connectionStrings,
		const std::string &	clientID
	)

Connection management

bool mtsManagerProxyServer::SendGetInterfaceProvidedDescription	(	const std::string &	serverComponentName,
		const std::string &	providedInterfaceName,
		::mtsManagerProxy::InterfaceProvidedDescription &	providedInterfaceDescription,
		const std::string &	clientID
	)

Getters

static std::string mtsManagerProxyServer::GetConnectionIDKey ( ) [inline, static]

Returns connection id key

Definition at line 393 of file mtsManagerProxyServer.h.

References ConnectionIDKey.

static std::string mtsManagerProxyServer::GetManagerCommunicatorID ( ) [inline, static]

Returns communicator (proxy) ID

Definition at line 398 of file mtsManagerProxyServer.h.

References ManagerCommunicatorID.

static std::string mtsManagerProxyServer::GetConfigFullName ( const std::string & propertyFileName ) [static]

Returns full path name for config file

static std::string mtsManagerProxyServer::GetGCMPortNumberAsString ( ) [static]

Returns the port number that the global component manager uses

static int mtsManagerProxyServer::GetGCMConnectTimeout ( ) [static]

Returns connection timeout value (msec) from GCM's configuration file

Member Data Documentation

unsigned int mtsManagerProxyServer::InstanceCounter [static, protected]

Instance counter used to set a short name of this thread

Definition at line 53 of file mtsManagerProxyServer.h.

std::string mtsManagerProxyServer::ConnectionIDKey [static, protected]

String key to set an implicit per-proxy context for connection id

Definition at line 56 of file mtsManagerProxyServer.h.

Referenced by GetConnectionIDKey().

std::string mtsManagerProxyServer::ManagerCommunicatorID [static, protected]

Communicator (proxy) ID to initialize mtsManagerProxyServer. A manager proxy client uses this ID to connect to proxy server.

Definition at line 60 of file mtsManagerProxyServer.h.

Referenced by GetManagerCommunicatorID().

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

mtsManagerProxyServer.h

erc-cisst-devel<at>lists.johnshopkins.edu