sw/source/core/inc/swthreadmanager.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: swthreadmanager.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SWTHREADMANAGER_HXX
  31 #define _SWTHREADMANAGER_HXX
  32
  33 #include <osl/interlck.h>
  34 #include <osl/mutex.hxx>
  35 #include <rtl/ref.hxx>
  36
  37 class ObservableThread;
  38 class ThreadManager;
  39
  40 /** class to manage threads in Writer using a <ThreadManager> instance
  41
  42     OD 2007-04-13 #i73788#
  43     Conforms the singleton pattern
  44
  45     @author OD
  46 */
  47 class SwThreadManager
  48 {
  49     public:
  50
  51         static SwThreadManager& GetThreadManager();
  52
  53         static bool ExistsThreadManager();
  54
  55         ~SwThreadManager();
  56
  57         oslInterlockedCount AddThread( const rtl::Reference< ObservableThread >& rThread );
  58
  59         void RemoveThread( const oslInterlockedCount nThreadID );
  60
  61         /** suspend the starting of threads
  62
  63             Suspending the starting of further threads is sensible during the
  64             destruction of a Writer document.
  65
  66             @author OD
  67         */
  68         void SuspendStartingOfThreads();
  69
  70         /** continues the starting of threads after it has been suspended
  71
  72             @author OD
  73         */
  74         void ResumeStartingOfThreads();
  75
  76         bool StartingOfThreadsSuspended();
  77
  78     private:
  79         static SwThreadManager* mpThreadManager;
  80         static osl::Mutex* mpGetManagerMutex;
  81
  82         ThreadManager* mpThreadManagerImpl;
  83
  84         SwThreadManager();
  85
  86 };
  87 #endif