ehsHttpConnMgr.h

Go to the documentation of this file.

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

#include <rtiMsConfig.h>
#include "wwwSpyHttpConnMgr.h"
#include "lrcConsoleLogXmlBlock.h"
#include <vlMutex__rti__.h>
#include <vlutil/vlThreadSafe.h>
#include <vlutil/vlTime.h>
#include <deque>
#include <map>

//Forward References
class DtWwwDocRoot;
class DtWebSpyServer;

// The DtEhsHttpConnectionMgr manages the http connection side of the DtWebSpyServer.
// It implements the DtWebSpyHttpConnectionMgr interface using the EHS web server.
class DT_DLL_WWWEHS DtEhsHttpConnectionMgr : public DtWebSpyHttpConnectionMgr
{
private:
   // Copy  and Assignment unimplemented
   DtEhsHttpConnectionMgr( const DtEhsHttpConnectionMgr& );
   // Copy  and Assignment unimplemented
   DtEhsHttpConnectionMgr& operator=( DtEhsHttpConnectionMgr& );

public:

   // Virtual constructor
   static DtWebSpyHttpConnectionMgr* create( DtWebSpyServer& parent );

public:
   
   // Ctor
   DtEhsHttpConnectionMgr( DtWebSpyServer& parent );
   // Dtor
   virtual ~DtEhsHttpConnectionMgr();

   // 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
   virtual void tick( unsigned int timeout = 0 );

   // Post a new command (called by the HTTP server to add a command to the queue)
   virtual void postCommand( const DtWebSpyUtils::ConnectionIdentifier& connInfo,
      std::auto_ptr<DtString> command );

   // Add a new RTI object with associated connection information
   virtual void addConnection( const DtWebSpyUtils::ConnectionIdentifier& connInfo );

   // 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
   virtual void updateConnection( const DtWebSpyUtils::ConnectionIdentifier& connInfo,
      std::auto_ptr< DtWebSpyUtils::ConnectionState > connState, bool appendToExisting  );

   // 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 )
   virtual void appendConnectionLogEvent( const DtWebSpyUtils::ConnectionIdentifier& connInfo,
      unsigned long componentId, DtLrcConsoleLogXmlBlockSP logSegmentSP );

   // 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)
   virtual void removeConnection( const DtWebSpyUtils::ConnectionIdentifier& connInfo,
      const DtString& dropNotificationMsg = "" );
  
protected:

   typedef std::pair< DtWebSpyUtils::ConnectionIdentifier, DtString* > WebSpyCommand;

   // Type to hold a list of Commands from the attached web clients and the
   // the source/destination page ID
   // (since there may be multiple simultaneous clients attached via different
   //  threads, the queue must be made thread-safe)
   typedef DtThreadSafe< std::deque< WebSpyCommand > > WebSpyCommandQ;

protected:

   // Get the next command message from the HTTP server
   // - commands from the HTTP server are simple xml command messages
   // - commands must be decoded by the wwwSpyServer decoder   
   virtual WebSpyCommand getNextCommand();

protected:

   // A list of commands posted by various web clients
   WebSpyCommandQ myWebCommandQ;

   // The WebSpy Client Application Page
   std::auto_ptr<DtWwwDocRoot> myDocumentRoot;

};


#endif // DtEhsHttpConnectionMgr_H_