DtRtiConnection Class Reference

This class represents a network connection with another RTI component. More...

Inheritance diagram for DtRtiConnection:

Collaboration diagram for DtRtiConnection:

Public Member Functions
	DtRtiConnection (DtMsgSocket *skt)
	Constructor. More...
virtual	~DtRtiConnection ()
	Destructor. More...
virtual void	setMsgFactory (DtRtiMsgFactory *fact)
	Set/Get the Message Factory used by this object. More...
virtual DtRtiMsgFactory *	rtiMsgFactory ()
virtual DtRtiMsg *	netRead (DtNetReadStatus *retCode=NULL)
	Note: netRead() creates a new DtRtiMsg using the message factory Caller is responsible for deleting it when through. More...
virtual int	send (const DtRtiMsg &msg, const MAKRti::DtInetAddr &addr=MAKRti::DtInetAddr())
	Send a message. More...
virtual bool	flush ()
	Send buffered messages. More...
virtual int	isOk ()
	Return true if the status of the connection is OK. More...
virtual void	setCheckVersion (bool enableCheckVersion)
	Set/get whether to check message version. More...
virtual bool	checkVersion () const
virtual void	disableCheckSize ()
	Disable message size check. More...
virtual void	enableCheckSize ()
	Enable message size check. More...
virtual void	setFedExName (const MAKRti::DtString &newFedExName)
	Set/Get federation execution name. NULL means "all". More...
virtual const MAKRti::DtString &	fedExName () const
virtual void	setFedExHandle (int handle)
	Set/Get federation execution handle. 0 means "all". More...
virtual int	fedExHandle () const
virtual void	setFederateHandle (DtFederationHandle handle)
	Set/Get federate handle. More...
virtual DtFederationHandle	federateHandle () const
virtual void	setConnId (unsigned long connId)
	Set/Get the connection ID assigned to the connection. More...
virtual unsigned long	connId () const
virtual DtMsgSocket *	socket ()
	Returns our socket. More...

Protected Member Functions
void	init (DtMsgSocket *s)

Protected Attributes
MAKRti::DtString	myFedExName
int	myFedExHandle
DtFederationHandle	myFedHandle
DtMsgSocket *	mySocket
DtRtiMsgFactory *	myMsgFact
unsigned long	myReceivedMsgCount
bool	myCheckSize
bool	myCheckVersion
unsigned int	myWaitEventIndex
unsigned long	myConnId
	Win32 only. More...

Private Member Functions
	DtRtiConnection (const DtRtiConnection &orig)
	Copy CTOR not implemented. More...
DtRtiConnection &	operator= (DtRtiConnection const &orig)
	Assignment Operator not implemented. More...

Detailed Description

This class represents a network connection with another RTI component.

Constructor & Destructor Documentation

DtRtiConnection::DtRtiConnection

(

DtMsgSocket *

skt

)

Constructor.

virtual DtRtiConnection::~DtRtiConnection ( )

virtual

Destructor.

DtRtiConnection::DtRtiConnection ( const DtRtiConnection &  orig )

private

Copy CTOR not implemented.

Member Function Documentation

virtual bool DtRtiConnection::checkVersion ( ) const

virtual

unsigned long DtRtiConnection::connId ( ) const

inlinevirtual

References myConnId.

Referenced by setConnId().

virtual void DtRtiConnection::disableCheckSize ( )

virtual

Disable message size check.

virtual void DtRtiConnection::enableCheckSize ( )

virtual

Enable message size check.

DtFederationHandle DtRtiConnection::federateHandle ( ) const

inlinevirtual

References myFedHandle.

int DtRtiConnection::fedExHandle ( ) const

inlinevirtual

References myFedExHandle.

const MAKRti::DtString & DtRtiConnection::fedExName ( ) const

inlinevirtual

References myFedExName.

virtual bool DtRtiConnection::flush ( )

virtual

Send buffered messages.

Returns indication of whether the flush is complete or incomplete.

Reimplemented in DtSmRtiConnection.

void DtRtiConnection::init ( DtMsgSocket *  s )

protected

virtual int DtRtiConnection::isOk ( )

virtual

Return true if the status of the connection is OK.

virtual DtRtiMsg* DtRtiConnection::netRead ( DtNetReadStatus *  retCode = NULL )

virtual

Note: netRead() creates a new DtRtiMsg using the message factory Caller is responsible for deleting it when through.

DtRtiConnection& DtRtiConnection::operator= ( DtRtiConnection const &  orig )

private

Assignment Operator not implemented.

DtRtiMsgFactory * DtRtiConnection::rtiMsgFactory ( )

inlinevirtual

References myMsgFact.

virtual int DtRtiConnection::send ( const DtRtiMsg &  msg, const MAKRti::DtInetAddr &  addr = MAKRti::DtInetAddr()  )

virtual

Send a message.

Reimplemented in DtGsRtiConnection, and DtSmRtiConnection.

virtual void DtRtiConnection::setCheckVersion ( bool  enableCheckVersion )

virtual

Set/get whether to check message version.

This connection will filter invalid versions when enabled.

void DtRtiConnection::setConnId ( unsigned long  connId )

inlinevirtual

Set/Get the connection ID assigned to the connection.

References connId(), and myConnId.

void DtRtiConnection::setFederateHandle ( DtFederationHandle  handle )

inlinevirtual

Set/Get federate handle.

References myFedHandle.

void DtRtiConnection::setFedExHandle ( int  handle )

inlinevirtual

Set/Get federation execution handle. 0 means "all".

References myFedExHandle.

void DtRtiConnection::setFedExName ( const MAKRti::DtString &  newFedExName )

inlinevirtual

Set/Get federation execution name. NULL means "all".

References myFedExName.

virtual void DtRtiConnection::setMsgFactory ( DtRtiMsgFactory *  fact )

virtual

Set/Get the Message Factory used by this object.

fact becomes property of this object, meaning it will be deleted when the factory is replaced, or when the DtRtiConnection is destroyed.

DtMsgSocket * DtRtiConnection::socket ( )

inlinevirtual

Returns our socket.

References mySocket.

Member Data Documentation

bool DtRtiConnection::myCheckSize

protected

bool DtRtiConnection::myCheckVersion

protected

unsigned long DtRtiConnection::myConnId

protected

Win32 only.

Referenced by connId(), and setConnId().

int DtRtiConnection::myFedExHandle

protected

Referenced by fedExHandle(), and setFedExHandle().

MAKRti::DtString DtRtiConnection::myFedExName

protected

Referenced by fedExName(), and setFedExName().

DtFederationHandle DtRtiConnection::myFedHandle

protected

Referenced by federateHandle(), and setFederateHandle().

DtRtiMsgFactory* DtRtiConnection::myMsgFact

protected

Referenced by rtiMsgFactory().

unsigned long DtRtiConnection::myReceivedMsgCount

protected

DtMsgSocket* DtRtiConnection::mySocket

protected

Referenced by socket().

unsigned int DtRtiConnection::myWaitEventIndex

protected

---

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

• connection.h