dep/include/zthread/AtomicCount.h

   1 /*
   2  * Copyright (c) 2005, Eric Crahen
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is furnished
   9  * to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in all
  12  * copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  18  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  */
  22
  23 #ifndef __ZTATOMICCOUNT_H__
  24 #define __ZTATOMICCOUNT_H__
  25
  26 #include <cstdlib>
  27
  28 #include "zthread/Config.h"
  29 #include "zthread/NonCopyable.h"
  30
  31 namespace ZThread {
  32
  33   /**
  34    * @class AtomicCount
  35    * @author Eric Crahen <http://www.code-foo.com>
  36    * @date <2003-07-16T09:41:55-0400>
  37    * @version 2.3.0
  38    *
  39    * This class provides an interface to a small integer whose value can be
  40    * incremented or decremented atomically. It's designed to be as simple and
  41    * lightweight as possible so that it can be used cheaply to create reference
  42    * counts.
  43    */
  44   class ZTHREAD_API AtomicCount : public NonCopyable {
  45
  46     void* _value;
  47
  48   public:
  49
  50     //! Create a new AtomicCount, initialized to a value of 1
  51     AtomicCount();
  52
  53     //! Destroy a new AtomicCount
  54     ~AtomicCount();
  55
  56     //! Postfix decrement and return the current value
  57     size_t operator--(int);
  58
  59     //! Postfix increment and return the current value
  60     size_t operator++(int);
  61
  62     //! Prefix decrement and return the current value
  63     size_t operator--();
  64
  65     //! Prefix increment and return the current value
  66     size_t operator++();
  67
  68
  69   }; /* AtomicCount */
  70
  71
  72 } // namespace ZThread
  73
  74 #endif // __ZTATOMICCOUNT_H__