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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
// Copyright (C) 2007 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_THREAD_FUNCTIOn_ABSTRACT_
#ifdef DLIB_THREAD_FUNCTIOn_ABSTRACT_
#include "threads_kernel_abstract.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
class thread_function
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a thread on a global C++ function or function
object. That is, it allows you to run a function in its own thread.
!*/
public:
template <typename F>
thread_function (
F funct
);
/*!
ensures
- #*this is properly initialized
- the function funct has been started in its own thread
throws
- std::bad_alloc
- dlib::thread_error
the constructor may throw this exception if there is a problem
gathering resources to create threading objects.
!*/
template <typename F, typename T1>
thread_function (
F funct,
T1 arg1
);
/*!
ensures
- #*this is properly initialized
- A thread has been created and it will call funct(arg1)
throws
- std::bad_alloc
- dlib::thread_error
the constructor may throw this exception if there is a problem
gathering resources to create threading objects.
!*/
template <typename F, typename T1, typename T2>
thread_function (
F funct,
T1 arg1,
T2 arg2
);
/*!
ensures
- #*this is properly initialized
- A thread has been created and it will call funct(arg1, arg2)
throws
- std::bad_alloc
- dlib::thread_error
the constructor may throw this exception if there is a problem
gathering resources to create threading objects.
!*/
template <typename F, typename T1, typename T2, typename T3>
thread_function (
F funct,
T1 arg1,
T2 arg2,
T3 arg3
);
/*!
ensures
- #*this is properly initialized
- A thread has been created and it will call funct(arg1, arg2, arg3)
throws
- std::bad_alloc
- dlib::thread_error
the constructor may throw this exception if there is a problem
gathering resources to create threading objects.
!*/
template <typename F, typename T1, typename T2, typename T3, typename T4>
thread_function (
F funct,
T1 arg1,
T2 arg2,
T3 arg3,
T4 arg4
);
/*!
ensures
- #*this is properly initialized
- A thread has been created and it will call funct(arg1, arg2, arg3, arg4)
throws
- std::bad_alloc
- dlib::thread_error
the constructor may throw this exception if there is a problem
gathering resources to create threading objects.
!*/
~thread_function (
);
/*!
ensures
- all resources allocated by *this have been freed.
- blocks until is_alive() == false
!*/
bool is_alive (
) const;
/*!
ensures
- if (this object's thread has yet to terminate) then
- returns true
- else
- returns false
!*/
void wait (
) const;
/*!
ensures
- if (is_alive() == true) then
- blocks until this object's thread terminates
!*/
private:
// restricted functions
thread_function(thread_function&); // copy constructor
thread_function& operator=(thread_function&); // assignment operator
};
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_THREAD_FUNCTIOn_ABSTRACT_
|
