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

   1 ////////////////////////////////////////////////////////////
   2 //
   3 // SFML - Simple and Fast Multimedia Library
   4 // Copyright (C) 2007-2014 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_THREADLOCAL_HPP
  26 #define SFML_THREADLOCAL_HPP
  27
  28 ////////////////////////////////////////////////////////////
  29 // Headers
  30 ////////////////////////////////////////////////////////////
  31 #include <SFML/System/Export.hpp>
  32 #include <SFML/System/NonCopyable.hpp>
  33 #include <cstdlib>
  34
  35
  36 namespace sf
  37 {
  38 namespace priv
  39 {
  40     class ThreadLocalImpl;
  41 }
  42
  43 ////////////////////////////////////////////////////////////
  44 /// \brief Defines variables with thread-local storage
  45 ///
  46 ////////////////////////////////////////////////////////////
  47 class SFML_SYSTEM_API ThreadLocal : NonCopyable
  48 {
  49 public:
  50
  51     ////////////////////////////////////////////////////////////
  52     /// \brief Default constructor
  53     ///
  54     /// \param value Optional value to initialize the variable
  55     ///
  56     ////////////////////////////////////////////////////////////
  57     ThreadLocal(void* value = NULL);
  58
  59     ////////////////////////////////////////////////////////////
  60     /// \brief Destructor
  61     ///
  62     ////////////////////////////////////////////////////////////
  63     ~ThreadLocal();
  64
  65     ////////////////////////////////////////////////////////////
  66     /// \brief Set the thread-specific value of the variable
  67     ///
  68     /// \param value Value of the variable for the current thread
  69     ///
  70     ////////////////////////////////////////////////////////////
  71     void setValue(void* value);
  72
  73     ////////////////////////////////////////////////////////////
  74     /// \brief Retrieve the thread-specific value of the variable
  75     ///
  76     /// \return Value of the variable for the current thread
  77     ///
  78     ////////////////////////////////////////////////////////////
  79     void* getValue() const;
  80
  81 private:
  82
  83     ////////////////////////////////////////////////////////////
  84     // Member data
  85     ////////////////////////////////////////////////////////////
  86     priv::ThreadLocalImpl* m_impl; ///< Pointer to the OS specific implementation
  87 };
  88
  89 } // namespace sf
  90
  91
  92 #endif // SFML_THREADLOCAL_HPP
  93
  94
  95 ////////////////////////////////////////////////////////////
  96 /// \class sf::ThreadLocal
  97 /// \ingroup system
  98 ///
  99 /// This class manipulates void* parameters and thus is not
 100 /// appropriate for strongly-typed variables. You should rather
 101 /// use the sf::ThreadLocalPtr template class.
 102 ///
 103 ////////////////////////////////////////////////////////////