File: thread.h

package info (click to toggle)
clanlib 0.5.4-1-6
  • links: PTS
  • area: main
  • in suites: woody
  • size: 10,320 kB
  • ctags: 10,893
  • sloc: cpp: 76,056; xml: 3,281; sh: 2,961; perl: 1,204; asm: 837; makefile: 775
file content (99 lines) | stat: -rw-r--r-- 2,444 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*
	$Id: thread.h,v 1.14 2001/12/19 19:23:03 mbn Exp $

	------------------------------------------------------------------------
	ClanLib, the platform independent game SDK.

	This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
	version 2. See COPYING for details.

	For a total list of contributers see CREDITS.

	See http://www.clanlib.org
	------------------------------------------------------------------------
*/

//! clanCore="System"
//! header=core.h

#ifndef header_thread
#define header_thread

class CL_Thread_Generic;

//: Thread callback interface.
//- When a thread is created, it will call run() in its attached CL_Runnable interface.
class CL_Runnable
{
public:
//! Overrideables:
	//: Called when a thread is run.
	virtual void run()=0;
};

//: Thread Priority Enum
enum EThreadPriority
{
	cl_priority_above_normal,
	cl_priority_below_normal,
	cl_priority_highest,
	cl_priority_idle,
	cl_priority_lowest,
	cl_priority_normal,
	cl_priority_time_critical
};

//: Thread Class
class CL_Thread
{
//! Construction:
public:
	//: Create a thread that uses the CL_Runnable callback interface.
	//: Provided for ClanLib-0.4 backward compatibility.
	//- runnable - Class to call when thread is started.
	static CL_Thread *create(CL_Runnable *runnable, bool delete_runnable = false);

	//: Create a thread that calls the function specified, with the value specified.
	//: Provided for ClanLib-0.4 backward compatibility.
	//- func - Function that gets called at thread start.
	//- value - Value passed to the function at thread start.
	static CL_Thread *create(int (*func)(void*), void* value);

	//: Create a thread that uses the CL_Runnable callback interface.
	CL_Thread(CL_Runnable *runnable, bool delete_runnable = false);

	//: Create a thread that calls the function specified, with the value specified.
	CL_Thread(int (*func)(void*), void *value);

	//: Copy constructor.
	CL_Thread(const CL_Thread &copy);

	//: Null thread.
	CL_Thread();
	
	//: Destructor.
	~CL_Thread();
	
//! Operations:
public:
	//: Copy assignement operator.
	CL_Thread &operator =(const CL_Thread &copy);

	//: Starts the thread.
	void start();

	//: Terminate the thread. (use with caution under win98)
	void terminate();

	//: Wait until the thread finishes its execution.
	void wait();

	//: Set the thread priority.
	void set_priority(EThreadPriority priority);

//! Implementation:
private:
	CL_Thread_Generic *impl;
};

#endif