semaphor.h
上传用户:hzhsqp
上传日期:2007-01-06
资源大小:1600k
文件大小:6k
源码类别:

IP电话/视频会议

开发平台:

Visual C++

  1. /*
  2.  * semaphor.h
  3.  *
  4.  * Thread synchronisation semaphore class.
  5.  *
  6.  * Portable Windows Library
  7.  *
  8.  * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
  9.  *
  10.  * The contents of this file are subject to the Mozilla Public License
  11.  * Version 1.0 (the "License"); you may not use this file except in
  12.  * compliance with the License. You may obtain a copy of the License at
  13.  * http://www.mozilla.org/MPL/
  14.  *
  15.  * Software distributed under the License is distributed on an "AS IS"
  16.  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17.  * the License for the specific language governing rights and limitations
  18.  * under the License.
  19.  *
  20.  * The Original Code is Portable Windows Library.
  21.  *
  22.  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23.  *
  24.  * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
  25.  * All Rights Reserved.
  26.  *
  27.  * Contributor(s): ______________________________________.
  28.  *
  29.  * $Log: semaphor.h,v $
  30.  * Revision 1.8  1999/03/09 02:59:50  robertj
  31.  * Changed comments to doc++ compatible documentation.
  32.  *
  33.  * Revision 1.7  1999/02/16 08:11:10  robertj
  34.  * MSVC 6.0 compatibility changes.
  35.  *
  36.  * Revision 1.6  1998/11/19 05:17:37  robertj
  37.  * Added PWaitAndSignal class for easier mutexing.
  38.  *
  39.  * Revision 1.5  1998/09/23 06:21:19  robertj
  40.  * Added open source copyright license.
  41.  *
  42.  * Revision 1.4  1998/03/20 03:16:11  robertj
  43.  * Added special classes for specific sepahores, PMutex and PSyncPoint.
  44.  *
  45.  * Revision 1.3  1995/12/10 11:34:50  robertj
  46.  * Fixed incorrect order of parameters in semaphore constructor.
  47.  *
  48.  * Revision 1.2  1995/11/21 11:49:42  robertj
  49.  * Added timeout on semaphore wait.
  50.  *
  51.  * Revision 1.1  1995/08/01 21:41:24  robertj
  52.  * Initial revision
  53.  *
  54.  */
  55. #define _PSEMAPHORE
  56. #ifdef __GNUC__
  57. #pragma interface
  58. #endif
  59. #include <limits.h>
  60. /**This class waits for the semaphore on construction and automatically
  61.    signals the semaphore on destruction. Any descendent of PSemaphore
  62.    may be used.
  63.   This is very usefull for constructs such as:
  64. begin{verbatim}
  65.     void func()
  66.     {
  67.       PWaitAndSignal mutexWait(myMutex);
  68.       if (condition)
  69.         return;
  70.       do_something();
  71.       if (other_condition)
  72.         return;
  73.       do_something_else();
  74.     }
  75. end{verbatim}
  76.  */
  77. class PWaitAndSignal {
  78.   public:
  79.     /**Create the semaphore wait instance.
  80.        This will wait on the specified semaphore using teh #Wait()# function
  81.        before returning.
  82.       */
  83.     PWaitAndSignal(
  84.       PSemaphore & sem    /// Semaphore descendent to wait/signal.
  85.     );
  86.     /** Signal the semaphore.
  87.         This will execute the Signal() function on the semaphore that was used
  88.         in the construction of this instance.
  89.      */
  90.     ~PWaitAndSignal();
  91.   protected:
  92.     PSemaphore & semaphore;
  93. };
  94. /**This class defines a thread synchonisation object. This is in the form of a
  95.    integer semaphore. The semaphore has a count and a maximum value. The
  96.    various combinations of count and usage of the #Wait()# and
  97.    #Signal()# functions determine the type of synchronisation mechanism
  98.    to be employed.
  99.    The #Wait()# operation is that if the semaphore count is > 0,
  100.    decrement the semaphore and return. If it is = 0 then wait (block).
  101.    The #Signal()# operation is that if there are waiting threads then
  102.    unblock the first one that was blocked. If no waiting threads and the count
  103.    is less than the maximum then increment the semaphore.
  104.    The most common is to create a mutual exclusion zone. A mutex is where a
  105.    piece of code or data cannot be accessed by more than one thread at a time.
  106.    To prevent this the PSemaphore is used in the following manner:
  107. begin{verbatim}
  108.       PSemaphore mutex(1, 1);  // Maximum value of 1 and initial value of 1.
  109.       ...
  110.       mutex.Wait();
  111.       ... critical section - only one thread at a time here.
  112.       mutex.Signal();
  113.       ...
  114. end{verbatim}
  115.     The first thread will pass through the #Wait()# function, a second
  116.     thread will block on that function until the first calls the
  117.     #Signal()# function, releasing the second thread.
  118.  */
  119. class PSemaphore : public PObject
  120. {
  121.   PCLASSINFO(PSemaphore, PObject);
  122.   public:
  123.   /**@name Construction */
  124.   //@{
  125.     /**Create a new semaphore with maximum count and initial value specified.
  126.        If the initial value is larger than the maximum value then is is set to
  127.        the maximum value.
  128.      */
  129.     PSemaphore(
  130.       unsigned initial, /// Initial value for semaphore count.
  131.       unsigned maximum  /// Maximum value for semaphore count.
  132.     );
  133.     /**Destroy the semaphore. This will assert if there are still waiting
  134.        threads on the semaphore.
  135.      */
  136.     ~PSemaphore();
  137.   //@}
  138.   /**@name Operations */
  139.   //@{
  140.     /**If the semaphore count is > 0, decrement the semaphore and return. If
  141.        if is = 0 then wait (block).
  142.      */
  143.     virtual void Wait();
  144.     /**If the semaphore count is > 0, decrement the semaphore and return. If
  145.        if is = 0 then wait (block) for the specified amount of time.
  146.        @return
  147.        TRUE if semaphore was signalled, FALSE if timed out.
  148.      */
  149.     virtual BOOL Wait(
  150.       const PTimeInterval & timeout // Amount of time to wait for semaphore.
  151.     );
  152.     /**If there are waiting (blocked) threads then unblock the first one that
  153.        was blocked. If no waiting threads and the count is less than the
  154.        maximum then increment the semaphore.
  155.      */
  156.     virtual void Signal();
  157.     /**Determine if the semaphore would block if the #Wait()# function
  158.        were called.
  159.        @return
  160.        TRUE if semaphore will block when Wait() is called.
  161.      */
  162.     virtual BOOL WillBlock() const;
  163.   //@}
  164. #ifndef P_PLATFORM_HAS_THREADS
  165.   protected:
  166.     unsigned currentCount;
  167.     unsigned maximumCount;
  168.     PTimer   timeout;
  169.     PQUEUE(BlockedThreadsQueue, PThread);
  170.     BlockedThreadsQueue blockedThreads;
  171.     friend void PThread::Yield();
  172. #endif
  173.   private:
  174.     PSemaphore(const PSemaphore &) { }
  175.     PSemaphore & operator=(const PSemaphore &) { return *this; }
  176. #ifdef DOC_PLUS_PLUS
  177. };
  178. #endif
  179. // Class declaration continued in platform specific header file ///////////////