federateDocs.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: federateDocs.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtFederateDocs_H_
#define DtFederateDocs_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 data block used to pass a single Federate's state to the client
class DT_DLL_WWWEHS DtFederateXML : public DtBasicEhsDoc
{
private:

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

public:

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

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 Federate
   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 RTI Commands
   std::auto_ptr< DtString > handleRTICommand( 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 // DtFederateDocs_H_