cppu/source/threadpool/jobqueue.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: jobqueue.hxx,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef _CPPU_THREADPOOL_JOBQUEUE_HXX_
  32 #define _CPPU_THREADPOOL_JOBQUEUE_HXX_
  33
  34 #include <list>
  35 #include <sal/types.h>
  36
  37 #include <osl/conditn.h>
  38 #include <osl/mutex.hxx>
  39
  40 namespace cppu_threadpool
  41 {
  42     extern "C" typedef void (SAL_CALL RequestFun)(void *);
  43
  44     struct Job
  45     {
  46         void *pThreadSpecificData;
  47         RequestFun * doRequest;
  48     };
  49
  50     typedef     ::std::list     < struct Job > JobList;
  51
  52     typedef     ::std::list     < sal_Int64 > CallStackList;
  53
  54     class JobQueue
  55     {
  56     public:
  57         JobQueue();
  58         ~JobQueue();
  59
  60         void add( void *pThreadSpecificData, RequestFun * doRequest );
  61
  62         void *enter( sal_Int64 nDisposeId , sal_Bool bReturnWhenNoJob = sal_False );
  63         void dispose( sal_Int64 nDisposeId );
  64
  65         void suspend();
  66         void resume();
  67
  68         sal_Bool isEmpty();
  69         sal_Bool isCallstackEmpty();
  70         sal_Bool isBusy();
  71
  72     private:
  73         ::osl::Mutex m_mutex;
  74         JobList      m_lstJob;
  75         CallStackList m_lstCallstack;
  76         sal_Int32 m_nToDo;
  77         sal_Bool m_bSuspended;
  78         oslCondition m_cndWait;
  79     };
  80 }
  81
  82 #endif