MAK RTIspy API Documentation for HLA 1.3
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
DtEhsHttpConnectionMgr Class Reference
+ Inheritance diagram for DtEhsHttpConnectionMgr:
+ Collaboration diagram for DtEhsHttpConnectionMgr:

List of all members.

Public Member Functions

 DtEhsHttpConnectionMgr (DtWebSpyServer &parent)
virtual ~DtEhsHttpConnectionMgr ()
virtual void tick (unsigned int timeout=0)
 Offer the web server processing time and Gets command messages from the HTTP server.
virtual void postCommand (const DtWebSpyUtils::ConnectionIdentifier &connInfo, std::auto_ptr< DtString > command)
virtual void addConnection (const DtWebSpyUtils::ConnectionIdentifier &connInfo)
 Add a new RTI object with associated connection information.
virtual void updateConnection (const DtWebSpyUtils::ConnectionIdentifier &connInfo, std::auto_ptr< DtWebSpyUtils::ConnectionState > connState, bool appendToExisting)
 Update the state of an individual component behind an existing web server connection.
virtual void appendConnectionLogEvent (const DtWebSpyUtils::ConnectionIdentifier &connInfo, unsigned long componentId, DtLrcConsoleLogXmlBlockSP logSegmentSP)
 Update the event log of an individual component behind an existing web server connection.
virtual void removeConnection (const DtWebSpyUtils::ConnectionIdentifier &connInfo, const DtString &dropNotificationMsg="")
 Remove a connection and replace it with a disconnect message when its corresponding connection is dropped Caller may specify additional information about the reason for the drop via the optional dropNotificationMsg (accepts HTML)

Static Public Member Functions

static DtWebSpyHttpConnectionMgrcreate (DtWebSpyServer &parent)
 Virtual constructor.

Protected Types

typedef std::pair
< DtWebSpyUtils::ConnectionIdentifier,
DtString * > 
WebSpyCommand
typedef DtThreadSafe
< std::deque< WebSpyCommand > > 
WebSpyCommandQ

Protected Member Functions

virtual WebSpyCommand getNextCommand ()

Protected Attributes

WebSpyCommandQ myWebCommandQ
std::auto_ptr< DtWwwDocRootmyDocumentRoot

Private Member Functions

 DtEhsHttpConnectionMgr (const DtEhsHttpConnectionMgr &)
DtEhsHttpConnectionMgroperator= (DtEhsHttpConnectionMgr &)

Member Typedef Documentation

typedef DtThreadSafe< std::deque< WebSpyCommand > > DtEhsHttpConnectionMgr::WebSpyCommandQ [protected]

Constructor & Destructor Documentation

Referenced by create().


Member Function Documentation

Add a new RTI object with associated connection information.

Implements DtWebSpyHttpConnectionMgr.

References myDocumentRoot.

void DtEhsHttpConnectionMgr::appendConnectionLogEvent ( const DtWebSpyUtils::ConnectionIdentifier connInfo,
unsigned long  componentId,
DtLrcConsoleLogXmlBlockSP  logSegmentSP 
) [virtual]

Update the event log of an individual component behind an existing web server connection.

  • events are timestamped so that client may request a sub-set of the logged events ( i.e. - the 50 most recent events )

Implements DtWebSpyHttpConnectionMgr.

References myDocumentRoot.

Virtual constructor.

Reimplemented from DtWebSpyHttpConnectionMgr.

References DtEhsHttpConnectionMgr().

References myWebCommandQ.

Referenced by tick().

DtEhsHttpConnectionMgr& DtEhsHttpConnectionMgr::operator= ( DtEhsHttpConnectionMgr ) [private]
void DtEhsHttpConnectionMgr::postCommand ( const DtWebSpyUtils::ConnectionIdentifier connInfo,
std::auto_ptr< DtString >  command 
) [virtual]
void DtEhsHttpConnectionMgr::removeConnection ( const DtWebSpyUtils::ConnectionIdentifier connInfo,
const DtString &  dropNotificationMsg = "" 
) [virtual]

Remove a connection and replace it with a disconnect message when its corresponding connection is dropped Caller may specify additional information about the reason for the drop via the optional dropNotificationMsg (accepts HTML)

Implements DtWebSpyHttpConnectionMgr.

References myDocumentRoot.

void DtEhsHttpConnectionMgr::tick ( unsigned int  timeout = 0) [virtual]

Offer the web server processing time and Gets command messages from the HTTP server.

  • commands from the HTTP server are simple xml command messages encoded by the client
  • commands must be decoded by the wwwSpyServer decoder

Implements DtWebSpyHttpConnectionMgr.

References getNextCommand(), DtWebSpyHttpConnectionMgr::myClock, DtWebSpyHttpConnectionMgr::myParent, and DtWebSpyServer::postHttpCommand().

void DtEhsHttpConnectionMgr::updateConnection ( const DtWebSpyUtils::ConnectionIdentifier connInfo,
std::auto_ptr< DtWebSpyUtils::ConnectionState connState,
bool  appendToExisting 
) [virtual]

Update the state of an individual component behind an existing web server connection.

  • this may be the first update of the component
  • in connections with forwarding disabled there is only one component behind the connection

Implements DtWebSpyHttpConnectionMgr.

References myDocumentRoot.


Member Data Documentation

Referenced by getNextCommand(), and postCommand().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)