federationDocs.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: federationDocs.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtFederationDocs_H_
#define DtFederationDocs_H_

#include <rtiMsConfig.h>
#include "basicEhsDoc.h"
#include "webSpyUtils.h"
#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>

class DtEhsHttpConnectionMgr;
class HttpRequest;
class HttpResponse;

// The XML representation of the Federation's state
// Since the RTI Exec allows forwarding of web requests, the DtFederationXML
// class must provide the state of any RTI component on demand.
class DT_DLL_WWWEHS DtFederationXML : public DtBasicEhsDoc
{
private:

   // Copy Constructor not implimented : Copy not allowed
   DtFederationXML(const DtFederationXML&);
   // Copy Constructor not implimented : Copy not allowed
   DtFederationXML& operator=(const DtFederationXML&);

public:

   DtFederationXML( DtEhsHttpConnectionMgr& parent,
      const DtWebSpyUtils::ConnectionIdentifier& connInfo );
   virtual ~DtFederationXML();

protected:

   // Serve requests for this page
   virtual ResponseCode HandleNonFileRequest( HttpRequest * ipoHttpRequest, 
                                              HttpResponse * ipoHttpResponse );

   // Load an initial empty response until first update is available
   void initializePage();

   // Send an update request to the WebSpy for the Federation
   virtual void requestStateUpdate();


   // WWW Request Handlers

   // Handler for state requests from the web client
   std::auto_ptr< DtString > handleStateRequest( unsigned long connId,
      DtWwwRequestXmlBlockSP requestSP, std::auto_ptr< DtString > requestString );

   // Handler for log requests from the web client
   std::auto_ptr< DtString > handleLogRequest( unsigned long connId,
      DtWwwRequestXmlBlockSP requestSP, std::auto_ptr< DtString > requestString );

   // Handler for direct commands to the RTI Exec from the Web Client
   // - just verifies the command structure and passes it on (better to crash the www server
   // than the RTI Exec)
   std::auto_ptr< DtString > handleRtiExecCommand( unsigned long connId,
      DtWwwRequestXmlBlockSP requestSP, std::auto_ptr< DtString > requestString );

protected:
   
   typedef std::pair< unsigned long, DtWebSpyUtils::StateComponentType > ComponentIdStateTypePair;

   DtEhsHttpConnectionMgr& myParent;
   DtWebSpyUtils::ConnectionIdentifier myConnInfo;

   // Cache Status - these determine when to request a cache update
   // ( and when to wait for the current request to complete )
   std::map< ComponentIdStateTypePair, DtTime > myPendingRequests;
   std::map< unsigned long, DtTime > myPendingLrcLogRequests;

};




#endif // DtFederationDocs_H_