mtsConnection Class Reference

#include <mtsConnection.h>

Inheritance diagram for mtsConnection:

Public Member Functions
	mtsConnection (const mtsDescriptionConnection &description, const std::string &requestProcessName)
ConnectionIDType	GetConnectionID (void) const
std::string	GetClientProcessName (void) const
std::string	GetClientComponentName (void) const
std::string	GetClientInterfaceName (void) const
std::string	GetServerProcessName (void) const
std::string	GetServerComponentName (void) const
std::string	GetServerInterfaceName (void) const
mtsDescriptionConnection	GetDescriptionConnection (void) const
void	GetDescriptionConnection (mtsDescriptionConnection &description) const
bool	IsConnected (void) const
void	SetConnected (void)
bool	IsRemoteConnection (void) const
std::string	GetEndpointInfo (void) const
void	SetProxyAccessInfo (const std::string &endpointInfo)
bool	CheckTimeout (void) const
void	ToStream (std::ostream &outputStream) const
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
bool	SetTimestampIfAutomatic (double timestamp)
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= ' ')
size_t	ScalarNumber (void) const
bool	ScalarNumberIsFixed (void) const
double	Scalar (const size_t index) const throw (std::out_of_range)
std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
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 cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Attributes
mtsDescriptionConnection	ConnectionDescription
const std::string	RequestProcessName
bool	Connected
std::string	EndpointInfo
double	TimeoutTime

Detailed Description

Data structure to keep connection information

Constructor & Destructor Documentation

mtsConnection::mtsConnection	(	const mtsDescriptionConnection &	description,
		const std::string &	requestProcessName
	)

Member Function Documentation

bool mtsConnection::CheckTimeout

(

void

)

const

In the state of pending connection, check if this connection should be invalidated due to connection timeout

void mtsConnection::DeSerializeRaw ( std::istream &  inputStream )

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

std::string mtsConnection::GetClientComponentName

(

void

)

const

std::string mtsConnection::GetClientInterfaceName

(

void

)

const

std::string mtsConnection::GetClientProcessName

(

void

)

const

ConnectionIDType mtsConnection::GetConnectionID

(

void

)

const

Getters and Setters

mtsDescriptionConnection mtsConnection::GetDescriptionConnection

(

void

)

const

void mtsConnection::GetDescriptionConnection

(

mtsDescriptionConnection &

description

)

const

std::string mtsConnection::GetEndpointInfo ( void  ) const

inline

std::string mtsConnection::GetServerComponentName

(

void

)

const

std::string mtsConnection::GetServerInterfaceName

(

void

)

const

std::string mtsConnection::GetServerProcessName

(

void

)

const

bool mtsConnection::IsConnected ( void  ) const

inline

bool mtsConnection::IsRemoteConnection

(

void

)

const

void mtsConnection::SerializeRaw ( std::ostream &  outputStream ) const

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void mtsConnection::SetConnected ( void  )

inline

void mtsConnection::SetProxyAccessInfo ( const std::string &  endpointInfo )

inline

void mtsConnection::ToStream ( std::ostream &  outputStream ) const

virtual

Human readable text output. This method only streams the data members of mtsGenericObject, i.e. the Timestamp and Valid flag. It should be called by any derived class re-implementing ToStream.

Reimplemented from mtsGenericObject.

Member Data Documentation

bool mtsConnection::Connected

protected

mtsDescriptionConnection mtsConnection::ConnectionDescription

protected

std::string mtsConnection::EndpointInfo

protected

const std::string mtsConnection::RequestProcessName

protected

double mtsConnection::TimeoutTime

protected

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsConnection.h