DtWebSpyUtils holds utility functions used throughout the webspy. More...

Collaboration diagram for DtWebSpyUtils:

Classes
class	ConnectionIdentifier
	The ConnectionIdentifier class stores the basic information needed by the web client to identify a web server connection. More...
class	ConnectionState
	The ConnectionState class stores the current state of a web spy connection If the connection has enabled forwarding, then the state may include multiple component states forwarded through the connection The ConnectionState object may be used to represent the complete state of a connection or the state of a single component of a connection (generally for state updates) More...
Public Types
enum	WwwControlMsgCommandId { DtTypeInfoCntlMsg, DtRequestStateUpdateMsg, DtLrcLogEventsMsg, DtDeleteFederateCmdMsg, DtDestroyFederationCmdMsg, DtChangeRidParamMsg, DtUndiscoverObjectMsg, DtNetworkMapMsg, DtUnknownCntlMsg }
	Web Spy Control Message IDs. More...
enum	ConnectionType { DtRtiExecConnection = 0, DtLrcConnection, DtForwarderConnection, DtRtiExecConnectionLightweight, DtLrcConnectionLightweight, DtUnknownConnectionType }
	RTI component connection types handled by the web server. More...
enum	StateComponentType { DtBaseStateType = 0, DtFomStateType, DtRidStateType, DtPubSubStateType, DtOwnershipStateType, DtInteractionStateType, DtObjectInterStatsStateType, DtApiStatsStateType, DtMessageStatsStateType, DtNetworkMapStateType }
	State Components which may be requested from RTI components. More...
Static Public Member Functions
static DtRIDParameters &	params ()
static const MAKRti::DtString &	uninitializedPageHTML ()
static MAKRti::DtFilename	getPathToHtmlRoot (const MAKRti::DtFilename &subDir="")
static MAKRti::DtFilename	pathSeparator ()
static bool	readTextFileIntoString (const MAKRti::DtFilename &pathToFile, MAKRti::DtString &target)
static bool	readBinaryFileIntoBuffer (const MAKRti::DtFilename &pathToFile, std::vector< char > &target)
static void	setPathToXmlPage (MAKRti::DtString &page, const MAKRti::DtString &pathToXmlPage)
static bool	isValidBinaryFileType (const MAKRti::DtFilename &filename)
static bool	isValidTextFileType (const MAKRti::DtFilename &filename)
static const MAKRti::DtString &	htmlContentTypeForFile (const MAKRti::DtFilename &filename)
static const MAKRti::DtString &	connectionTypeString (ConnectionType connType)
Static Protected Member Functions
static void	initialize ()
Static Protected Attributes
static MAKRti::DtFilename *	thePathToHtmlRoot = 0
static bool	theInitializationComplete = false
static std::map < MAKRti::DtString, MAKRti::DtString > *	theBinaryFileTypesToContentTypeMap = 0
static std::map < MAKRti::DtString, MAKRti::DtString > *	theTextFileTypesToContentTypeMap = 0

Detailed Description

DtWebSpyUtils holds utility functions used throughout the webspy.

Member Enumeration Documentation

enum DtWebSpyUtils::ConnectionType

RTI component connection types handled by the web server.

Enumerator:

DtRtiExecConnection
DtLrcConnection
DtForwarderConnection
DtRtiExecConnectionLightweight
DtLrcConnectionLightweight
DtUnknownConnectionType

enum DtWebSpyUtils::StateComponentType

State Components which may be requested from RTI components.

Enumerator:

DtBaseStateType
DtFomStateType
DtRidStateType
DtPubSubStateType
DtOwnershipStateType
DtInteractionStateType
DtObjectInterStatsStateType
DtApiStatsStateType
DtMessageStatsStateType
DtNetworkMapStateType

enum DtWebSpyUtils::WwwControlMsgCommandId

Web Spy Control Message IDs.

Enumerator:

DtTypeInfoCntlMsg
DtRequestStateUpdateMsg
DtLrcLogEventsMsg
DtDeleteFederateCmdMsg
DtDestroyFederationCmdMsg
DtChangeRidParamMsg
DtUndiscoverObjectMsg
DtNetworkMapMsg
DtUnknownCntlMsg

Member Function Documentation

const MAKRti::DtString & DtWebSpyUtils::connectionTypeString ( DtWebSpyUtils::ConnectionType connType ) [static]

Referenced by DtWebSpyRtiConnectionMgr::createDescription().

MAKRti::DtFilename DtWebSpyUtils::getPathToHtmlRoot ( const MAKRti::DtFilename & subDir = "" ) [static]

Referenced by DtAboutHTML::DtAboutHTML(), DtServerConnectionListXML::DtServerConnectionListXML(), DtWwwDocRoot::DtWwwDocRoot(), DtWwwDocSubDir::DtWwwDocSubDir(), DtWwwDocSubDir::HandleFileRequest(), DtBasicEhsDoc::HandleFileRequest(), DtFederateXML::initializePage(), DtForwarderXML::initializePage(), and DtFederationXML::initializePage().

const MAKRti::DtString & DtWebSpyUtils::htmlContentTypeForFile ( const MAKRti::DtFilename & filename ) [static]

Referenced by DtWwwDocSubDir::HandleFileRequest(), and DtBasicEhsDoc::HandleFileRequest().

void DtWebSpyUtils::initialize ( ) [static, protected]

References initContentTypeMap(), and lookupPathToHtmlRoot().

bool DtWebSpyUtils::isValidBinaryFileType ( const MAKRti::DtFilename & filename ) [static]

Referenced by DtWwwDocSubDir::HandleFileRequest(), and DtBasicEhsDoc::HandleFileRequest().

bool DtWebSpyUtils::isValidTextFileType ( const MAKRti::DtFilename & filename ) [static]

Referenced by DtWwwDocSubDir::HandleFileRequest(), and DtBasicEhsDoc::HandleFileRequest().

DtRIDParameters & DtWebSpyUtils::params ( ) [static]

MAKRti::DtFilename DtWebSpyUtils::pathSeparator ( ) [static]

Referenced by lookupPathToHtmlRoot().

bool DtWebSpyUtils::readBinaryFileIntoBuffer	(	const MAKRti::DtFilename &	pathToFile,
		std::vector< char > &	target
	)		`[static]`

Referenced by DtWwwDocSubDir::HandleFileRequest(), and DtBasicEhsDoc::HandleFileRequest().

bool DtWebSpyUtils::readTextFileIntoString	(	const MAKRti::DtFilename &	pathToFile,
		MAKRti::DtString &	target
	)		`[static]`

Referenced by DtAboutHTML::DtAboutHTML(), DtServerConnectionListXML::DtServerConnectionListXML(), DtWwwDocRoot::DtWwwDocRoot(), DtWwwDocSubDir::DtWwwDocSubDir(), DtWwwDocSubDir::HandleFileRequest(), DtBasicEhsDoc::HandleFileRequest(), DtFederateXML::initializePage(), DtForwarderXML::initializePage(), and DtFederationXML::initializePage().

void DtWebSpyUtils::setPathToXmlPage	(	MAKRti::DtString &	page,
		const MAKRti::DtString &	pathToXmlPage
	)		`[static]`

Referenced by DtServerConnectionListXML::DtServerConnectionListXML().

const MAKRti::DtString & DtWebSpyUtils::uninitializedPageHTML ( ) [static]

Member Data Documentation

std::map< MAKRti::DtString, MAKRti::DtString > * DtWebSpyUtils::theBinaryFileTypesToContentTypeMap = 0 [static, protected]

bool DtWebSpyUtils::theInitializationComplete = false [static, protected]

MAKRti::DtFilename * DtWebSpyUtils::thePathToHtmlRoot = 0 [static, protected]

std::map< MAKRti::DtString, MAKRti::DtString > * DtWebSpyUtils::theTextFileTypesToContentTypeMap = 0 [static, protected]

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

Classes

Public Types

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation