sal/inc/osl/conditn.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: conditn.hxx,v $
  10  * $Revision: 1.8 $
  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 _OSL_CONDITN_HXX_
  32 #define _OSL_CONDITN_HXX_
  33
  34 #ifdef __cplusplus
  35
  36 #include <osl/time.h>
  37
  38 #include <osl/conditn.h>
  39
  40
  41 namespace osl
  42 {
  43
  44     class Condition
  45     {
  46     public:
  47
  48         enum Result
  49         {
  50             result_ok      = osl_cond_result_ok,
  51             result_error   = osl_cond_result_error,
  52             result_timeout = osl_cond_result_timeout
  53         };
  54
  55         /* Create a condition.
  56          */
  57         Condition()
  58         {
  59             condition = osl_createCondition();
  60         }
  61
  62         /* Release the OS-structures and free condition data-structure.
  63          */
  64         ~Condition()
  65         {
  66             osl_destroyCondition(condition);
  67         }
  68
  69         /* Release all waiting threads, check returns sal_True.
  70          */
  71         void set()
  72         {
  73             osl_setCondition(condition);
  74         }
  75
  76         /* Reset condition to false: wait() will block, check() returns sal_False.
  77          */
  78         void reset() {
  79             osl_resetCondition(condition);
  80         }
  81
  82         /** Blocks the calling thread until condition is set.
  83          */
  84         Result wait(const TimeValue *pTimeout = 0)
  85         {
  86             return (Result) osl_waitCondition(condition, pTimeout);
  87         }
  88
  89         /** Checks if the condition is set without blocking.
  90          */
  91         sal_Bool check()
  92         {
  93             return osl_checkCondition(condition);
  94         }
  95
  96
  97     private:
  98         oslCondition condition;
  99
 100         /** The underlying oslCondition has no reference count.
 101
 102         Since the underlying oslCondition is not a reference counted object, copy
 103         constructed Condition may work on an already destructed oslCondition object.
 104
 105         */
 106         Condition(const Condition&);
 107
 108         /** The underlying oslCondition has no reference count.
 109
 110         When destructed, the Condition object destroys the undelying oslCondition,
 111         which might cause severe problems in case it's a temporary object.
 112
 113         */
 114         Condition(oslCondition condition);
 115
 116         /** This assignment operator is private for the same reason as
 117             the copy constructor.
 118         */
 119         Condition& operator= (const Condition&);
 120
 121         /** This assignment operator is private for the same reason as
 122             the constructor taking a oslCondition argument.
 123         */
 124         Condition& operator= (oslCondition);
 125     };
 126
 127 }
 128
 129 #endif  /* __cplusplus */
 130 #endif  /* _OSL_CONDITN_HXX_ */
 131