mirror of
https://github.com/SFML/SFML.git
synced 2025-02-19 06:39:59 +08:00
9a7fcc04be
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1023 4e206d99-4929-0410-ac5d-dfc041789085
122 lines
4.1 KiB
C++
122 lines
4.1 KiB
C++
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
|
|
//
|
|
// This software is provided 'as-is', without any express or implied warranty.
|
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it freely,
|
|
// subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented;
|
|
// you must not claim that you wrote the original software.
|
|
// If you use this software in a product, an acknowledgment
|
|
// in the product documentation would be appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such,
|
|
// and must not be misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#ifndef SFML_THREAD_HPP
|
|
#define SFML_THREAD_HPP
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Config.hpp>
|
|
#include <SFML/System/NonCopyable.hpp>
|
|
#include <cstdlib>
|
|
|
|
|
|
namespace sf
|
|
{
|
|
namespace priv
|
|
{
|
|
class ThreadImpl;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Thread defines an easy way to manipulate a thread.
|
|
/// There are two ways to use Thread :
|
|
/// - Inherit from it and override the Run() virtual function
|
|
/// - Construct a Thread instance and pass it a function
|
|
/// pointer to call
|
|
////////////////////////////////////////////////////////////
|
|
class SFML_API Thread : NonCopyable
|
|
{
|
|
public :
|
|
|
|
typedef void (*FuncType)(void*);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Construct the thread from a function pointer
|
|
///
|
|
/// \param Function : Entry point of the thread
|
|
/// \param UserData : Data to pass to the thread function (NULL by default)
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Thread(FuncType Function, void* UserData = NULL);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Virtual destructor
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual ~Thread();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Create and run the thread
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void Launch();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Wait until the thread finishes
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void Wait();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Terminate the thread
|
|
/// Terminating a thread with this function is not safe,
|
|
/// you should rather try to make the thread function
|
|
/// terminate by itself
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void Terminate();
|
|
|
|
protected :
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Default constructor
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Thread();
|
|
|
|
private :
|
|
|
|
friend class priv::ThreadImpl;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Function called as the thread entry point
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual void Run();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Member data
|
|
////////////////////////////////////////////////////////////
|
|
priv::ThreadImpl* myThreadImpl; ///< OS-specific implementation of the thread
|
|
FuncType myFunction; ///< Function to call as the thread entry point
|
|
void* myUserData; ///< Data to pass to the thread function
|
|
};
|
|
|
|
} // namespace sf
|
|
|
|
|
|
#endif // SFML_THREAD_HPP
|