Source/Base/Threading/OSGMPBase.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 _OSGMPBASE_H_
  40 #define _OSGMPBASE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGTypeBase.h"
  46 #include "OSGMemoryObject.h"
  47 #include "OSGBaseRefCountPolicies.h"
  48 #include "OSGRefCountPtr.h"
  49 #include "OSGTransitPtr.h"
  50 #include "OSGStringUtils.h"
  51
  52 OSG_BEGIN_NAMESPACE
  53
  54 class MPBase;
  55 class BaseThread;
  56 class Barrier;
  57 class CondVar;
  58 class Lock;
  59 class LockPool;
  60 class Semaphore;
  61
  62 typedef BaseThread *(*CreateThreadF   )(const Char8  *szName,
  63                                               UInt32  uiId,
  64                                               bool    bGlobal);
  65 typedef Barrier    *(*CreateBarrierF  )(const Char8  *szName,
  66                                               UInt32  uiId,
  67                                               bool    bGlobal);
  68 typedef CondVar    *(*CreateCondVarF  )(const Char8  *szName,
  69                                               UInt32  uiId,
  70                                               bool    bGlobal);
  71 typedef Lock       *(*CreateLockF     )(const Char8  *szName,
  72                                               UInt32  uiId,
  73                                               bool    bGlobal);
  74 typedef LockPool   *(*CreateLockPoolF )(const Char8  *szName,
  75                                               UInt32  uiId,
  76                                               bool    bGlobal);
  77 typedef Semaphore  *(*CreateSemaphoreF)(const Char8  *szName,
  78                                               UInt32  uiId,
  79                                               bool    bGlobal);
  80 typedef void        (*InitThreadingF  ) (void);
  81
  82 //---------------------------------------------------------------------------
  83 //  Class
  84 //---------------------------------------------------------------------------
  85
  86 /*! \ingroup GrpBaseMultiThreading
  87     \ingroup GrpLibOSGBase
  88  */
  89
  90 class OSG_BASE_DLLMAPPING MPType : public TypeBase
  91 {
  92     /*==========================  PRIVATE  ================================*/
  93
  94   private:
  95
  96     /*==========================  PUBLIC  =================================*/
  97
  98   public :
  99
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                   Constructor                                */
 102     /*! \{                                                                 */
 103
 104     MPType(const Char8  *szName,
 105            const Char8  *szParentName,
 106            const UInt32  uiNamespace = GlobalNamespace);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Destructor                                 */
 111     /*! \{                                                                 */
 112
 113     virtual ~MPType(void);
 114
 115     /*! \}                                                                 */
 116     /*=========================  PROTECTED  ===============================*/
 117
 118   protected:
 119
 120     /*==========================  PRIVATE  ================================*/
 121
 122     typedef TypeBase Inherited;
 123
 124   private:
 125
 126     /*!\brief prohibit default function (move to 'public' if needed) */
 127     MPType(const MPType &source);
 128     /*!\brief prohibit default function (move to 'public' if needed) */
 129     void operator =(const MPType &source);
 130 };
 131
 132
 133
 134
 135 //---------------------------------------------------------------------------
 136 //  Class
 137 //---------------------------------------------------------------------------
 138
 139 /*! \ingroup GrpBaseMultiThreading
 140     \ingroup GrpLibOSGBase
 141  */
 142
 143 class OSG_BASE_DLLMAPPING MPThreadType : public MPType
 144 {
 145     /*==========================  PRIVATE  ================================*/
 146
 147   private:
 148
 149     /*==========================  PUBLIC  =================================*/
 150
 151   public :
 152
 153     /*---------------------------------------------------------------------*/
 154     /*! \name                   Constructor                                */
 155     /*! \{                                                                 */
 156
 157     MPThreadType(const Char8         *szName,
 158                  const Char8         *szParentName,
 159                        CreateThreadF  fCreateThread,
 160                        InitThreadingF fInitThreading,
 161                  const UInt32         uiNamespace   = GlobalNamespace);
 162
 163     /*! \}                                                                 */
 164     /*---------------------------------------------------------------------*/
 165     /*! \name                   Destructor                                 */
 166     /*! \{                                                                 */
 167
 168     virtual ~MPThreadType(void);
 169
 170     /*! \}                                                                 */
 171     /*---------------------------------------------------------------------*/
 172     /*! \name                   Construction                               */
 173     /*! \{                                                                 */
 174
 175     BaseThread *create(const Char8 *szName, bool bGlobal);
 176
 177     /*! \}                                                                 */
 178     /*=========================  PROTECTED  ===============================*/
 179
 180   protected:
 181
 182     typedef MPType Inherited;
 183
 184     /*---------------------------------------------------------------------*/
 185     /*! \name                   Class Specific                             */
 186     /*! \{                                                                 */
 187
 188     static UInt32        _uiThreadCount;
 189            CreateThreadF _fCreateThread;
 190
 191     /*! \}                                                                 */
 192     /*==========================  PRIVATE  ================================*/
 193
 194   private:
 195
 196     /*!\brief prohibit default function (move to 'public' if needed) */
 197     MPThreadType(const MPThreadType &source);
 198     /*!\brief prohibit default function (move to 'public' if needed) */
 199     void operator =(const MPThreadType &source);
 200 };
 201
 202
 203
 204
 205 //---------------------------------------------------------------------------
 206 //  Class
 207 //---------------------------------------------------------------------------
 208
 209 /*! \ingroup GrpBaseMultiThreading
 210     \ingroup GrpLibOSGBase
 211  */
 212
 213 class OSG_BASE_DLLMAPPING MPBarrierType : public MPType
 214 {
 215     /*==========================  PRIVATE  ================================*/
 216
 217   private:
 218
 219     /*==========================  PUBLIC  =================================*/
 220
 221   public :
 222
 223     /*---------------------------------------------------------------------*/
 224     /*! \name                   Constructor                                */
 225     /*! \{                                                                 */
 226
 227     MPBarrierType(const Char8          *szName,
 228                   const Char8          *szParentName,
 229                         CreateBarrierF  fCreateBarrier,
 230                   const UInt32          uiNamespace   = GlobalNamespace);
 231
 232     /*! \}                                                                 */
 233     /*---------------------------------------------------------------------*/
 234     /*! \name                   Destructor                                 */
 235     /*! \{                                                                 */
 236
 237     virtual ~MPBarrierType(void);
 238
 239     /*! \}                                                                 */
 240     /*---------------------------------------------------------------------*/
 241     /*! \name                   Construction                               */
 242     /*! \{                                                                 */
 243
 244     Barrier *create(const Char8 *szName, bool bGlobal);
 245
 246     /*! \}                                                                 */
 247     /*=========================  PROTECTED  ===============================*/
 248
 249   protected:
 250
 251     typedef MPType Inherited;
 252
 253     /*---------------------------------------------------------------------*/
 254     /*! \name                       Class Specific                         */
 255     /*! \{                                                                 */
 256
 257     static UInt32         _uiBarrierCount;
 258            CreateBarrierF _fCreateBarrier;
 259
 260     /*! \}                                                                 */
 261     /*==========================  PRIVATE  ================================*/
 262
 263   private:
 264
 265     /*!\brief prohibit default function (move to 'public' if needed) */
 266     MPBarrierType(const MPBarrierType &source);
 267     /*!\brief prohibit default function (move to 'public' if needed) */
 268     void operator =(const MPBarrierType &source);
 269 };
 270
 271 //---------------------------------------------------------------------------
 272 //  Class
 273 //---------------------------------------------------------------------------
 274
 275 /*! \ingroup GrpBaseMultiThreading
 276     \ingroup GrpLibOSGBase
 277  */
 278
 279 class OSG_BASE_DLLMAPPING MPCondVarType : public MPType
 280 {
 281     /*==========================  PRIVATE  ================================*/
 282
 283   private:
 284
 285     /*==========================  PUBLIC  =================================*/
 286
 287   public :
 288
 289     /*---------------------------------------------------------------------*/
 290     /*! \name                   Constructor                                */
 291     /*! \{                                                                 */
 292
 293     MPCondVarType(const Char8           *szName,
 294                   const Char8           *szParentName,
 295                         CreateCondVarF  fCreateCondVar,
 296                   const UInt32          uiNamespace = GlobalNamespace);
 297
 298     /*! \}                                                                 */
 299     /*---------------------------------------------------------------------*/
 300     /*! \name                   Destructor                                 */
 301     /*! \{                                                                 */
 302
 303     virtual ~MPCondVarType(void);
 304
 305     /*! \}                                                                 */
 306     /*---------------------------------------------------------------------*/
 307     /*! \name                   Construction                               */
 308     /*! \{                                                                 */
 309
 310     CondVar *create(const Char8 *szName, bool bGlobal);
 311
 312     /*! \}                                                                 */
 313     /*=========================  PROTECTED  ===============================*/
 314   protected:
 315
 316     typedef MPType Inherited;
 317
 318     /*---------------------------------------------------------------------*/
 319     /*! \name                  Class Specific                              */
 320     /*! \{                                                                 */
 321
 322     static UInt32          _uiCondVarCount;
 323            CreateCondVarF  _fCreateCondVar;
 324
 325     /*! \}                                                                 */
 326     /*==========================  PRIVATE  ================================*/
 327
 328   private:
 329
 330     /*!\brief prohibit default function (move to 'public' if needed) */
 331     MPCondVarType(const MPCondVarType &source);
 332     /*!\brief prohibit default function (move to 'public' if needed) */
 333     void operator =(const MPCondVarType &source);
 334 };
 335
 336
 337
 338 //---------------------------------------------------------------------------
 339 //  Class
 340 //---------------------------------------------------------------------------
 341
 342 /*! \ingroup GrpBaseMultiThreading
 343     \ingroup GrpLibOSGBase
 344  */
 345
 346 class OSG_BASE_DLLMAPPING MPLockType : public MPType
 347 {
 348     /*==========================  PRIVATE  ================================*/
 349
 350   private:
 351
 352     /*==========================  PUBLIC  =================================*/
 353
 354   public :
 355
 356     /*---------------------------------------------------------------------*/
 357     /*! \name                   Constructor                                */
 358     /*! \{                                                                 */
 359
 360     MPLockType(const Char8       *szName,
 361                const Char8       *szParentName,
 362                      CreateLockF  fCreateLock,
 363                const UInt32       uiNamespace = GlobalNamespace);
 364
 365     /*! \}                                                                 */
 366     /*---------------------------------------------------------------------*/
 367     /*! \name                   Destructor                                 */
 368     /*! \{                                                                 */
 369
 370     virtual ~MPLockType(void);
 371
 372     /*! \}                                                                 */
 373     /*---------------------------------------------------------------------*/
 374     /*! \name                   Construction                               */
 375     /*! \{                                                                 */
 376
 377     Lock *create(const Char8 *szName, bool bGlobal);
 378
 379     /*! \}                                                                 */
 380     /*=========================  PROTECTED  ===============================*/
 381   protected:
 382
 383     typedef MPType Inherited;
 384
 385     /*---------------------------------------------------------------------*/
 386     /*! \name                  Class Specific                              */
 387     /*! \{                                                                 */
 388
 389     static UInt32       _uiLockCount;
 390            CreateLockF  _fCreateLock;
 391
 392     /*! \}                                                                 */
 393     /*==========================  PRIVATE  ================================*/
 394
 395   private:
 396
 397     /*!\brief prohibit default function (move to 'public' if needed) */
 398     MPLockType(const MPLockType &source);
 399     /*!\brief prohibit default function (move to 'public' if needed) */
 400     void operator =(const MPLockType &source);
 401 };
 402
 403
 404
 405
 406 //---------------------------------------------------------------------------
 407 //  Class
 408 //---------------------------------------------------------------------------
 409
 410 /*! \ingroup GrpBaseMultiThreading
 411     \ingroup GrpLibOSGBase
 412  */
 413 class OSG_BASE_DLLMAPPING MPLockPoolType : public MPType
 414 {
 415     /*==========================  PRIVATE  ================================*/
 416
 417   private:
 418
 419     /*==========================  PUBLIC  =================================*/
 420
 421   public :
 422
 423     /*---------------------------------------------------------------------*/
 424     /*! \name                   Constructor                                */
 425     /*! \{                                                                 */
 426
 427     MPLockPoolType(const Char8           *szName,
 428                    const Char8           *szParentName,
 429                          CreateLockPoolF  fCreateLockPool,
 430                    const UInt32           uiNamespace    = GlobalNamespace);
 431
 432     /*! \}                                                                 */
 433     /*---------------------------------------------------------------------*/
 434     /*! \name                   Destructor                                 */
 435     /*! \{                                                                 */
 436
 437     virtual ~MPLockPoolType(void);
 438
 439     /*! \}                                                                 */
 440     /*---------------------------------------------------------------------*/
 441     /*! \name                    Construction                              */
 442     /*! \{                                                                 */
 443
 444     LockPool *create(const Char8 *szName, bool bGlobal);
 445
 446     /*! \}                                                                 */
 447     /*=========================  PROTECTED  ===============================*/
 448
 449   protected:
 450
 451     typedef MPType Inherited;
 452
 453     /*---------------------------------------------------------------------*/
 454     /*! \name                   Class Specific                             */
 455     /*! \{                                                                 */
 456
 457     static  UInt32          _uiLockPoolCount;
 458             CreateLockPoolF _fCreateLockPool;
 459
 460     /*! \}                                                                 */
 461     /*==========================  PRIVATE  ================================*/
 462
 463   private:
 464
 465     /*!\brief prohibit default function (move to 'public' if needed) */
 466     MPLockPoolType(const MPLockPoolType &source);
 467     /*!\brief prohibit default function (move to 'public' if needed) */
 468     void operator =(const MPLockPoolType &source);
 469 };
 470
 471
 472
 473 //---------------------------------------------------------------------------
 474 //  Class
 475 //---------------------------------------------------------------------------
 476
 477 /*! \ingroup GrpBaseMultiThreading
 478     \ingroup GrpLibOSGBase
 479  */
 480
 481 class OSG_BASE_DLLMAPPING MPSemaphoreType : public MPType
 482 {
 483     /*==========================  PRIVATE  ================================*/
 484
 485   private:
 486
 487     /*==========================  PUBLIC  =================================*/
 488
 489   public :
 490
 491     /*---------------------------------------------------------------------*/
 492     /*! \name                   Constructor                                */
 493     /*! \{                                                                 */
 494
 495     MPSemaphoreType(const Char8            *szName,
 496                     const Char8            *szParentName,
 497                           CreateSemaphoreF  fCreateSemaphore,
 498                     const UInt32            uiNamespace = GlobalNamespace);
 499
 500     /*! \}                                                                 */
 501     /*---------------------------------------------------------------------*/
 502     /*! \name                   Destructor                                 */
 503     /*! \{                                                                 */
 504
 505     virtual ~MPSemaphoreType(void);
 506
 507     /*! \}                                                                 */
 508     /*---------------------------------------------------------------------*/
 509     /*! \name                   Construction                               */
 510     /*! \{                                                                 */
 511
 512     Semaphore *create(const Char8 *szName, bool bGlobal);
 513
 514     /*! \}                                                                 */
 515     /*=========================  PROTECTED  ===============================*/
 516   protected:
 517
 518     typedef MPType Inherited;
 519
 520     /*---------------------------------------------------------------------*/
 521     /*! \name                  Class Specific                              */
 522     /*! \{                                                                 */
 523
 524     static UInt32            _uiSemaphoreCount;
 525            CreateSemaphoreF  _fCreateSemaphore;
 526
 527     /*! \}                                                                 */
 528     /*==========================  PRIVATE  ================================*/
 529
 530   private:
 531
 532     /*!\brief prohibit default function (move to 'public' if needed) */
 533     MPSemaphoreType(const MPSemaphoreType &source);
 534     /*!\brief prohibit default function (move to 'public' if needed) */
 535     void operator =(const MPSemaphoreType &source);
 536 };
 537
 538
 539
 540 //---------------------------------------------------------------------------
 541 //  Class
 542 //---------------------------------------------------------------------------
 543
 544 /*! \ingroup GrpBaseMultiThreading
 545     \ingroup GrpLibOSGBase
 546  */
 547 class OSG_BASE_DLLMAPPING MPBase : public MemoryObject
 548 {
 549     /*==========================  PUBLIC  =================================*/
 550   public :
 551
 552     /*---------------------------------------------------------------------*/
 553     /*! \name                    Class Get                                 */
 554     /*! \{                                                                 */
 555
 556     static const MPType &getStaticType  (void);
 557     static       UInt32  getStaticTypeId(void);
 558
 559     /*! \}                                                                 */
 560     /*---------------------------------------------------------------------*/
 561     /*! \name                    Get                                       */
 562     /*! \{                                                                 */
 563
 564     virtual       MPType &getType  (void);
 565     virtual const MPType &getType  (void) const;
 566                   UInt32  getTypeId(void);
 567             const Char8  *getCName (void) const;
 568
 569                   bool    isGlobal (void) const;
 570
 571     /*! \}                                                                 */
 572     /*=========================  PROTECTED  ===============================*/
 573
 574   protected:
 575
 576     typedef MemoryObject Inherited;
 577
 578     /*---------------------------------------------------------------------*/
 579     /*! \name                   Class Specific                             */
 580     /*! \{                                                                 */
 581
 582     static  MPType  _type;
 583             Char8  *_szName;
 584             bool    _bGlobal;
 585
 586     /*! \}                                                                 */
 587     /*---------------------------------------------------------------------*/
 588     /*! \name                   Constructor                                */
 589     /*! \{                                                                 */
 590
 591     MPBase(const Char8 *szName, bool bGlobal);
 592
 593     /*! \}                                                                 */
 594     /*---------------------------------------------------------------------*/
 595     /*! \name                   Destructor                                 */
 596     /*! \{                                                                 */
 597
 598     virtual ~MPBase(void);
 599
 600     /*! \}                                                                 */
 601     /*==========================  PRIVATE  ================================*/
 602
 603   private:
 604
 605     /*!\brief prohibit default function (move to 'public' if needed) */
 606     MPBase(const MPBase &source);
 607     /*!\brief prohibit default function (move to 'public' if needed) */
 608     void operator =(const MPBase &source);
 609 };
 610
 611 typedef MPBase *MPBaseP;
 612
 613 OSG_END_NAMESPACE
 614
 615 #include "OSGMPBase.inl"
 616
 617 #endif /* _OSGMPBASE_H_ */