GloTransactionManager.h

Go to the documentation of this file.

#ifndef INC_GLOTRANSACTIONMANAGER_H
#define INC_GLOTRANSACTIONMANAGER_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#include <list>
#include <map>
#include <unordered_map>
#include <memory>
 
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__MINGW64__)
  #include <basetsd.h>
#elif defined(__GNUC__)
  #define INT_PTR intptr_t
#endif
 
#include "GloTypes.h"
#include "GloObjID.h"
#include "GloTransactionOwner.h"
//-----------------------------------------------------------------------------
namespace glo
{
  //---------------------------------------------------------------------------
  /* Forwards */
  class Record;
  class Communicator;
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( disable : 4251 )
  #endif
  //---------------------------------------------------------------------------
  // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
  // Is a reference to the GlobalObjects documentation.
  //---------------------------------------------------------------------------
  class __glo_export_dll TransactionManager
  {
    public:
      //============== Enumeration
      //-----------------------------------------------------------------------
      enum EnStoreDelete
      {
        eTRX_STORE, 
        eTRX_DELETE 
      };
      //-----------------------------------------------------------------------
 
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>>>>> TransactionBase >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      class __glo_export_dll TransactionBase
      {
        public:
          //============= De- und Konstruktoren
          //---------------------------------------------------------------------
          TransactionBase();
          //---------------------------------------------------------------------
          virtual ~TransactionBase();
          //---------------------------------------------------------------------
 
        private:
          //---------------------------------------------------------------------
          TransactionBase( const TransactionBase & );
          //---------------------------------------------------------------------
 
          //============== Operatoren
          //---------------------------------------------------------------------
          TransactionManager::TransactionBase & operator= ( const TransactionBase & );
          //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<<<<<<< TransactionBase <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>>>>>> TransactionPoint >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      class __glo_export_dll TransactionPoint : public TransactionManager::TransactionBase
      {
        private:
          //============== Attribute
          //---------------------------------------------------------------------
          int m_iCount;
          //---------------------------------------------------------------------
 
        public:
          //============= Konstruktoren
          //---------------------------------------------------------------------
          TransactionPoint();
          //---------------------------------------------------------------------
          TransactionPoint( int iCount );
          //---------------------------------------------------------------------
 
        private:
          //============= Konstruktor
          //---------------------------------------------------------------------
          TransactionPoint( const TransactionPoint & );
          //---------------------------------------------------------------------
 
        public:
          //============= Destruktor
          //---------------------------------------------------------------------
          virtual ~TransactionPoint();
          //---------------------------------------------------------------------
 
          //============== Methoden
          //---------------------------------------------------------------------
          int getCount() const;
          //---------------------------------------------------------------------
 
        private:
          //============== Operatoren
          //---------------------------------------------------------------------
          TransactionManager::TransactionPoint & operator= ( const TransactionPoint & );
          //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<<<< TransactionPoint <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>>>> TransactionStep >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      class __glo_export_dll TransactionStep : public TransactionManager::TransactionBase
      {
        private:
          //============== Attribute
          //---------------------------------------------------------------------
          bool m_bLocalCopyRecord;
          //---------------------------------------------------------------------
          Record * m_pActionRecord;
          //---------------------------------------------------------------------
          TransactionManager::EnStoreDelete m_eAction;
          //---------------------------------------------------------------------
 
        protected:
          //============== Konstruktoren
          //---------------------------------------------------------------------
          TransactionStep();
          //---------------------------------------------------------------------
 
        public:
          //============== Konstruktoren
          //---------------------------------------------------------------------
          TransactionStep( EnStoreDelete eAction,
                           Record * pActionRecord,
                           bool bLocalCopy = false );
          //---------------------------------------------------------------------
 
        private:
          //============= Konstruktor
          //---------------------------------------------------------------------
          TransactionStep( const TransactionStep & );
          //---------------------------------------------------------------------
 
        public:
          //============= Destruktor
          //---------------------------------------------------------------------
          virtual ~TransactionStep();
          //---------------------------------------------------------------------
 
          //============== Methoden
          //---------------------------------------------------------------------
          void getActionRecord( Record *& prRetVal ) const;
          //---------------------------------------------------------------------
          const Record * getActionRecord() const;
          //---------------------------------------------------------------------
          ObjID getActionRecordObjID() const;
          //---------------------------------------------------------------------
          TransactionManager::EnStoreDelete getAction() const;
          //---------------------------------------------------------------------
          bool hasLocalCopy();
          //---------------------------------------------------------------------
          int takeOverObjIDsFilePos( const Record & rSourceRecord );
          //---------------------------------------------------------------------
 
        private:
          //============== Operatoren
          //---------------------------------------------------------------------
          TransactionManager::TransactionStep & operator= ( const TransactionStep & );
          //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<<<<<< TransactionStep <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>> CommunicatorTransactionStack >>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      class __glo_export_dll CommunicatorTransactionStack
      {
        private:
          //============== Attribute
          //---------------------------------------------------------------------
          TransactionOwner m_CommunicatorWithTreadID;
          //---------------------------------------------------------------------
          std::list<TransactionBase *> m_TransactionStack;
          //---------------------------------------------------------------------
          int m_iCurrentTransactionPoint;
          //---------------------------------------------------------------------
 
        protected:
          //============= Konstruktor
          //---------------------------------------------------------------------
          CommunicatorTransactionStack();
          //---------------------------------------------------------------------
 
        public:
          //============= De- und Konstruktoren
          //---------------------------------------------------------------------
          CommunicatorTransactionStack( const TransactionOwner & rCommunicatorWithTreadID );
          //---------------------------------------------------------------------
          ~CommunicatorTransactionStack();
          //---------------------------------------------------------------------
 
        private:
          //============== Copy-Konstruktor
          //---------------------------------------------------------------------
          CommunicatorTransactionStack( const CommunicatorTransactionStack & );
          //---------------------------------------------------------------------
 
        public:
          //============== Methoden
          //---------------------------------------------------------------------
          TransactionOwner getCommunicator();
          //---------------------------------------------------------------------
          void beginTransaction();
          //---------------------------------------------------------------------
          bool commitTransaction();
          //---------------------------------------------------------------------
          bool abortTransaction( std::list< TransactionBase * > & rAbortedTransactionStepList );
          //---------------------------------------------------------------------
          int setTransactionStep( NUM_PTR & nNewTrxStepAddr,
                                  EnStoreDelete eAction,
                                  Record * pActionRecord );
          //---------------------------------------------------------------------
          std::list< TransactionManager::TransactionBase * > & getTransactionStack();
          //---------------------------------------------------------------------
 
        private:
          //============== Operatoren
          //---------------------------------------------------------------------
          TransactionManager::CommunicatorTransactionStack & operator= ( const CommunicatorTransactionStack & );
          //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<< CommunicatorTransactionStack <<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
    private:
      //============== Attribute
      //-----------------------------------------------------------------------
      std::map< TransactionOwner, CommunicatorTransactionStack *, std::less<TransactionOwner> > m_TransactionStackMap;
      //-----------------------------------------------------------------------
      std::map< TransactionOwner, CommunicatorTransactionStack * >::iterator m_TransactionStackMapIterator;
      //-----------------------------------------------------------------------
      std::unordered_map< ObjID, Record *, glo::ObjID::HashFunction > m_RecursionRecordMap;
      //-----------------------------------------------------------------------
 
    public:
      //============== De- und Konstruktor
      //-----------------------------------------------------------------------
      TransactionManager();
      //-----------------------------------------------------------------------
      virtual ~TransactionManager();
      //-----------------------------------------------------------------------
 
    private:
      //============== Copy-Konstruktor
      //-----------------------------------------------------------------------
      TransactionManager( const TransactionManager & );
      //-----------------------------------------------------------------------
 
    public:
      //============== Methoden
      //-----------------------------------------------------------------------
      void beginTransaction( const TransactionOwner & rCommunicatorWithTreadID );
      //-----------------------------------------------------------------------
      int commitTransaction( CommunicatorTransactionStack *& prRetVal,
                             const TransactionOwner & rCommunicatorWithTreadID );
      //-----------------------------------------------------------------------
      int abortTransaction( std::list< TransactionBase * > & rAbortedTransactionStepList,
                            const TransactionOwner & rCommunicatorWithTreadID );
      //-----------------------------------------------------------------------
      int setTransactionStep( NUM_PTR & nNewTrxStepAddr,
                              const TransactionOwner & rCommunicatorWithTreadID,
                              EnStoreDelete eAction,
                              Record * pActionRecord);
      //-----------------------------------------------------------------------
      int getActionRecord(  Record *& prRetVal,
                            EnStoreDelete & reAction,
                            const TransactionOwner & rCommunicatorWithTreadID,
                            const ObjID & rObjID,
                            const std::string & rsDataPath,
                            bool bInRecursion = false );
      //-----------------------------------------------------------------------
      int getActionRecord(  std::shared_ptr < Record > & rRetVal,
                            EnStoreDelete & reAction,
                            const TransactionOwner & rCommunicatorWithTreadID,
                            const ObjID & rObjID,
                            const std::string & rsDataPath,
                            bool bInRecursion = false );
      //-----------------------------------------------------------------------
      bool inTransaction( const TransactionOwner & rCommunicatorWithTreadID ) const;
      //-----------------------------------------------------------------------
      void deleteAllTransactions( Communicator * pCommunicator );
      //-----------------------------------------------------------------------
 
    protected:
      //============== Methoden
      //-----------------------------------------------------------------------
      TransactionManager::CommunicatorTransactionStack * getTransactionStack( const TransactionOwner & rCommunicatorWithTreadID );
      //-----------------------------------------------------------------------
      void removeCurrentTransactionStack();
      //-----------------------------------------------------------------------
 
    private:
      //-----------------------------------------------------------------------
      int writeTransactionFile( CommunicatorTransactionStack * pTransactionStack );
      //-----------------------------------------------------------------------
 
      //============== Operatoren
      //-----------------------------------------------------------------------
      TransactionManager & operator= ( const TransactionManager & );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace glo
#endif