mtsSocketProxyClient Class Reference

#include <mtsSocketProxyClient.h>

Inheritance diagram for mtsSocketProxyClient:

Public Member Functions
	mtsSocketProxyClient (const std::string &name, const std::string &ip, short port)
	mtsSocketProxyClient (const mtsSocketProxyClientConstructorArg &arg)
virtual	~mtsSocketProxyClient ()
void	Configure (const std::string &) override
void	Startup (void) override
void	Run (void) override
void	Cleanup (void) override
bool	CheckForEventsImmediate (double timeoutInSec)
bool	Serialize (const mtsGenericObject &originalObject, std::string &serializedObject)
bool	DeSerialize (const std::string &serializedObject, mtsGenericObject &originalObject)
mtsGenericObject *	DeSerialize (const std::string &serializedObject)
Public Member Functions inherited from mtsTaskContinuous
	mtsTaskContinuous (const std::string &name, unsigned int sizeStateTable=256, bool newThread=true)
	mtsTaskContinuous (const mtsTaskContinuousConstructorArg &arg)
virtual	~mtsTaskContinuous ()
void	Create (void *data=0) override
void	Start (void) override
void	Suspend (void) override
void	Kill (void) override
virtual bool	CreatesThread (void) const
Public Member Functions inherited from mtsTask
	mtsTask (const std::string &name, unsigned int sizeStateTable=256)
virtual	~mtsTask ()
virtual void	OnStartupException (const std::exception &excp)
virtual void	OnRunException (const std::exception &excp)
void	Configure (const std::string &CMN_UNUSED(filename)="") override
void	SetInitializationDelay (double delay)
void	Create (void) override
double	GetAveragePeriod (void) const
const std::string	GetDefaultStateTableName (void) const
mtsStateTable *	GetDefaultStateTable (void)
mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED) override
mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY) override
virtual bool	WaitToStart (double timeout)
virtual bool	WaitToTerminate (double timeout)
virtual void	WaitForWakeup (void)
virtual void	Wakeup (void)
void	ProcessManagerCommandsIfNotActive ()
bool	CheckForOwnThread (void) const
virtual bool	IsPeriodic (void) const
virtual bool	IsOverranPeriod (void) const
virtual void	ResetOverranPeriod (void)
Public Member Functions inherited from mtsComponent
	mtsComponent (const std::string &deviceName)
virtual	~mtsComponent ()
const std::string &	GetName (void) const
void	GetName (std::string &placeHolder) const
void	AddTag (const std::string &tag)
const std::set< std::string > &	GetTags (void) const
void	SetName (const std::string &componentName)
bool	CreateAndWait (double timeoutInSeconds)
bool	StartAndWait (double timeoutInSeconds)
bool	KillAndWait (double timeoutInSeconds)
mtsInterfaceProvided *	AddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)
CISST_DEPRECATED mtsInterfaceProvided *	AddProvidedInterface (const std::string &interfaceProvidedName)
virtual mtsInterfaceOutput *	AddInterfaceOutput (const std::string &interfaceOutputName)
std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const
std::vector< std::string >	GetNamesOfInterfacesProvided (void) const
std::vector< std::string >	GetNamesOfInterfacesOutput (void) const
bool	InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
bool	InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
bool	InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
mtsInterfaceProvided *	GetInterfaceProvided (const std::string &interfaceProvidedName) const
mtsInterfaceOutput *	GetInterfaceOutput (const std::string &interfaceOutputName) const
size_t	GetNumberOfInterfacesProvided (void) const
size_t	GetNumberOfInterfacesOutput (void) const
bool	RemoveInterfaceProvided (const std::string &interfaceProvidedName)
mtsInterfaceRequired *	AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
CISST_DEPRECATED mtsInterfaceRequired *	AddRequiredInterface (const std::string &requiredInterfaceName)
virtual mtsInterfaceInput *	AddInterfaceInput (const std::string &interfaceInputName)
std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const
std::vector< std::string >	GetNamesOfInterfacesRequired (void) const
std::vector< std::string >	GetNamesOfInterfacesInput (void) const
const mtsInterfaceProvided *	GetInterfaceProvidedFor (const std::string &interfaceRequiredName)
mtsInterfaceRequired *	GetInterfaceRequired (const std::string &interfaceRequiredName)
mtsInterfaceInput *	GetInterfaceInput (const std::string &interfaceInputName) const
size_t	GetNumberOfInterfacesRequired (void) const
size_t	GetNumberOfInterfacesInput (void) const
bool	RemoveInterfaceRequired (const std::string &interfaceRequiredName)
mtsStateTable *	GetStateTable (const std::string &stateTableName)
bool	AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)
void	UseSeparateLogFileDefault (bool forwardToLogger=true)
void	UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)
void	UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)
cmnLogger::StreamBufType *	GetLogMultiplexer (void) const override
bool	AreAllInterfacesRequiredConnected (const bool log=false)
bool	IsRunning (void) const
bool CISST_DEPRECATED	Running (void) const
bool	IsStarted (void) const
bool	IsTerminated (void) const
bool	IsEndTask (void) const
const mtsComponentState &	GetState (void) const
void	GetState (mtsComponentState &state) const
void	ToStream (std::ostream &outputStream) const override
bool	SetReplayMode (void)
bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)
bool	SetReplayTime (const double time)
Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)
virtual const cmnClassServicesBase *	Services (void) const =0
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
virtual void	SerializeRaw (std::ostream &outputStream) const
virtual void	DeSerializeRaw (std::istream &inputStream)
virtual size_t	ScalarNumber (void) const
virtual bool	ScalarNumberIsFixed (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Member Functions
void	LocalUnblockingHandler (const mtsGenericObject &arg)
bool	WaitForResponse (double timeoutInSec)
bool	CreateClientProxy (const std::string &providedInterfaceName)
	Create client proxy.
void	EventEnable (const std::string &eventName, const char *handle)
void	EventDisable (const std::string &eventName, const char *handle)
void	CheckForEvents (double timeoutInSec)
Protected Member Functions inherited from mtsTaskContinuous
void *	RunInternal (void *argument) override
virtual void	StartInternal (void)
Protected Member Functions inherited from mtsTask
virtual const mtsManagerComponentServices *	GetManagerComponentServices (void) const override
void	RunEventHandler (void)
void	ChangeStateEventHandler (const mtsComponentState &newState)
mtsExecutionResult	RunEvent (bool check=true)
void	DoRunInternal (void)
virtual void	StartupInternal (void)
virtual void	CleanupInternal (void)
void	Sleep (double timeInSeconds)
mtsStateIndex::TimeTicksType	GetTick (void) const
virtual void	SaveThreadStartData (void *data)
virtual void	SetThreadReturnValue (void *returnValue)
void	ChangeState (mtsComponentState::Enum newState)
bool	WaitForState (mtsComponentState desiredState, double timeout) override
Protected Member Functions inherited from mtsComponent
	mtsComponent (void)
	mtsComponent (const mtsComponent &other)
void	Initialize (void)
mtsInterfaceRequired *	AddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)
mtsInterfaceRequired *	AddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)
mtsInterfaceProvided *	AddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)
mtsInterfaceInput *	AddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)
mtsInterfaceOutput *	AddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)
void	KillSeparateLogFile (void)
size_t	ProcessMailBoxes (InterfacesProvidedMapType &interfaces)
size_t	ProcessQueuedCommands (void)
size_t	ProcessQueuedEvents (void)
mtsInterfaceRequired *	EnableDynamicComponentManagement (void)
	Enable support for dynamic component management services.
bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces.
void	InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
void	InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
void	InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
void	InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

Protected Attributes
osaSocket	Socket
mtsProxySerializer *	Serializer
mtsSocketProxyInitData	ServerData
std::vector< mtsCommandBase * >	EventGenerators
bool	LocalWaiting
mtsCommandWriteBase *	localUnblockingCommand
mtsCommandWriteBase *	EventEnableCommand
mtsCommandWriteBase *	EventDisableCommand
Protected Attributes inherited from mtsTaskContinuous
bool	NewThread
bool	CaptureThread
Protected Attributes inherited from mtsTask
osaThread	Thread
double	InitializationDelay
osaMutex	StateChange
osaThreadSignal	StateChangeSignal
mtsStateTable	StateTable
bool	OverranPeriod
void *	ThreadStartData
void *	ReturnValue
mtsCallableVoidBase *	InterfaceProvidedToManagerCallable
mtsInterfaceRequired *	ExecIn
mtsInterfaceProvided *	ExecOut
mtsFunctionVoid	RunEventInternal
bool	RunEventCalled
mtsFunctionWrite	ChangeStateEvent
Protected Attributes inherited from mtsComponent
std::string	Name
mtsComponentState	State
std::set< std::string >	mTags
mtsInterfaceProvided *	InterfaceProvidedToManager
bool	UseSeparateLogFileFlag
cmnLogger::StreamBufType *	LoDMultiplexerStreambuf
std::ofstream *	LogFile
InterfacesProvidedMapType	InterfacesProvided
InterfacesOutputMapType	InterfacesOutput
InterfacesRequiredMapType	InterfacesRequired
InterfacesInputMapType	InterfacesInput
StateTableMapType	StateTables
mtsManagerComponentServices *	ManagerComponentServices
mtsFunctionWrite	EventGeneratorChangeState
bool	ReplayMode

Friends
class	CommandWrapperBase
class	MulticastCommandVoidProxy
class	MulticastCommandWriteProxy

Additional Inherited Members
Public Types inherited from mtsTaskContinuous
typedef mtsTask	BaseType
Public Types inherited from mtsTask
typedef mtsComponent	BaseType
Public Types inherited from mtsComponent
typedef mtsComponent	ThisType
Static Public Attributes inherited from mtsTask
static std::runtime_error	UnknownException
Protected Types inherited from mtsComponent
typedef cmnNamedMap< mtsInterfaceProvided >	InterfacesProvidedMapType
typedef cmnNamedMap< mtsInterfaceOutput >	InterfacesOutputMapType
typedef cmnNamedMap< mtsInterfaceRequired >	InterfacesRequiredMapType
typedef cmnNamedMap< mtsInterfaceInput >	InterfacesInputMapType
typedef cmnNamedMap< mtsStateTable >	StateTableMapType

Constructor & Destructor Documentation

mtsSocketProxyClient() [1/2]

mtsSocketProxyClient::mtsSocketProxyClient	(	const std::string &	name,
		const std::string &	ip,
		short	port )

Constructor

Parameters

name	Name of the client proxy component
ip	IP address for corresponding server proxy
port	Port for corresponding server proxy (UDP socket)

mtsSocketProxyClient() [2/2]

mtsSocketProxyClient::mtsSocketProxyClient

(

const mtsSocketProxyClientConstructorArg &

arg

)

~mtsSocketProxyClient()

virtual mtsSocketProxyClient::~mtsSocketProxyClient ( )

virtual

Destructor

Member Function Documentation

CheckForEvents()

void mtsSocketProxyClient::CheckForEvents ( double timeoutInSec )

protected

CheckForEventsImmediate()

bool mtsSocketProxyClient::CheckForEventsImmediate

(

double

timeoutInSec

)

Cleanup()

void mtsSocketProxyClient::Cleanup ( void )

overridevirtual

Virtual method that gets overloaded, and is run after the component gets killed using Kill() method.

Reimplemented from mtsComponent.

Configure()

void mtsSocketProxyClient::Configure ( const std::string & filename )

inlineoverridevirtual

The virtual method so that the interface or tasks can configure themselves

Reimplemented from mtsComponent.

CreateClientProxy()

bool mtsSocketProxyClient::CreateClientProxy ( const std::string & providedInterfaceName )

protected

Create client proxy.

Parameters

providedInterfaceDescription

Complete information about provided interface to be created with arguments serialized

Returns

True if success, false otherwise

DeSerialize() [1/2]

mtsGenericObject * mtsSocketProxyClient::DeSerialize

(

const std::string &

serializedObject

)

DeSerialize() [2/2]

bool mtsSocketProxyClient::DeSerialize	(	const std::string &	serializedObject,
		mtsGenericObject &	originalObject )

EventDisable()

void mtsSocketProxyClient::EventDisable ( const std::string & eventName, const char * handle )

protected

EventEnable()

void mtsSocketProxyClient::EventEnable ( const std::string & eventName, const char * handle )

protected

LocalUnblockingHandler()

void mtsSocketProxyClient::LocalUnblockingHandler ( const mtsGenericObject & arg )

protected

Run()

void mtsSocketProxyClient::Run ( void )

overridevirtual

Pure virtual method that gets overloaded to run the actual task.

Implements mtsTask.

Serialize()

bool mtsSocketProxyClient::Serialize	(	const mtsGenericObject &	originalObject,
		std::string &	serializedObject )

Startup()

void mtsSocketProxyClient::Startup ( void )

overridevirtual

Virtual method that gets overloaded, and is run before the component is started.

Reimplemented from mtsComponent.

WaitForResponse()

bool mtsSocketProxyClient::WaitForResponse ( double timeoutInSec )

protected

Friends And Related Symbol Documentation

CommandWrapperBase

friend class CommandWrapperBase

friend

MulticastCommandVoidProxy

friend class MulticastCommandVoidProxy

friend

MulticastCommandWriteProxy

friend class MulticastCommandWriteProxy

friend

Member Data Documentation

EventDisableCommand

mtsCommandWriteBase* mtsSocketProxyClient::EventDisableCommand

protected

EventEnableCommand

mtsCommandWriteBase* mtsSocketProxyClient::EventEnableCommand

protected

EventGenerators

std::vector<mtsCommandBase *> mtsSocketProxyClient::EventGenerators

protected

localUnblockingCommand

mtsCommandWriteBase* mtsSocketProxyClient::localUnblockingCommand

protected

LocalWaiting

bool mtsSocketProxyClient::LocalWaiting

protected

Serializer

mtsProxySerializer* mtsSocketProxyClient::Serializer

protected

ServerData

mtsSocketProxyInitData mtsSocketProxyClient::ServerData

protected

Socket

osaSocket mtsSocketProxyClient::Socket

protected

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsSocketProxyClient.h