DtConnectConfirmMsg Class Reference

Inheritance diagram for DtConnectConfirmMsg:

Collaboration diagram for DtConnectConfirmMsg:

Public Member Functions
	DtConnectConfirmMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtConnectConfirmMsg (const DtNetConnectConfirmMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtConnectConfirmMsg (DtHandle origHandle, DtHandle finalHandle, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtConnectConfirmMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtHandle origHandle, DtHandle finalHandle)
	Set all fields simultaneously.
virtual DtHandle	origConnectionHandle () const
	Set get original connection handle.
virtual void	setOrigConnectionHandle (DtHandle handle)
virtual DtHandle	finalConnectionHandle () const
	Set get final connection handle.
virtual void	setFinalConnectionHandle (DtHandle handle)
virtual MAKRti::DtInetAddr	webServerAddress () const
	Set/Get the federate's web server IP address.
virtual void	setWebServerAddress (const MAKRti::DtInetAddr &ip)
virtual int	webServerPort () const
	Get/Set the federate's web server HTTP port.
virtual void	setWebServerPort (int port)
virtual int	processId () const
	Get/Set the federates process ID.
virtual void	setProcessId (int pid)
void	setCompressionEnabled (bool enabled)
	Set/Get whether compression is enabled.
bool	compressionEnabled () const
void	setCompressionLevel (unsigned level)
	Set/Get the compression level.
unsigned	compressionLevel () const
void	setBundlingEnabled (bool enabled)
	Set/Get whether bundling is enabled.
bool	bundlingEnabled () const
void	setBundleSize (unsigned size)
	Set/Get the bundle size.
unsigned	bundleSize () const
virtual MAKRti::DtString	processName () const
	Get/Set the federates process Name.
virtual void	setProcessName (MAKRti::DtString processName)
virtual MAKRti::DtString	commandArgs () const
	Get/Set the command line arguments.
virtual void	setCommandArgs (MAKRti::DtString commandArgs)
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor.
virtual DtRtiMsg *	cloneWithTransport (bool copy=true) const
	Return a copy/empty object of the same type as this using clone and set the transport type from the host message.
virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to.
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle.
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind	msgKind () const
	Get the message kind.
virtual const char *	kindString () const
	Returns the message kind string name.
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained?
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save?
virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages.
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid.
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type.
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order.
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object.
virtual bool	addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata.
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed.
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types.
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions.
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char *label, RTI::FedTime const *timeValue) const
	Print the given time.
virtual void	printInterval (const char *label, RTI::FedTime const *intervalValue) const
	Print the interval.
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec().
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle.
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle.
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number.
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number.
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number.
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number.
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtConnectConfirmCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtConnectConfirmCb cb, void *usr, bool isMomCallback=false)
Static Public Member Functions inherited from DtRtiMsg
static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration.
static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name.
static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle.
static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values.
static bool	use32BitsForValueSize ()
static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled?
static bool	smartForwardingEnabled ()

Protected Member Functions
virtual DtNetConnectConfirmMsg *	netConnectConfirmMsg ()
	The network representation.
virtual const DtNetConnectConfirmMsg *	netConnectConfirmMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Connect Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtConnectConfirmMsg *	self () const
	Casts away const-ness.
virtual const char *	processNamePtr () const
	Get the pointer to the process name data.
virtual char *	processNamePtr ()
virtual unsigned long	processNameSize () const
	Set/Get the size of the process name string.
virtual void	setProcessNameSize (unsigned long size)
virtual const char *	commandArgsPtr () const
	Get the pointer to the command args data.
virtual char *	commandArgsPtr ()
virtual unsigned long	commandArgsSize () const
	Set/Get the size of the command Args string.
virtual void	setCommandArgsSize (unsigned long size)
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
void	initDtRtiMsg (const DtNetMsgHeader *header, DtBufferPtr buffer)
virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres.

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle = 0
static const char *	theDefaultTag = NULL
Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType
DtOrderHandle	myOrderType
RTI::FedTime *	myFedTime
bool	myTimeIsValid
bool	myConstrained
bool	myAllowedDuringSave
unsigned long	mySerialNumber
unsigned long	myServiceCallNumber
unsigned long	myTriggerMessage
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize = false
static bool	theSmartForwardingEnabled = false

Constructor & Destructor Documentation

DtConnectConfirmMsg::DtConnectConfirmMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setWebServerAddress(), and setWebServerPort().

Referenced by clone(), and create().

DtConnectConfirmMsg::DtConnectConfirmMsg	(	const DtNetConnectConfirmMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

References DtNetConnectConfirmMsg::header, DtRtiMsg::initDtRtiMsg(), and DtNetMsgHeader::totalSize.

DtConnectConfirmMsg::DtConnectConfirmMsg	(	DtHandle	origHandle,
		DtHandle	finalHandle,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setWebServerAddress(), and setWebServerPort().

DtConnectConfirmMsg::~DtConnectConfirmMsg ( )

virtual

Destructor.

Member Function Documentation

void DtConnectConfirmMsg::addCallback ( DtConnectionMgr *  conn, DtConnectConfirmCb  cb, void *  usr, bool  isMomCallback = false  )

static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtConnectConfirmMsgKind.

unsigned DtConnectConfirmMsg::bundleSize

(

)

const

References DtNetConnectConfirmMsg::bundleSize, and netConnectConfirmMsg().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

bool DtConnectConfirmMsg::bundlingEnabled

(

)

const

References DtNetConnectConfirmMsg::enableBundling, and netConnectConfirmMsg().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

DtRtiMsg * DtConnectConfirmMsg::clone ( bool  copy = true ) const

virtual

Return a copy/empty object of the same type as this.

Implements DtRtiMsg.

References DtConnectConfirmMsg(), and netConnectConfirmMsg().

MAKRti::DtString DtConnectConfirmMsg::commandArgs ( ) const

virtual

Get/Set the command line arguments.

Get/Set the federates process Name.

References commandArgsPtr(), and commandArgsSize().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg().

const char * DtConnectConfirmMsg::commandArgsPtr ( ) const

protectedvirtual

Get the pointer to the command args data.

Get the pointer to the process name data.

References processNamePtr(), and processNameSize().

Referenced by commandArgs(), and setCommandArgs().

char * DtConnectConfirmMsg::commandArgsPtr ( )

protectedvirtual

References processNamePtr(), and processNameSize().

unsigned long DtConnectConfirmMsg::commandArgsSize ( ) const

protectedvirtual

Set/Get the size of the command Args string.

Get the size of the process name string.

References DtNetConnectConfirmMsg::commandArgsSize, and netConnectConfirmMsg().

Referenced by commandArgs(), and setCommandArgs().

bool DtConnectConfirmMsg::compressionEnabled

(

)

const

References DtNetConnectConfirmMsg::enableCompression, and netConnectConfirmMsg().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

unsigned DtConnectConfirmMsg::compressionLevel

(

)

const

References DtNetConnectConfirmMsg::compressionLevel, and netConnectConfirmMsg().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

DtRtiMsg * DtConnectConfirmMsg::create ( const DtNetMsgHeader *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Creator.

References DtConnectConfirmMsg().

DtRtiMsg * DtConnectConfirmMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER )

static

References DtConnectConfirmMsg().

DtHandle DtConnectConfirmMsg::finalConnectionHandle ( ) const

virtual

Set get final connection handle.

References DtNetConnectConfirmMsg::finalConnectionId, and netConnectConfirmMsg().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

DtRtiMsgKind DtConnectConfirmMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Connect Msg.

Implements DtRtiMsg.

References DtConnectConfirmMsgKind.

Referenced by DtConnectConfirmMsg().

int DtConnectConfirmMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtConnectConfirmMsg().

DtNetConnectConfirmMsg * DtConnectConfirmMsg::netConnectConfirmMsg ( )

protectedvirtual

The network representation.

Referenced by bundleSize(), bundlingEnabled(), clone(), commandArgsSize(), compressionEnabled(), compressionLevel(), finalConnectionHandle(), origConnectionHandle(), processId(), processNamePtr(), processNameSize(), setBundleSize(), setBundlingEnabled(), setCommandArgsSize(), setCompressionEnabled(), setCompressionLevel(), setFinalConnectionHandle(), setOrigConnectionHandle(), setProcessId(), setProcessNameSize(), setWebServerAddress(), setWebServerPort(), webServerAddress(), and webServerPort().

const DtNetConnectConfirmMsg * DtConnectConfirmMsg::netConnectConfirmMsg ( ) const

protectedvirtual

DtHandle DtConnectConfirmMsg::origConnectionHandle ( ) const

virtual

Set get original connection handle.

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::origConnectionId.

Referenced by printData().

void DtConnectConfirmMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References bundleSize(), bundlingEnabled(), compressionEnabled(), compressionLevel(), finalConnectionHandle(), origConnectionHandle(), processId(), processName(), webServerAddress(), and webServerPort().

int DtConnectConfirmMsg::processId ( ) const

virtual

Get/Set the federates process ID.

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::processId.

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

MAKRti::DtString DtConnectConfirmMsg::processName ( ) const

virtual

Get/Set the federates process Name.

References processNamePtr(), and processNameSize().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

const char * DtConnectConfirmMsg::processNamePtr ( ) const

protectedvirtual

Get the pointer to the process name data.

References netConnectConfirmMsg().

Referenced by commandArgsPtr(), processName(), and setProcessName().

char * DtConnectConfirmMsg::processNamePtr ( )

protectedvirtual

References netConnectConfirmMsg().

unsigned long DtConnectConfirmMsg::processNameSize ( ) const

protectedvirtual

Set/Get the size of the process name string.

Get the size of the process name string.

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::processNameSize.

Referenced by commandArgsPtr(), processName(), and setProcessName().

void DtConnectConfirmMsg::removeCallback ( DtConnectionMgr *  conn, DtConnectConfirmCb  cb, void *  usr, bool  isMomCallback = false  )

static

References DtConnectConfirmMsgKind, and DtConnectionMgr::removeMsgCallback().

DtConnectConfirmMsg * DtConnectConfirmMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtConnectConfirmMsg::set ( DtHandle  origHandle, DtHandle  finalHandle  )

virtual

Set all fields simultaneously.

References setFinalConnectionHandle(), and setOrigConnectionHandle().

void DtConnectConfirmMsg::setBundleSize

(

unsigned

size

)

Set/Get the bundle size.

References DtNetConnectConfirmMsg::bundleSize, and netConnectConfirmMsg().

Referenced by DtConnectionMgr::createAncillaryRelConns(), and DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setBundlingEnabled

(

bool

enabled

)

Set/Get whether bundling is enabled.

References DtNetConnectConfirmMsg::enableBundling, and netConnectConfirmMsg().

Referenced by DtConnectionMgr::createAncillaryRelConns(), and DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setCommandArgs ( MAKRti::DtString  commandArgs )

virtual

References commandArgsPtr(), commandArgsSize(), rti1516e::insertBytes(), and setCommandArgsSize().

Referenced by DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setCommandArgsSize ( unsigned long  size )

protectedvirtual

References DtNetConnectConfirmMsg::commandArgsSize, and netConnectConfirmMsg().

Referenced by setCommandArgs().

void DtConnectConfirmMsg::setCompressionEnabled

(

bool

enabled

)

Set/Get whether compression is enabled.

References DtNetConnectConfirmMsg::enableCompression, and netConnectConfirmMsg().

Referenced by DtConnectionMgr::createAncillaryRelConns(), and DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setCompressionLevel

(

unsigned

level

)

Set/Get the compression level.

References DtNetConnectConfirmMsg::compressionLevel, and netConnectConfirmMsg().

Referenced by DtConnectionMgr::createAncillaryRelConns(), and DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setFinalConnectionHandle ( DtHandle  handle )

virtual

References DtNetConnectConfirmMsg::finalConnectionId, and netConnectConfirmMsg().

Referenced by set().

void DtConnectConfirmMsg::setOrigConnectionHandle ( DtHandle  handle )

virtual

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::origConnectionId.

Referenced by set().

void DtConnectConfirmMsg::setProcessId ( int  pid )

virtual

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::processId.

Referenced by DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setProcessName ( MAKRti::DtString  processName )

virtual

References rti1516e::insertBytes(), processNamePtr(), processNameSize(), and setProcessNameSize().

Referenced by DtConnectionMgr::createRelConn().

void DtConnectConfirmMsg::setProcessNameSize ( unsigned long  size )

protectedvirtual

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::processNameSize.

Referenced by setProcessName().

void DtConnectConfirmMsg::setWebServerAddress ( const MAKRti::DtInetAddr &  ip )

virtual

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::webServerAddr.

Referenced by DtConnectConfirmMsg().

void DtConnectConfirmMsg::setWebServerPort ( int  port )

virtual

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::webServerPort.

Referenced by DtConnectConfirmMsg().

MAKRti::DtInetAddr DtConnectConfirmMsg::webServerAddress ( ) const

virtual

Set/Get the federate's web server IP address.

References netConnectConfirmMsg().

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

int DtConnectConfirmMsg::webServerPort ( ) const

virtual

Get/Set the federate's web server HTTP port.

References netConnectConfirmMsg(), and DtNetConnectConfirmMsg::webServerPort.

Referenced by DtConnectConfirmFilter::handleConnectConfirmMsg(), and printData().

---

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

• connectConfirmMsg.h
• connectConfirmMsg.cxx