ERC CISST - cisst software

mtsManagerProxyClient Class Reference

Inheritance diagram for mtsManagerProxyClient:

[legend]Collaboration diagram for mtsManagerProxyClient:

[legend]List of all members.

Detailed Description

Definition at line 32 of file mtsManagerProxyClient.h.

Public Member Functions

mtsManagerProxyClient (const std::string &serverEndpointInfo)
bool Start (mtsManagerLocal *proxyOwner)
void Stop (void)
bool AddProcess (const std::string &processName)
Register process.
bool FindProcess (const std::string &processName) const
Find process.
bool RemoveProcess (const std::string &processName)
Remove process.
bool AddComponent (const std::string &processName, const std::string &componentName)
Register component.
bool FindComponent (const std::string &processName, const std::string &componentName) const
Find component using process name and component name.
bool RemoveComponent (const std::string &processName, const std::string &componentName)
Remove component.
bool AddInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName, const bool isProxyInterface)
Register provided interface. Can be called at run-time.
bool AddInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName, const bool isProxyInterface)
Register required interface. Can be called at run-time.
bool FindInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
Find provided interface using process name, component name, and interface name.
bool FindInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
Find required interface using process name, component name, and interface name.
bool RemoveInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
Remove provided interface. Can be called at run-time.
bool RemoveInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
Remove required interface. Can be called at run-time.
int Connect (const std::string &requestProcessName, const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)
Connect two interfaces.
bool ConnectConfirm (unsigned int connectionSessionID)
Confirm that connection has been successfully established.
bool Disconnect (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)
Disconnect two interfaces.
bool SetInterfaceProvidedProxyAccessInfo (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 &endpointInfo)
bool GetInterfaceProvidedProxyAccessInfo (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName, std::string &endpointInfo)
bool InitiateConnect (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)
bool ConnectServerSideInterfaceRequest (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)
void GetListOfConnections (std::vector< mtsDescriptionConnection > &list) const
void SendTestMessageFromClientToServer (const std::string &str) const
bool SendAddProcess (const std::string &processName)
bool SendFindProcess (const std::string &processName)
bool SendRemoveProcess (const std::string &processName)
bool SendAddComponent (const std::string &processName, const std::string &componentName)
bool SendFindComponent (const std::string &processName, const std::string &componentName)
bool SendRemoveComponent (const std::string &processName, const std::string &componentName)
bool SendAddInterfaceProvided (const std::string &processName, const std::string &componentName, const std::string &interfaceName, bool isProxyInterface)
bool SendFindInterfaceProvided (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
bool SendRemoveInterfaceProvided (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
bool SendAddInterfaceRequired (const std::string &processName, const std::string &componentName, const std::string &interfaceName, bool isProxyInterface)
bool SendFindInterfaceRequired (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
bool SendRemoveInterfaceRequired (const std::string &processName, const std::string &componentName, const std::string &interfaceName)
::Ice::Int SendConnect (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool SendConnectConfirm (::Ice::Int connectionSessionID)
bool SendDisconnect (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool SendSetInterfaceProvidedProxyAccessInfo (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet, const std::string &endpointInfo)
bool SendGetInterfaceProvidedProxyAccessInfo (const::mtsManagerProxy::ConnectionStringSet &connectionStringSet, std::string &endpointInfo)
bool SendInitiateConnect (::Ice::Int connectionID, const ::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool SendConnectServerSideInterfaceRequest (const unsigned int connectionID, const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)

Protected Types

typedef IceUtil::Handle< ManagerClientI > ManagerClientIPtr

Protected Member Functions

void CreateProxy ()
void RemoveProxy ()
void StartClient ()
bool OnServerDisconnect ()
void GetConnectionStringSet (mtsManagerProxy::ConnectionStringSet &connectionStringSet, 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 &requestProcessName="")
void ReceiveTestMessageFromServerToClient (const std::string &str) const
bool ReceiveCreateComponentProxy (const std::string &componentProxyName)
bool ReceiveRemoveComponentProxy (const std::string &componentProxyName)
bool ReceiveCreateInterfaceProvidedProxy (const std::string &serverComponentProxyName, const::mtsManagerProxy::InterfaceProvidedDescription &providedInterfaceDescription)
bool ReceiveCreateInterfaceRequiredProxy (const std::string &clientComponentProxyName, const::mtsManagerProxy::InterfaceRequiredDescription &requiredInterfaceDescription)
bool ReceiveRemoveInterfaceProvidedProxy (const std::string &clientComponentProxyName, const std::string &providedInterfaceProxyName)
bool ReceiveRemoveInterfaceRequiredProxy (const std::string &serverComponentProxyName, const std::string &requiredInterfaceProxyName)
bool ReceiveConnectServerSideInterface (const unsigned int connectionID, const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool ReceiveConnectClientSideInterface (const unsigned int connectionID, const::mtsManagerProxy::ConnectionStringSet &connectionStringSet)
bool ReceiveGetInterfaceProvidedDescription (const std::string &serverComponentName, const std::string &providedInterfaceName,::mtsManagerProxy::InterfaceProvidedDescription &providedInterfaceDescription)
bool ReceiveGetInterfaceRequiredDescription (const std::string &componentName, const std::string &requiredInterfaceName,::mtsManagerProxy::InterfaceRequiredDescription &requiredInterfaceDescription)
void ReceiveGetNamesOfCommands (const std::string &componentName, const std::string &providedInterfaceName,::mtsManagerProxy::NamesOfCommandsSequence &names) const
void ReceiveGetNamesOfEventGenerators (const std::string &componentName, const std::string &providedInterfaceName,::mtsManagerProxy::NamesOfEventGeneratorsSequence &names) const
void ReceiveGetNamesOfFunctions (const std::string &componentName, const std::string &requiredInterfaceName,::mtsManagerProxy::NamesOfFunctionsSequence &names) const
void ReceiveGetNamesOfEventHandlers (const std::string &componentName, const std::string &requiredInterfaceName,::mtsManagerProxy::NamesOfEventHandlersSequence &names) const
void ReceiveGetDescriptionOfCommand (const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, std::string &description) const
void ReceiveGetDescriptionOfEventGenerator (const std::string &componentName, const std::string &providedInterfaceName, const std::string &eventGeneratorName, std::string &description) const
void ReceiveGetDescriptionOfFunction (const std::string &componentName, const std::string &requiredInterfaceName, const std::string &functionName, std::string &description) const
void ReceiveGetDescriptionOfEventHandler (const std::string &componentName, const std::string &requiredInterfaceName, const std::string &eventHandlerName, std::string &description) const
void ReceiveGetArgumentInformation (const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, std::string &argumentName,::mtsManagerProxy::NamesOfSignals &signalNames) const
void ReceiveGetValuesOfCommand (const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName, const int scalarIndex,::mtsManagerProxy::SetOfValues &values) const
std::string ReceiveGetProcessName ()
::Ice::Int ReceiveGetCurrentInterfaceCount (const std::string &componentName)

Static Protected Member Functions

static void Runner (ThreadArguments< mtsManagerLocal > *arguments)

Protected Attributes

ManagerClientIPtr Sender

Static Protected Attributes

static unsigned int InstanceCounter

Classes

class ManagerClientI

Constructor & Destructor Documentation

mtsManagerProxyClient::mtsManagerProxyClient ( const std::string & serverEndpointInfo )

Constructor and destructor

Member Function Documentation

void mtsManagerProxyClient::CreateProxy ( ) [inline, protected, virtual]

Create a proxy object and a send thread.

Implements mtsProxyBaseClient< mtsManagerLocal >.

Definition at line 58 of file mtsManagerProxyClient.h.

void mtsManagerProxyClient::RemoveProxy ( ) [inline, protected, virtual]

Create a proxy object and a send thread.

Implements mtsProxyBaseClient< mtsManagerLocal >.

Definition at line 69 of file mtsManagerProxyClient.h.

void mtsManagerProxyClient::StartClient ( ) [protected]

Start a send thread and wait for shutdown (blocking call).

bool mtsManagerProxyClient::OnServerDisconnect ( ) [protected, virtual]

Called when server disconnection is detected

Implements mtsProxyBaseClient< mtsManagerLocal >.

static void mtsManagerProxyClient::Runner ( ThreadArguments< mtsManagerLocal > * arguments ) [static, protected]

Thread runner

void mtsManagerProxyClient::GetConnectionStringSet	(	mtsManagerProxy::ConnectionStringSet &	connectionStringSet,
		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 &	requestProcessName = `""`
	)			`[protected]`

Miscellaneous methods

bool mtsManagerProxyClient::Start ( mtsManagerLocal * proxyOwner ) [virtual]

Entry point to run a proxy.

Implements mtsProxyBaseClient< mtsManagerLocal >.

void mtsManagerProxyClient::Stop ( void ) [virtual]

Stop the proxy (clean up thread-related resources)

Reimplemented from mtsProxyBaseClient< mtsManagerLocal >.

bool mtsManagerProxyClient::AddProcess ( const std::string & processName ) [virtual]

Parameters:

processName

Name of process

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::FindProcess ( const std::string & processName ) const [virtual]

Find process.

Parameters:

processName

Name of process

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::RemoveProcess ( const std::string & processName ) [virtual]

Remove process.

Parameters:

processName

Name of process

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::AddComponent	(	const std::string &	processName,
		const std::string &	componentName
	)			`[virtual]`

Parameters:

	processName	Name of process
	componentName	Name of component

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::FindComponent	(	const std::string &	processName,
		const std::string &	componentName
	)			const `[virtual]`

Find component using process name and component name.

Parameters:

	processName	Name of process
	componentName	Name of component

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::RemoveComponent	(	const std::string &	processName,
		const std::string &	componentName
	)			`[virtual]`

Remove component.

Parameters:

	processName	Name of process
	componentName	Name of component

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::AddInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName,
		const bool	isProxyInterface
	)			`[virtual]`

Parameters:

	processName	Name of process
	componentName	Name of component
	interfaceName	Name of provided interface to be added
	isProxyInterface	True if interface added is a proxy interface

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::AddInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName,
		const bool	isProxyInterface
	)			`[virtual]`

Parameters:

	processName	Name of process
	componentName	Name of component
	interfaceName	Name of required interface to be added
	isProxyInterface	True if interface added is a proxy interface

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::FindInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)			const `[virtual]`

Find provided interface using process name, component name, and interface name.

Parameters:

	processName	Name of process
	componentName	Name of component
	interfaceName	Name of provided interface

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::FindInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)			const `[virtual]`

Find required interface using process name, component name, and interface name.

Parameters:

	processName	Name of process
	componentName	Name of component
	interfaceName	Name of required interface

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::RemoveInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)			`[virtual]`

Remove provided interface. Can be called at run-time.

Parameters:

	processName	Name of process
	componentName	Name of component
	interfaceName	Name of provided interface to be removed

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::RemoveInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)			`[virtual]`

Remove required interface. Can be called at run-time.

Parameters:

	processName	Name of process
	componentName	Name of component
	interfaceName	Name of required interface to be removed

Implements mtsManagerGlobalInterface.

int mtsManagerProxyClient::Connect	(	const std::string &	requestProcessName,
		const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName
	)			`[virtual]`

Connect two interfaces.

Parameters:

	requestProcessName	Name of process that requests this connection
	clientProcessName	Name of client process
	clientComponentName	Name of client component
	clientInterfaceRequiredName	Name of client's required interface
	serverProcessName	Name of server process
	serverComponentName	Name of server component
	serverInterfaceProvidedName	Name of server's provided interface

Returns:: Connect session id issued by the global component manager. Session id is used to clean up pending connections (which was requested but not yet established) after timeout. -1 if error occurs, zero or positive value if success

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::ConnectConfirm ( unsigned int connectionSessionID ) [virtual]

Confirm that connection has been successfully established.

Parameters:

connectionSessionID

Connection id

Returns:: False if connection id is invalid, true otherwise

Implements mtsManagerGlobalInterface.

bool mtsManagerProxyClient::Disconnect	(	const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName
	)			`[virtual]`

Disconnect two interfaces.

Parameters:

	clientProcessName	Name of client process
	clientComponentName	Name of client component
	clientInterfaceRequiredName	Name of required interface
	serverProcessName	Name of server process
	serverComponentName	Name of server component
	serverInterfaceProvidedName	Name of provided interface

Returns:: True if success, false otherwise

Implements mtsManagerGlobalInterface.

void mtsManagerProxyClient::GetListOfConnections ( std::vector< mtsDescriptionConnection > & list ) const [virtual]

Get a list of all active connections represented by a set of strings

Implements mtsManagerGlobalInterface.

Member Data Documentation

unsigned int mtsManagerProxyClient::InstanceCounter [static, protected]

Instance counter used to set a short name of this thread

Definition at line 52 of file mtsManagerProxyClient.h.

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

mtsManagerProxyClient.h

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