ThreadManager.h

Go to the documentation of this file.

/***************************************************************************
 * Copyright (C) 2005 by Benjamin Hadorn (bhadorn@swissinfo.org)           *
 ***************************************************************************
 * Projekt : Zeus
 * Module  : ThreadManager
 * Package : System
 * Author  : Benjamin Hadorn
 * Datum   : $Date: 5.10.09 22:35 $
 * Ablage  : $File$
 * System  : Cell Computing Model
 ***************************************************************************
 * Licence:                                                                *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License as        *
 *   published by the Free Software Foundation; either version             *
 *   2.1 of the License, or (at your option) any later version.            *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
 *   GNU Lesser General Public License for more details.                   *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA  *
 ***************************************************************************/

/***************************************************************************
 Changes :
 $Log: /Development_F/StuderWIN/dev/Zeus/src/zeusbase/System/ThreadManager.h $
** 
** 12    5.10.09 22:35 Bha
** improving speed using inline methods
** 
** 11    27.03.09 15:11 Bha
** new version 1.0 implemented
** 
** 10    3.09.07 7:04 bha
** New Framework using auto pointer and improved lists
** 
** 9     26.02.07 9:00 bha
**
** 1     2.10.06 9:21 bha
** Thread management on Linux and Win32
***************************************************************************/

#ifndef ThreadManagerH
#define ThreadManagerH

#include <zeusbase/System/Map.hpp>
#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/Interfaces/IThreadManager.hpp>
#include <zeusbase/System/SynchronizeObject.h>


BEGIN_NAMESPACE_Zeus

class TCriticalSection;
class IThreadMessageQueue;

#define ThreadManager TThreadManager::getInstance()

/***************************************************************************/
/***************************************************************************/
zeusbase_class TThreadManager : public TZObject, public IThreadManager
{
  public:
    void setDelegationInterface(IThreadManager& rInstance);
    void releaseDelegationInterface();
    static TThreadManager& getInstance();

    //Methods of IThreadManager
    virtual void MQUALIFIER addThread(Uint uiID, IThreadMessageQueue& rQueue, bool bInterrupted);
    virtual Uint MQUALIFIER getCurrentThreadID() const;
    virtual Retval MQUALIFIER getMessageQueue(Uint uiThreadID, IThreadMessageQueue*& rpQueue);
    virtual bool MQUALIFIER isThreadInterrupted(Uint iID)const;
    virtual void MQUALIFIER removeThread(Uint uiID);
    virtual void MQUALIFIER setThreadState(Uint iID, bool bInterrupted);
    virtual Uint MQUALIFIER getMainThreadID() const;
    virtual Retval MQUALIFIER postObject(Uint uiThreadID,
                                         ISynchronizeObject& rObject,
                                         bool bWaitForCompletion);
    virtual Retval MQUALIFIER postObjectToMainThread(ISynchronizeObject& rObject,
                                                     bool bWaitForCompletion);
    virtual bool MQUALIFIER isCurrentThread(Uint uiThreadID) const;
    virtual bool MQUALIFIER isCurrentMainThread() const;

    //Methods of IZUnknown
    MEMORY_MANAGER_DECL
  
  protected:

    //Compiler problem on older version from microsoft
    #ifdef _MSC_VER
      public:
    #endif

    TThreadManager();
    virtual ~TThreadManager();

  private:
    static TAutoPtr<TThreadManager> m_ptrInstance;
    IThreadManager* m_pDelegation;
    TMap<Uint, bool> m_mapThreads;
    TMap<Uint, IThreadMessageQueue*> m_mapQueues;
    TCriticalSection& m_rMapLock;
    TCriticalSection& m_rDelegationLock;
    Uint m_uiMainThreadID;

};


//INLINE METHODS
/**************************************************************************/
/**************************************************************************/
inline /*static*/ TThreadManager& TThreadManager::getInstance()
{
  #if defined(ENABLE_WIN32_BINDING)
    if (m_ptrInstance == NULL)
    {
      m_ptrInstance = new TThreadManager();
    }
  #endif
  return *m_ptrInstance;
}

/****************************************************************************/
/****************************************************************************/
inline Retval MQUALIFIER TThreadManager::postObjectToMainThread(ISynchronizeObject& rObject,
                                                            bool bWaitForCompletion)
{
  return postObject(getMainThreadID(), rObject, bWaitForCompletion);
}

/****************************************************************************/
/****************************************************************************/
inline bool MQUALIFIER TThreadManager::isCurrentThread(Uint uiThreadID) const
{
  return (this->getCurrentThreadID() == uiThreadID);
}

/****************************************************************************/
/****************************************************************************/
inline bool MQUALIFIER TThreadManager::isCurrentMainThread() const
{
  return (this->getCurrentThreadID() == this->getMainThreadID());
}

END_NAMESPACE_Zeus


//############################################################################
//MACROS OF SYNCHRONISATION
//----------------------------------------------------------------------------
#if defined(ENABLE_LINUX_BINDING) || defined(_MSC_VER)
  #include <zeusbase/System/SynchronizeObject.h>
  #include <zeusbase/System/Platforms/SynchronizeObjectDelegater.hpp>

  /*************************************************************************/
  /*************************************************************************/
  #define SYNCHRONIZE_CLASS(clss, mMethod)        \
      class TMethodCaller_##clss_##mMethod        \
         : public NAMESPACE_Zeus::TSynchronizeObject\
      {                                           \
        public:                                   \
          TMethodCaller_##clss_##mMethod(clss& rT)\
          {                                       \
            m_pT = &rT;                           \
          }                                       \
                                                  \
          void checkForError()                    \
          {                                       \
            m_rLock.enter();                      \
            if (this->hasError())                 \
            {                                     \
              m_pT = NULL;                        \
            }                                     \
            m_rLock.leave();                      \
          }                                       \
          virtual void MQUALIFIER process()       \
          {                                       \
            m_rLock.enter();                      \
            if (m_pT != NULL)                     \
            {                                     \
              m_pT->mMethod();                    \
            }                                     \
            m_rLock.leave();                      \
          }                                       \
                                                  \
        private:                                  \
          clss* m_pT;                             \
      };                                          \

  /*************************************************************************/
  /*************************************************************************/
  #define SYNCHRONIZE_METHOD(uiThreadID, clss, mMethod)   \
      {                                                   \
        SYNCHRONIZE_CLASS(clss, mMethod);                 \
                                                          \
        TAutoPtr<TMethodCaller_##clss_##mMethod> ptrObject = new TMethodCaller_##clss_##mMethod(*this); \
        ThreadManager.postObject(uiThreadID, *ptrObject, true); \
        ptrObject->checkForError();                         \
      }

//This is just an other working way how to synchronize the threads
/*     { \
       TSynchronizeObjectDelegater<clss>* pObject = new TSynchronizeObjectDelegater<clss>(*this, mMethod); \
       ThreadManager.postObject(uiThreadID, *pObject, true); \
       pObject->checkForError(); \
       pObject->release(); \
     }
*/

  /*************************************************************************/
  /*************************************************************************/
  #define SYNCHRONIZE_MT_METHOD(clss, mMethod)            \
      {                                                   \
        SYNCHRONIZE_CLASS(clss, mMethod);                 \
                                                          \
        TAutoPtr<TMethodCaller_##clss_##mMethod> ptrObject = new TMethodCaller_##clss_##mMethod(*this); \
        ThreadManager.postObjectToMainThread(*ptrObject, true); \
        ptrObject->checkForError();                         \
      }

//This is just an other working way how to synchronize the threads
/*     { \
       TSynchronizeObjectDelegater<clss>* pObject = new TSynchronizeObjectDelegater<clss>(*this, mMethod); \
       ThreadManager.postObjectToMainThread(*pObject, true); \
       pObject->checkForError(); \
       pObject->release(); \
     }
*/


  /*************************************************************************/
  /*************************************************************************/
  #define POST_METHOD(uiThreadID, class, mMethod) \
     { \
        SYNCHRONIZE_CLASS(clss, mMethod);                 \
                                                          \
        TAutoPtr<TMethodCaller_##clss_##mMethod> ptrObject = new TMethodCaller_##clss_##mMethod(*this); \
        ThreadManager.postObject(uiThreadID, *ptrObject, false); \
     }


  /*************************************************************************/
  /*************************************************************************/
  #define POST_MT_METHOD(class, mMethod) \
     { \
        SYNCHRONIZE_CLASS(clss, mMethod);                 \
                                                          \
        TAutoPtr<TMethodCaller_##clss_##mMethod> ptrObject = new TMethodCaller_##clss_##mMethod(*this); \
        ThreadManager.postObjectToMainThread(*ptrObject, false); \
     }


//----------------------------------------------------------------------------
// Borland bindings
#elif defined(__BCPLUSPLUS__)
  #include <zeusbase/System/Platforms/BorlandSynchronizeObject.hpp>

  /*************************************************************************/
  /*************************************************************************/
  #define SYNCHRONIZE_METHOD(uiThreadID, clss, mMethod) \
     { \
       TAutoPtr<TBorlandSynchronizeObject> ptrObject = new TBorlandSynchronizeObject(&mMethod); \
       ThreadManager.postObject(uiThreadID, *ptrObject, true); \
       ptrObject->checkForError(); \
     }

  /*************************************************************************/
  /*************************************************************************/
  #define SYNCHRONIZE_MT_METHOD(clss, mMethod) \
     { \
       TAutoPtr<TBorlandSynchronizeObject> ptrObject = new TBorlandSynchronizeObject(&mMethod); \
       ThreadManager.postObjectToMainThread(*ptrObject, true); \
       ptrObject->checkForError(); \
     }


  /*************************************************************************/
  /*************************************************************************/
  #define POST_METHOD(uiThreadID, class, mMethod) \
     { \
       TAutoPtr<TBorlandSynchronizeObject> ptrObject = new TBorlandSynchronizeObject(&mMethod); \
       ThreadManager.postObject(uiThreadID, *ptrObject, false); \
     }


  /*************************************************************************/
  /*************************************************************************/
  #define POST_MT_METHOD(class, mMethod) \
     { \
       TAutoPtr<TBorlandSynchronizeObject> ptrObject = new TBorlandSynchronizeObject(&mMethod); \
       ThreadManager.postObjectToMainThread(*ptrObject, false); \
     }

#endif


#endif

---

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:31 2009