ERC CISST - cisst software

mtsComponentInterfaceProxyServer Class Reference

Inheritance diagram for mtsComponentInterfaceProxyServer:

Inheritance graph
[legend]
Collaboration diagram for mtsComponentInterfaceProxyServer:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 32 of file mtsComponentInterfaceProxyServer.h.

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Classes


Member Typedef Documentation

typedef std::map<CommandIDType, mtsProxySerializer *> mtsComponentInterfaceProxyServer::PerCommandSerializerMapType [protected]

Per-command argument serializer

Definition at line 52 of file mtsComponentInterfaceProxyServer.h.

typedef std::map<ClientIDType, mtsDescriptionConnection> mtsComponentInterfaceProxyServer::ConnectionStringMapType [protected]

Map to retrieve connection information by client id. key=(client id) value=(an instance of mtsDescriptionConnection)

This map is used to disconnect currently established connection when a network proxy client is detected as disconnected.

Definition at line 61 of file mtsComponentInterfaceProxyServer.h.


Constructor & Destructor Documentation

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

Constructor and destructor


Member Function Documentation

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

Create a servant

Implements mtsProxyBaseServer< mtsComponentProxy, mtsComponentInterfaceProxy::ComponentInterfaceClientPrx, unsigned int >.

Definition at line 79 of file mtsComponentInterfaceProxyServer.h.

void mtsComponentInterfaceProxyServer::StartServer (  )  [protected]

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

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

Thread runner

ComponentInterfaceClientProxyType* mtsComponentInterfaceProxyServer::GetNetworkProxyClient ( const ClientIDType  clientID  )  [protected]

Get a network proxy client object using clientID. If no network proxy client with the clientID is not connected or the proxy is inactive, this method returns NULL.

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

Monitor all the current connections

Definition at line 96 of file mtsComponentInterfaceProxyServer.h.

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

Event handler for client's disconnect event

bool mtsComponentInterfaceProxyServer::ReceiveAddClient ( const ConnectionIDType connectionID,
const std::string &  connectingProxyName,
const unsigned int  providedInterfaceProxyInstanceID,
ComponentInterfaceClientProxyType &  clientProxy 
) [protected]

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

bool mtsComponentInterfaceProxyServer::Start ( mtsComponentProxy owner  )  [virtual]

Entry point to run a proxy.

Implements mtsProxyBaseServer< mtsComponentProxy, mtsComponentInterfaceProxy::ComponentInterfaceClientPrx, unsigned int >.

void mtsComponentInterfaceProxyServer::Stop (  )  [virtual]

Stop the proxy (clean up thread-related resources)

Reimplemented from mtsProxyBaseServer< mtsComponentProxy, mtsComponentInterfaceProxy::ComponentInterfaceClientPrx, unsigned int >.

bool mtsComponentInterfaceProxyServer::AddPerCommandSerializer ( const CommandIDType  commandID,
mtsProxySerializer serializer 
)

Register per-command (de)serializer

Referenced by mtsCommandWriteProxy::SetCommandID(), mtsCommandReadProxy::SetCommandID(), and mtsCommandQualifiedReadProxy::SetCommandID().

bool mtsComponentInterfaceProxyServer::AddConnectionInformation ( 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 
)

Register connection information which is used to clean up a logical connection when a network proxy client is detected as disconnected.

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

Test method: broadcast string to all clients connected

bool mtsComponentInterfaceProxyServer::SendFetchFunctionProxyPointers ( const ClientIDType  clientID,
const std::string &  requiredInterfaceName,
mtsComponentInterfaceProxy::FunctionProxyPointerSet &  functionProxyPointers 
)

Fetch function proxy pointers from the connected required interface proxy at server process.

bool mtsComponentInterfaceProxyServer::SendExecuteCommandVoid ( const ClientIDType  clientID,
const CommandIDType  commandID,
const mtsBlockingType  blocking 
)

Execute commands and events. This will call function proxies in the required interface proxy at the server process. clientID designates which network proxy client should execute a command and commandID represents which function proxy object should be called.

Referenced by mtsCommandVoidProxy::Execute().

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

Returns connection id key

Definition at line 168 of file mtsComponentInterfaceProxyServer.h.

References ConnectionIDKey.

static std::string mtsComponentInterfaceProxyServer::GetInterfaceCommunicatorID (  )  [inline, static]

Returns communicator (proxy) ID

Definition at line 173 of file mtsComponentInterfaceProxyServer.h.

References InterfaceCommunicatorID.


Member Data Documentation

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

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

Definition at line 65 of file mtsComponentInterfaceProxyServer.h.

Referenced by GetConnectionIDKey().

std::string mtsComponentInterfaceProxyServer::InterfaceCommunicatorID [static, protected]

Communicator (proxy) ID to initialize mtsComponentInterfaceProxyServer. A component interface proxy client uses this ID to connect to a proxy server.

Definition at line 70 of file mtsComponentInterfaceProxyServer.h.

Referenced by GetInterfaceCommunicatorID().

unsigned int mtsComponentInterfaceProxyServer::InstanceCounter [static, protected]

Instance counter used to set a short name of this thread

Definition at line 73 of file mtsComponentInterfaceProxyServer.h.


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