broker.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <broker/filterManager.h>
#include <broker/brokerInitializer.h>

#include <portal/pControlMessage.h>

#include <map>
#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>

#ifdef __linux__
#include <sys/file.h>
#endif

class DtPrinter;

namespace MAKVrExchange
{

   class DtStatisticsManager;
   class DtPortalConnection;

   class DT_DLL_BROKER DtBroker
   {
   public:

      typedef bool (*PluginInitMethod)( DtBroker* );

   protected:

      DtBroker();

      virtual void initialize( DtBrokerInitializer* init );

      virtual void logBrokerSettings( DtBrokerInitializer* init );

   public:

      virtual ~DtBroker();

      virtual DtPortalConnection* portalConnection() const;

      virtual void launchGui() = 0;

      virtual void launchInfoGui();

      virtual void reloadBrokerSettings();

      virtual void reloadFilterSettings();

      virtual const DtString brokerName() const;

      virtual DtU16 brokerId() const;

      virtual DtTime simTime() const;

      virtual void updateSimTime() const;

      virtual bool isTimeToQuit() const;

      virtual bool isTranslatorDebuggingOn( const DtString& name ) const;

      virtual bool isTranslatorDisabled( const DtString& name ) const;

      virtual DtTime pollingInterval();

      virtual DtBrokerInitializer* brokerInitializer() const;

      virtual void tick() = 0;

      virtual void processEvents();

      virtual DtFilterManager& objectFilters();

      virtual const DtFilterManager& objectFilters() const;

      virtual void setBrokerId( int id );

   protected:

      virtual void initializeDebuggedAndDisabledFromInit();

      virtual void initFileLogging( const DtString& logFileName );

      virtual void obtainLock();

      virtual void loadBrokerPlugins();

      virtual void getLibrariesInDir( const std::string& dir,
         std::list<std::string>& files ) const;

      virtual void initPortalConnection( const DtBrokerInitializer& init );

      virtual void initStatisticsManager( const DtBrokerInitializer& init );

      virtual void stopFileLogging();

      virtual void processShutdownRequest(const DtPortalBrokerShutdownRequestMessage& obj);

      virtual void processRestartRequest( bool shouldEnableOneToOne );

      virtual void shutdownWithError( const DtString & error );

      static void shutdownRequestCb( const DtPortalBrokerShutdownRequestMessage& obj, void* usr );

      static void processDisableOneToOneCb( const DtPortalBrokerDisableOneToOneMessage& msg, void* usr );

      static void processEnableOneToOneCb( const DtPortalBrokerEnableOneToOneMessage& msg, void* usr );

      static void launchGuiRequestCb( const DtBrokerLaunchGuiRequest& obj, void* usr );


      static void filterObjectCallback( const DtFilterObjectMessage& object, void* userData );

      virtual void filterObjectCallback( const DtFilterObjectMessage& object );


   private:

      DtBroker( const DtBroker& other );

      DtBroker& operator = ( const DtBroker& other );

   protected:

      static const char* theVrxPluginInitMethod;

      DtU16 myBrokerId;
      bool myShutdownRequestedFlag;
      DtPortalConnection* myPortalConn;

      DtBrokerInitializer* myBrokerInitializer;

      std::set<DtString> myDisabledTranslators;
      std::set<DtString> myDebuggedTranslators;

      DtFilterManager myFilterManager;
      DtStatisticsManager* myStatisticsManager;
      DtPrinter* myFilePrinter;
#ifdef _WIN32
      HANDLE myMutexOneAppHandle;
#endif
      // this section defines variables used for lock files in Linux
#ifdef __linux__
      DtString lockFilename;
      struct flock lock;
      int lockFileDes;
#endif

   };


   //
   // Inline method definitions.
   //

   inline DtBrokerInitializer* DtBroker::brokerInitializer() const
   {
      return myBrokerInitializer;
   }

   inline DtFilterManager& DtBroker::objectFilters()
   {
      return myFilterManager;
   }

   inline const DtFilterManager& DtBroker::objectFilters() const
   {
      return myFilterManager;
   }

   inline DtTime DtBroker::pollingInterval()
   {
      return myBrokerInitializer->pollingInterval();
   }

   inline const DtString DtBroker::brokerName() const
   {
      return myBrokerInitializer->brokerName();
   }

}