ERC CISST - cisst software

mtsComponentInterfaceProxyClient Class Reference

Inheritance diagram for mtsComponentInterfaceProxyClient:

[legend]Collaboration diagram for mtsComponentInterfaceProxyClient:

[legend]List of all members.

Detailed Description

Definition at line 31 of file mtsComponentInterfaceProxyClient.h.

Public Member Functions

mtsComponentInterfaceProxyClient (const std::string &serverEndpointInfo, const unsigned int connectionID)
bool Start (mtsComponentProxy *proxyOwner)
void Stop (void)
void SendTestMessageFromClientToServer (const std::string &str) const
bool AddPerEventSerializer (const CommandIDType commandID, mtsProxySerializer *serializer)
bool SendFetchEventGeneratorProxyPointers (const std::string &clientComponentName, const std::string &requiredInterfaceName, mtsComponentInterfaceProxy::EventGeneratorProxyPointerSet &eventGeneratorProxyPointers)
bool SendExecuteEventVoid (const CommandIDType commandID)
bool SendExecuteEventWriteSerialized (const CommandIDType commandID, const mtsGenericObject &argument)

Protected Types

typedef IceUtil::Handle< ComponentInterfaceClientI > ComponentInterfaceClientIPtr
typedef std::map< CommandIDType,
mtsProxySerializer * > PerEventSerializerMapType

Protected Member Functions

void CreateProxy ()
void RemoveProxy ()
void StartClient ()
bool OnServerDisconnect ()
void ReceiveTestMessageFromServerToClient (const std::string &str) const
bool ReceiveFetchFunctionProxyPointers (const std::string &requiredInterfaceName, mtsComponentInterfaceProxy::FunctionProxyPointerSet &functionProxyPointers) const
void ReceiveExecuteCommandVoid (const CommandIDType commandID, const mtsBlockingType blocking)
void ReceiveExecuteCommandWriteSerialized (const CommandIDType commandID, const std::string &serializedArgument, const mtsBlockingType blocking)
void ReceiveExecuteCommandReadSerialized (const CommandIDType commandID, std::string &serializedArgument)
void ReceiveExecuteCommandQualifiedReadSerialized (const CommandIDType commandID, const std::string &serializedArgumentIn, std::string &serializedArgumentOut)

Static Protected Member Functions

static void Runner (ThreadArguments< mtsComponentProxy > *arguments)

Protected Attributes

ComponentInterfaceClientIPtr Sender
PerEventSerializerMapType PerEventSerializerMap
unsigned int ConnectionID

Static Protected Attributes

static unsigned int InstanceCounter

Classes

class ComponentInterfaceClientI

Member Typedef Documentation

typedef std::map<CommandIDType, mtsProxySerializer *> mtsComponentInterfaceProxyClient::PerEventSerializerMapType [protected]

Typedef for per-event argument serializer

Definition at line 49 of file mtsComponentInterfaceProxyClient.h.

Constructor & Destructor Documentation

mtsComponentInterfaceProxyClient::mtsComponentInterfaceProxyClient	(	const std::string &	serverEndpointInfo,
		const unsigned int	connectionID
	)

Constructor and destructor

Member Function Documentation

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

Create a proxy object and a send thread.

Implements mtsProxyBaseClient< mtsComponentProxy >.

Definition at line 65 of file mtsComponentInterfaceProxyClient.h.

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

Remove a proxy object

Implements mtsProxyBaseClient< mtsComponentProxy >.

Definition at line 76 of file mtsComponentInterfaceProxyClient.h.

void mtsComponentInterfaceProxyClient::StartClient ( ) [protected]

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

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

Called when server disconnection is detected

Implements mtsProxyBaseClient< mtsComponentProxy >.

static void mtsComponentInterfaceProxyClient::Runner ( ThreadArguments< mtsComponentProxy > * arguments ) [static, protected]

Thread runner

void mtsComponentInterfaceProxyClient::ReceiveTestMessageFromServerToClient ( const std::string & str ) const [protected]

Test method

bool mtsComponentInterfaceProxyClient::ReceiveFetchFunctionProxyPointers	(	const std::string &	requiredInterfaceName,
		mtsComponentInterfaceProxy::FunctionProxyPointerSet &	functionProxyPointers
	)			const `[protected]`

Fetch pointers of function proxies from a required interface proxy at server side

void mtsComponentInterfaceProxyClient::ReceiveExecuteCommandVoid	(	const CommandIDType	commandID,
		const mtsBlockingType	blocking
	)			`[protected]`

Execute commands

bool mtsComponentInterfaceProxyClient::Start ( mtsComponentProxy * proxyOwner ) [virtual]

Entry point to run a proxy.

Implements mtsProxyBaseClient< mtsComponentProxy >.

void mtsComponentInterfaceProxyClient::Stop ( void ) [virtual]

Stop the proxy (clean up thread-related resources)

Reimplemented from mtsProxyBaseClient< mtsComponentProxy >.

void mtsComponentInterfaceProxyClient::SendTestMessageFromClientToServer ( const std::string & str ) const

Test method

bool mtsComponentInterfaceProxyClient::AddPerEventSerializer	(	const CommandIDType	commandID,
		mtsProxySerializer *	serializer
	)

Referenced by mtsCommandWriteProxy::SetCommandID().

bool mtsComponentInterfaceProxyClient::SendFetchEventGeneratorProxyPointers	(	const std::string &	clientComponentName,
		const std::string &	requiredInterfaceName,
		mtsComponentInterfaceProxy::EventGeneratorProxyPointerSet &	eventGeneratorProxyPointers
	)

Fetch pointers of event generator proxies from a provided interface proxy at server side

bool mtsComponentInterfaceProxyClient::SendExecuteEventVoid ( const CommandIDType commandID )

Request execution of events

Referenced by mtsCommandVoidProxy::Execute().

Member Data Documentation

unsigned int mtsComponentInterfaceProxyClient::ConnectionID [protected]

Connection id that this proxy runs for. mtsComponentInterfaceProxyServer handles multiple network proxy clients (because multiple required interfaces can connect to one provided interface) and it uses this id as unique id. See also comments for mtsComponentProxy::ConnectionId

Definition at line 56 of file mtsComponentInterfaceProxyClient.h.

unsigned int mtsComponentInterfaceProxyClient::InstanceCounter [static, protected]

Instance counter used to set a short name of this thread

Definition at line 59 of file mtsComponentInterfaceProxyClient.h.

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

mtsComponentInterfaceProxyClient.h

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