semaphore.h

Engine/source/platform/threads/semaphore.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _PLATFORM_THREAD_SEMAPHORE_H_
25#define _PLATFORM_THREAD_SEMAPHORE_H_
26
27#ifndef _TORQUE_TYPES_H_
28#include "platform/types.h"
29#endif
30
31// Forward ref used by platform code
32class PlatformSemaphore;
33
34class Semaphore
35{
36protected:
37   PlatformSemaphore *mData;
38
39public:
40   /// Create a semaphore. initialCount defaults to 1.
41   Semaphore(S32 initialCount = 1);
42   /// Delete a semaphore, ignoring it's count.
43   ~Semaphore();
44
45   /// Acquire the semaphore, decrementing its count.
46   /// if the initial count is less than 1, block until it goes above 1, then acquire.
47   /// Returns true if the semaphore was acquired, false if the semaphore could
48   /// not be acquired and block was false.
49   bool acquire(bool block = true, S32 timeoutMS = -1);
50
51   /// Release the semaphore, incrementing its count.
52   /// Never blocks.
53   void release();
54};
55
56#endif
57