The DtDebugDrawConnector class manages the connection with the server and provides and interface to send and receive messages with the server. More...

Public Types
typedef DtDelegate< void, DtDebugDrawConnector * >	DtConnectionDelegate
	Connection callback definition. More...

Public Member Functions
	DtDebugDrawConnector ()
	constructor/destructor More...

virtual	~DtDebugDrawConnector ()

virtual void	connect (const std::string &address, int port=DtDisplayPort, const std::string &simAddress="", bool attemptRetry=true)
	this establishes a connection to a remote RadarFX server at a given address and port the connection callback will be run when a connection is made. More...

virtual void	disconnect ()
	Disconnects from a RadarFX server. More...

virtual bool	isOk ()
	Returns true of the connection has succeed and is valid. More...

virtual void	tick ()
	Tick must be called periodically to allow message callbacks to be run. More...

virtual void	sendMessage (DtBaseMessage &request)
	Sends a message to the server Application. More...

virtual DtMessageHandler &	messageHandler ()
	Get the message handler the connector is using to dispatch messages when they arrive users will register their delegates with the message handler to execute their code when a message is received. More...

virtual void	addConnectedCallback (const DtConnectionDelegate &delegate)
	Adds a callback for when a connection to a server succeeds. More...

virtual void	removeConnectedCallback (const DtConnectionDelegate &delegate)
	Removes connection callback. More...

virtual void	addDisconnectedCallback (const DtConnectionDelegate &delegate)
	Adds a callback for when disconnected to a server. More...

virtual void	removeDisconnectedCallback (const DtConnectionDelegate &delegate)
	Removes disconnection callback. More...

virtual DtMessageFactory &	messageFactory ()
	Gets the message factory for all messages. More...

virtual unsigned int	nextId ()
	You can use this to get the next id for a message if your callback system needs to keep track of responses if any message being sent leaves the id field as 0, this function will be used to generate an id. More...

virtual std::string &	requesterName ()
	this provides a unique name for the requester. More...

Static Public Member Functions
static double	defaultRetryTimeout ()
	The default timeout for retrying. The default value is 5. More...

static void	setDefaultRetryTimeout (double val)
	Sets the default retry timout. Value is in seconds. More...

static double	defaultHeartbeatTimeout ()
	the default hearbeat timeout. The default is 2.5 seconds. More...

static void	setDefaultHeatbeatTimeout (double val)
	sets the default heartbeat timeout. Value is in seconds. More...

Protected Member Functions
DtInetAddr	findFirstNetworkDeviceAddress (bool &found) const

Static Protected Member Functions
static void	workerFunction (void data, volatile bool stop)

Protected Attributes
DtMessageHandler	myMessageHandler

std::list< DtConnectionDelegate >	myConnectionCallbacks

std::list< DtConnectionDelegate >	myDisconnectionCallbacks

DtMessageFactory	myMessageFactory

unsigned int	myNextId

std::string	myRequestorName

DtLocklessQueue< DtBaseMessage * >	myOutgoingQueue

DtLocklessQueue< DtBaseMessage * >	myIncomingQueue

DtThread *	myWorkerThread

DtInetTcpSocket *	mySocket

bool	myShouldRetryConnect

double	myRetryTimeout

std::string	myAddress

std::string	mySimAddress

int	myPort

bool	myShouldQuit

Static Protected Attributes
static double	theDefaultHeatbeatTimeout

static double	theDefaultRetryTimeout

Detailed Description

The DtDebugDrawConnector class manages the connection with the server and provides and interface to send and receive messages with the server.

Member Typedef Documentation

typedef DtDelegate<void, DtDebugDrawConnector*> makVrf::DtDebugDrawConnector::DtConnectionDelegate

Connection callback definition.

Constructor & Destructor Documentation

makVrf::DtDebugDrawConnector::DtDebugDrawConnector ( )

constructor/destructor

virtual makVrf::DtDebugDrawConnector::~DtDebugDrawConnector ( )

virtual

Member Function Documentation

virtual void makVrf::DtDebugDrawConnector::connect	(	const std::string &	address,
		int	port = `DtDisplayPort`,
		const std::string &	simAddress = `""`,
		bool	attemptRetry = `true`
	)

virtual

this establishes a connection to a remote RadarFX server at a given address and port the connection callback will be run when a connection is made.

It will continue to retry if there is a failure to connect or the connector gets disconnected if attemptRetry is true

virtual void makVrf::DtDebugDrawConnector::disconnect ( )

virtual

Disconnects from a RadarFX server.

virtual bool makVrf::DtDebugDrawConnector::isOk ( )

virtual

Returns true of the connection has succeed and is valid.

virtual void makVrf::DtDebugDrawConnector::tick ( )

virtual

Tick must be called periodically to allow message callbacks to be run.

virtual void makVrf::DtDebugDrawConnector::sendMessage ( DtBaseMessage & request )

virtual

Sends a message to the server Application.

A copy of the message is made internally, so the message being sent can go out of scope immediately after sendMessage is called.

virtual DtMessageHandler& makVrf::DtDebugDrawConnector::messageHandler ( )

inlinevirtual

Get the message handler the connector is using to dispatch messages when they arrive users will register their delegates with the message handler to execute their code when a message is received.

virtual void makVrf::DtDebugDrawConnector::addConnectedCallback ( const DtConnectionDelegate & delegate )

virtual

Adds a callback for when a connection to a server succeeds.

virtual void makVrf::DtDebugDrawConnector::removeConnectedCallback ( const DtConnectionDelegate & delegate )

virtual

Removes connection callback.

virtual void makVrf::DtDebugDrawConnector::addDisconnectedCallback ( const DtConnectionDelegate & delegate )

virtual

Adds a callback for when disconnected to a server.

virtual void makVrf::DtDebugDrawConnector::removeDisconnectedCallback ( const DtConnectionDelegate & delegate )

virtual

Removes disconnection callback.

virtual DtMessageFactory& makVrf::DtDebugDrawConnector::messageFactory ( )

inlinevirtual

Gets the message factory for all messages.

The user can add new message decoders to this factory

virtual unsigned int makVrf::DtDebugDrawConnector::nextId ( )

virtual

You can use this to get the next id for a message if your callback system needs to keep track of responses if any message being sent leaves the id field as 0, this function will be used to generate an id.

virtual std::string& makVrf::DtDebugDrawConnector::requesterName ( )

virtual

this provides a unique name for the requester.

It is generated from the IP address and PID of the running application if any message being sent leaves the requester field blank, this function will be used to generate a requester names

static double makVrf::DtDebugDrawConnector::defaultRetryTimeout ( )

static

The default timeout for retrying. The default value is 5.

static void makVrf::DtDebugDrawConnector::setDefaultRetryTimeout ( double val )

static

Sets the default retry timout. Value is in seconds.

static double makVrf::DtDebugDrawConnector::defaultHeartbeatTimeout ( )

static

the default hearbeat timeout. The default is 2.5 seconds.

static void makVrf::DtDebugDrawConnector::setDefaultHeatbeatTimeout ( double val )

static

sets the default heartbeat timeout. Value is in seconds.

DtInetAddr makVrf::DtDebugDrawConnector::findFirstNetworkDeviceAddress ( bool & found ) const

protected

static void makVrf::DtDebugDrawConnector::workerFunction	(	void *	data,
		volatile bool *	stop
	)

staticprotected

Member Data Documentation

DtMessageHandler makVrf::DtDebugDrawConnector::myMessageHandler

protected

std::list<DtConnectionDelegate> makVrf::DtDebugDrawConnector::myConnectionCallbacks

protected

std::list<DtConnectionDelegate> makVrf::DtDebugDrawConnector::myDisconnectionCallbacks

protected

DtMessageFactory makVrf::DtDebugDrawConnector::myMessageFactory

protected

unsigned int makVrf::DtDebugDrawConnector::myNextId

protected

std::string makVrf::DtDebugDrawConnector::myRequestorName

protected

DtLocklessQueue<DtBaseMessage*> makVrf::DtDebugDrawConnector::myOutgoingQueue

protected

DtLocklessQueue<DtBaseMessage*> makVrf::DtDebugDrawConnector::myIncomingQueue

protected

DtThread* makVrf::DtDebugDrawConnector::myWorkerThread

protected

DtInetTcpSocket* makVrf::DtDebugDrawConnector::mySocket

protected

bool makVrf::DtDebugDrawConnector::myShouldRetryConnect

protected

double makVrf::DtDebugDrawConnector::myRetryTimeout

protected

std::string makVrf::DtDebugDrawConnector::myAddress

protected

std::string makVrf::DtDebugDrawConnector::mySimAddress

protected

int makVrf::DtDebugDrawConnector::myPort

protected

bool makVrf::DtDebugDrawConnector::myShouldQuit

protected

double makVrf::DtDebugDrawConnector::theDefaultHeatbeatTimeout

staticprotected

double makVrf::DtDebugDrawConnector::theDefaultRetryTimeout

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfDebugDrawConnector/vrfDebugDrawConnector.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation