MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtGsRtiConnection Class Reference

The DtGsRtiConnection class extends the DtRtiConnection class to allow messages to be sent to multiple stored destination addresses. More...

+ Inheritance diagram for DtGsRtiConnection:
+ Collaboration diagram for DtGsRtiConnection:

Public Member Functions

 DtGsRtiConnection (DtUdpMsgSocket *skt, const MAKRti::DtInetAddr &destAddr)
 Constructor Accepts pre-created DtNetSocket (or subclass) and default destination address to use when sending and receiving.
virtual ~DtGsRtiConnection ()
 Destructor.
virtual int send (const DtRtiMsg &msg, const MAKRti::DtInetAddr &destaddr)
 Send a message to the group socket destinations If the supplied destination is non zero, the message is sent to all destinations except the connection's default destination (if it happens to have been added as a destination to the group socket).
virtual void removeAllRemoteSites ()
 Clear the list of remote sites.
virtual void addRemoteSite (const MAKRti::DtInetAddr &addr)
 Add a destination address to the list.
virtual void removeRemoteSite (const MAKRti::DtInetAddr &addr)
 Remove a destination address from the list.
- Public Member Functions inherited from DtRtiConnection
 DtRtiConnection (DtMsgSocket *skt)
 Constructor.
virtual ~DtRtiConnection ()
 Destructor.
virtual void setMsgFactory (DtRtiMsgFactory *fact)
 Set/Get the Message Factory used by this object.
virtual DtRtiMsgFactoryrtiMsgFactory ()
virtual DtRtiMsgnetRead (DtNetReadStatus *retCode=NULL)
 Note: netRead() creates a new DtRtiMsg using the message factory Caller is responsible for deleting it when through.
virtual bool flush ()
 Send buffered messages.
virtual int isOk ()
 Return true if the status of the connection is OK.
virtual void setCheckVersion (bool enableCheckVersion)
 Set/get whether to check message version.
virtual bool checkVersion () const
virtual void disableCheckSize ()
 Disable message size check.
virtual void enableCheckSize ()
 Enable message size check.
virtual void setFedExName (const MAKRti::DtString &newFedExName)
 Set/Get federation execution name. NULL means "all".
virtual const MAKRti::DtString & fedExName () const
virtual void setFedExHandle (int handle)
 Set/Get federation execution handle. 0 means "all".
virtual int fedExHandle () const
virtual void setFederateHandle (DtFederationHandle handle)
 Set/Get federate handle.
virtual DtFederationHandle federateHandle () const
virtual void setConnId (unsigned long connId)
 Set/Get the connection ID assigned to the connection.
virtual unsigned long connId () const
virtual DtMsgSocketsocket ()
 Returns our socket.

Protected Member Functions

virtual int sendToAllRemoteSites (caddr_t pkt, size_t size, const MAKRti::DtInetAddr &dwSkipAddr=MAKRti::DtInetAddr::inaddrAny())
 Send to all remote sites except dwSkipAddr.
- Protected Member Functions inherited from DtRtiConnection
void init (DtMsgSocket *s)

Protected Attributes

std::set< MAKRti::DtInetAddr > myRemoteSites
 List of DtInetAddrs (which do not need to be deleted).
MAKRti::DtInetAddr myDestAddr
 Default destination address. Should not be added to list of remote sites.
DtUdpMsgSocketmyGroupSocket
 Pointer to DtNetSocket (or subclass) object associated with connection.
- Protected Attributes inherited from DtRtiConnection
MAKRti::DtString myFedExName
int myFedExHandle
DtFederationHandle myFedHandle
DtMsgSocketmySocket
DtRtiMsgFactorymyMsgFact
unsigned long myReceivedMsgCount
bool myCheckSize
bool myCheckVersion
unsigned int myWaitEventIndex
unsigned long myConnId
 Win32 only.

Private Member Functions

 DtGsRtiConnection (const DtGsRtiConnection &)
 Copy CTOR Not implemented – Copy Not Allowed!
DtGsRtiConnectionoperator= (const DtGsRtiConnection &)
 Assignment operator not implemented – Assignment Not Allowed!

Detailed Description

The DtGsRtiConnection class extends the DtRtiConnection class to allow messages to be sent to multiple stored destination addresses.

This class accepts any type of DtUdpMsgSocket object, including instances of DtGroupSocket and DtCompressionSocket objects. It duplicates some of the functionality of the DtGroupSocket class.

Constructor & Destructor Documentation

DtGsRtiConnection::DtGsRtiConnection ( DtUdpMsgSocket skt,
const MAKRti::DtInetAddr &  destAddr 
)

Constructor Accepts pre-created DtNetSocket (or subclass) and default destination address to use when sending and receiving.

DtGsRtiConnection::~DtGsRtiConnection ( )
virtual

Destructor.

References removeAllRemoteSites().

DtGsRtiConnection::DtGsRtiConnection ( const DtGsRtiConnection )
private

Copy CTOR Not implemented – Copy Not Allowed!

Member Function Documentation

void DtGsRtiConnection::addRemoteSite ( const MAKRti::DtInetAddr &  addr)
virtual

Add a destination address to the list.

References myRemoteSites.

Referenced by DtConnectionMgr::createBestEffortConn().

DtGsRtiConnection& DtGsRtiConnection::operator= ( const DtGsRtiConnection )
private

Assignment operator not implemented – Assignment Not Allowed!

void DtGsRtiConnection::removeAllRemoteSites ( )
virtual

Clear the list of remote sites.

References myRemoteSites.

Referenced by ~DtGsRtiConnection().

void DtGsRtiConnection::removeRemoteSite ( const MAKRti::DtInetAddr &  addr)
virtual

Remove a destination address from the list.

References myRemoteSites.

int DtGsRtiConnection::send ( const DtRtiMsg msg,
const MAKRti::DtInetAddr &  destaddr 
)
virtual

Send a message to the group socket destinations If the supplied destination is non zero, the message is sent to all destinations except the connection's default destination (if it happens to have been added as a destination to the group socket).

The message is then sent to the supplied destination address.

Reimplemented from DtRtiConnection.

References DtUseFedObservers, DtNetMsgHeader::flags, myDestAddr, myGroupSocket, DtRtiMsg::netHeader(), DtUdpMsgSocket::sendMessage(), and sendToAllRemoteSites().

int DtGsRtiConnection::sendToAllRemoteSites ( caddr_t  pkt,
size_t  size,
const MAKRti::DtInetAddr &  dwSkipAddr = MAKRti::DtInetAddr::inaddrAny() 
)
protectedvirtual

Send to all remote sites except dwSkipAddr.

References myGroupSocket, myRemoteSites, and DtUdpMsgSocket::sendMessage().

Referenced by send().

Member Data Documentation

MAKRti::DtInetAddr DtGsRtiConnection::myDestAddr
protected

Default destination address. Should not be added to list of remote sites.

Referenced by send().

DtUdpMsgSocket* DtGsRtiConnection::myGroupSocket
protected

Pointer to DtNetSocket (or subclass) object associated with connection.

Referenced by send(), and sendToAllRemoteSites().

std::set<MAKRti::DtInetAddr> DtGsRtiConnection::myRemoteSites
protected

List of DtInetAddrs (which do not need to be deleted).

Referenced by addRemoteSite(), removeAllRemoteSites(), removeRemoteSite(), and sendToAllRemoteSites().


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

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)