git.sesse.net Git - casparcg/blob - dependencies64/sfml/include/SFML/System/Unix/Mutex.hpp

   1 ////////////////////////////////////////////////////////////
   2 //
   3 // SFML - Simple and Fast Multimedia Library
   4 // Copyright (C) 2007 Laurent Gomila (laurent.gom@gmail.com)
   5 //
   6 // This software is provided 'as-is', without any express or implied warranty.
   7 // In no event will the authors be held liable for any damages arising from the use of this software.
   8 //
   9 // Permission is granted to anyone to use this software for any purpose,
  10 // including commercial applications, and to alter it and redistribute it freely,
  11 // subject to the following restrictions:
  12 //
  13 // 1. The origin of this software must not be misrepresented;
  14 //    you must not claim that you wrote the original software.
  15 //    If you use this software in a product, an acknowledgment
  16 //    in the product documentation would be appreciated but is not required.
  17 //
  18 // 2. Altered source versions must be plainly marked as such,
  19 //    and must not be misrepresented as being the original software.
  20 //
  21 // 3. This notice may not be removed or altered from any source distribution.
  22 //
  23 ////////////////////////////////////////////////////////////
  24
  25 #ifndef SFML_MUTEXUNIX_HPP
  26 #define SFML_MUTEXUNIX_HPP
  27
  28 ////////////////////////////////////////////////////////////
  29 // Headers
  30 ////////////////////////////////////////////////////////////
  31 #include <SFML/System/NonCopyable.hpp>
  32 #include <pthread.h>
  33
  34
  35 namespace sf
  36 {
  37 ////////////////////////////////////////////////////////////
  38 /// Mutex defines a mutex (MUTual EXclusion) object,
  39 /// that allows a thread to lock critical instructions
  40 /// to avoid simultaneous access with other threads.
  41 /// See Lock for an efficient way of using it.
  42 ////////////////////////////////////////////////////////////
  43 class SFML_API Mutex : NonCopyable
  44 {
  45 public :
  46
  47     ////////////////////////////////////////////////////////////
  48     /// Default constructor
  49     ///
  50     ////////////////////////////////////////////////////////////
  51     Mutex();
  52
  53     ////////////////////////////////////////////////////////////
  54     /// Destructor
  55     ///
  56     ////////////////////////////////////////////////////////////
  57     ~Mutex();
  58
  59     ////////////////////////////////////////////////////////////
  60     /// Lock the mutex
  61     ///
  62     ////////////////////////////////////////////////////////////
  63     void Lock();
  64
  65     ////////////////////////////////////////////////////////////
  66     /// Unlock the mutex
  67     ///
  68     ////////////////////////////////////////////////////////////
  69     void Unlock();
  70
  71 private :
  72
  73     ////////////////////////////////////////////////////////////
  74     // Member data
  75     ////////////////////////////////////////////////////////////
  76     pthread_mutex_t myMutex; ///< pthread instance of the mutex
  77 };
  78
  79 } // namespace sf
  80
  81
  82 #endif // SFML_MUTEXUNIX_HPP