OMKDistributedController.h

Go to the documentation of this file.

/*
 * This file is part of openMask © INRIA, CNRS, Universite de Rennes 1 1993-2002, thereinafter the Software
 * 
 * The Software has been developped within the Siames Project. 
 * INRIA, the University of Rennes 1 and CNRS jointly hold intellectual property rights
 * 
 * The Software has been registered with the Agence pour la Protection des
 * Programmes (APP) under registration number IDDN.FR.001.510008.00.S.P.2001.000.41200
 *
 * This file may be distributed under the terms of the Q Public License
 * version 1.0 as defined by Trolltech AS of Norway and appearing in the file
 * LICENSE.QPL included in the packaging of this file.
 *
 * Licensees holding valid specific licenses issued by INRIA, CNRS or Université de Rennes 1 
 * for the software may use this file in accordance with that specific license 
 *
 */
#ifndef OMKDistributedControllerHEADER
#define OMKDistributedControllerHEADER


#include <OMKController.h>

#include "OMKDuplicatedObjectHandle.h"
#include "OMKLocalObjectHandle.h"
namespace OMK
{
class MirrorObjectHandle ;

class OMK_API DistributedController : public Controller 
{
public:
   DistributedController(ObjectDescriptor & initialObjects, const Date & initialDate);

   virtual ~DistributedController();

   virtual SimulatedObject * getPointerToSimulatedObjectNamed (const Name & objectName );
   
   virtual void dispatchEvent(Event * event);



   virtual bool processEvent ( Event * event ) ;
 
   virtual void purgeMemoryFromOldEvents ( const Date & dateOfOldestKept );


   virtual void broadcastEventsForSignal ( Event & event, const EventIdentifier & sigId ) ;


   virtual bool receiveRegistrationForSignal(const EventIdentifier & sigId, 
                                  const Name & registrant, 
                                  const EventIdentifier & eventId);


   virtual bool receiveCancellationForSignal ( const EventIdentifier & sigId , 
                                              const Name & registrant ) ;

  virtual const ObjectDescriptor & getObjectDescriptorOfObject(const Name & objectName) ;


  // pour rendre public la liste des miroirs
  std::vector<Name> _publicMirrorObjectsVector ;
  
  virtual std::vector<Name> getMirrorList() ;
  virtual std::vector<Name> getIsolatedMirrorList() { return std::vector<Name>() ;} ;
  virtual std::vector<Name> getNonIsolatedMirrorList()  { return std::vector<Name>() ;} ;
  // fin TDTD
  virtual  bool isAMirror(const Name & name) ;
  virtual bool testIfTroubleOccured()  { return true ; };
  virtual void createNewSite (const Date &) {} ;
  Name exProcessName ;
protected:
   virtual MirrorObjectHandle * newOMKMirrorObjectHandle (SimulatedObject & obj) = 0 ;


   virtual DuplicatedObjectHandle * newOMKDuplicatedObjectHandle (SimulatedObject & obj) = 0 ;

   virtual LocalObjectHandle * newOMKLocalObjectHandle (SimulatedObject & obj) = 0 ;

   virtual void deleteObject (  ObjectDescriptor * objectDescriptor ) ;
   
   virtual void createControlledObjects (const ObjectDescriptor * subTree) ;

   virtual void createObject(const ObjectDescriptor & newObjectDescription, const Name & fathersName) ;

   virtual void processNewObjectDeclaration ( ObjectDescriptor & declaration, const Date & declarationDate ) ;

   virtual MirrorObjectHandle * createMirrorObject ( ObjectDescriptor * objectDescription );


   virtual DuplicatedObjectHandle * createDuplicatedObject( ObjectDescriptor * objectDescription );

   virtual void createLocalObject(const ObjectDescriptor & newLObjectDescription, 
                                  const Name & fathersLName) ;
   virtual  int getMirrorsNbre () ;   
#ifdef _MSC_VER   
   typedef stdext::hash_map<Name,MirrorObjectHandle *,Name::hash_compare_Name >  MirrorObjectsContainerType ;
#else
   typedef __gnu_cxx::hash_map<Name,MirrorObjectHandle *,Name::hash_compare_Name >  MirrorObjectsContainerType ;
#endif

   MirrorObjectsContainerType _mirrorObjectsMap ;

   NameToPointerMap<DuplicatedObjectHandle> _duplicatedObjectsMap;
   
   NameToPointerMap<LocalObjectHandle> _localObjectsMap;
   

   virtual void processStartEventOf(ReferenceObjectHandle * objectHandle) ;

   NameToPointerMap<ReferenceObjectHandle> tableDesNonInitialises ;

   NameToPointerMap<ReferenceObjectHandle> tableDesInitialises ;

   Name _processName ;

   std::list<std::pair<EventIdentifier, std::pair <Event *, Date> > > _broadcastedSignals ;

   std::list <std::pair <Date, ObjectDescriptor *> > _deletedObjectDescriptors ; 
protected:
  class RegistrationData : public OMK::Type::Base
   {
   public:
      RegistrationData() {} ;

      RegistrationData (const EventIdentifier & sig,
                        const Name & registrant, 
                        const EventIdentifier & eventId) ;

      virtual ~RegistrationData() ;

      virtual void unpack (IncomingSynchronisationMessage &) ;
      
      virtual void pack (OutgoingSynchronisationMessage &) const ;

      virtual void extract(std::istream & in) ;

      virtual void insertInStream (std::ostream & out) const ;

      virtual OMK::Type::PolatorNT * createPolator() ;

      EventIdentifier _sig ;
      Name _registrant ;
      EventIdentifier _eventId ;
   }; 



   class CancellationData : public OMK::Type::Base
   {
   public:
      CancellationData(){};

      CancellationData  ( const EventIdentifier & sigId , const Name & registrant ) ;

      virtual ~CancellationData() ;

      virtual void unpack (IncomingSynchronisationMessage &) ;
      
      virtual void pack (OutgoingSynchronisationMessage &) const ;

      virtual void extract(std::istream & in) ;

      virtual void insertInStream (std::ostream & out) const ;

      virtual OMK::Type::PolatorNT * createPolator() ;

      EventIdentifier _sigId ;

      Name _registrant ;
   };
};
} // namespace OMK
#endif

---