Source/Base/Threading/OSGLockPolicies.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2003 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGLOCKPOLICIES_H_
  40 #define _OSGLOCKPOLICIES_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBaseTypes.h"
  46 #include "OSGBaseFunctions.h"
  47 #include "OSGBaseInitFunctions.h"
  48
  49 #include "OSGLock.h"
  50
  51 #include <boost/bind.hpp>
  52
  53 OSG_BEGIN_NAMESPACE
  54
  55 /*! \ingroup GrpBaseMultiThreading
  56     \ingroup GrpLibOSGBase
  57     \nohierarchy
  58  */
  59
  60 class NoLockPolicy
  61 {
  62
  63     /*==========================  PUBLIC  =================================*/
  64
  65   public:
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                   Constructors                               */
  69     /*! \{                                                                 */
  70
  71     NoLockPolicy(void);
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                   Destructor                                 */
  76     /*! \{                                                                 */
  77
  78     virtual ~NoLockPolicy(void);
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                 Reference Counting                           */
  83     /*! \{                                                                 */
  84
  85     void acquire(void);
  86     void release(void);
  87     bool request(void);
  88
  89     /*! \}                                                                 */
  90     /*=========================  PROTECTED  ===============================*/
  91
  92   protected:
  93
  94    /*==========================  PRIVATE  ================================*/
  95
  96   private:
  97
  98     /*!\brief prohibit default function (move to 'public' if needed) */
  99     NoLockPolicy(const  NoLockPolicy &source);
 100     void operator =(const NoLockPolicy &source);
 101 };
 102
 103
 104 /*! \ingroup GrpBaseMultiThreading
 105     \ingroup GrpLibOSGBase
 106     \nohierarchy
 107  */
 108
 109 class SingleLockPolicy
 110 {
 111
 112     /*==========================  PUBLIC  =================================*/
 113
 114   public:
 115
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                   Constructors                               */
 118     /*! \{                                                                 */
 119
 120     SingleLockPolicy(void);
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                   Destructor                                 */
 125     /*! \{                                                                 */
 126
 127     virtual ~SingleLockPolicy(void);
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                 Reference Counting                           */
 132     /*! \{                                                                 */
 133
 134     void acquire(void);
 135     void release(void);
 136     bool request(void);
 137
 138     /*! \}                                                                 */
 139     /*=========================  PROTECTED  ===============================*/
 140
 141   protected:
 142
 143     LockRefPtr _pLock;
 144
 145    /*==========================  PRIVATE  ================================*/
 146
 147   private:
 148
 149     /*!\brief prohibit default function (move to 'public' if needed) */
 150     SingleLockPolicy(const  SingleLockPolicy &source);
 151     void operator =(const SingleLockPolicy &source);
 152 };
 153
 154
 155 /*! \ingroup GrpBaseMultiThreading
 156     \ingroup GrpLibOSGBase
 157     \nohierarchy
 158  */
 159
 160 class SingleStaticInitLockPolicy
 161 {
 162
 163     /*==========================  PUBLIC  =================================*/
 164
 165   public:
 166
 167     /*---------------------------------------------------------------------*/
 168     /*! \name                   Constructors                               */
 169     /*! \{                                                                 */
 170
 171     SingleStaticInitLockPolicy(void);
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                   Destructor                                 */
 176     /*! \{                                                                 */
 177
 178     virtual ~SingleStaticInitLockPolicy(void);
 179
 180     /*! \}                                                                 */
 181     /*---------------------------------------------------------------------*/
 182     /*! \name                 Reference Counting                           */
 183     /*! \{                                                                 */
 184
 185     /*! \}                                                                 */
 186     /*---------------------------------------------------------------------*/
 187     /*! \name                 Reference Counting                           */
 188     /*! \{                                                                 */
 189
 190     void acquire(void);
 191     void release(void);
 192     bool request(void);
 193
 194     /*! \}                                                                 */
 195     /*=========================  PROTECTED  ===============================*/
 196
 197   protected:
 198
 199     LockRefPtr _pLock;
 200
 201     bool init    (void);
 202     bool shutdown(void);
 203
 204    /*==========================  PRIVATE  ================================*/
 205
 206   private:
 207
 208     /*!\brief prohibit default function (move to 'public' if needed) */
 209     SingleStaticInitLockPolicy(const  SingleStaticInitLockPolicy &source);
 210     void operator =(const SingleStaticInitLockPolicy &source);
 211 };
 212
 213 OSG_END_NAMESPACE
 214
 215 #include "OSGLockPolicies.inl"
 216
 217 #endif /* _OSGLOCKPOLICIES_H_ */