1 | // Copyright (c) 2013 by István Váradi
|
---|
2 |
|
---|
3 | // This file is part of libxplcommon, a common utility library for
|
---|
4 | // development related to X-Plane
|
---|
5 |
|
---|
6 | // Redistribution and use in source and binary forms, with or without
|
---|
7 | // modification, are permitted provided that the following conditions are met:
|
---|
8 |
|
---|
9 | // 1. Redistributions of source code must retain the above copyright notice, this
|
---|
10 | // list of conditions and the following disclaimer.
|
---|
11 | // 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
12 | // this list of conditions and the following disclaimer in the documentation
|
---|
13 | // and/or other materials provided with the distribution.
|
---|
14 |
|
---|
15 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
---|
16 | // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
---|
17 | // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
---|
18 | // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
---|
19 | // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
---|
20 | // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
---|
21 | // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
---|
22 | // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
---|
23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
---|
24 | // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
25 |
|
---|
26 | // The views and conclusions contained in the software and documentation are those
|
---|
27 | // of the authors and should not be interpreted as representing official policies,
|
---|
28 | // either expressed or implied, of the FreeBSD Project.
|
---|
29 |
|
---|
30 | #ifndef XPLCOMMON_WIN32_THREAD_H
|
---|
31 | #define XPLCOMMON_WIN32_THREAD_H
|
---|
32 | //------------------------------------------------------------------------------
|
---|
33 |
|
---|
34 | #include <windows.h>
|
---|
35 |
|
---|
36 | //------------------------------------------------------------------------------
|
---|
37 |
|
---|
38 | namespace xplcommon { namespace win32 {
|
---|
39 |
|
---|
40 | //------------------------------------------------------------------------------
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * A Win32 API thread implementation.
|
---|
44 | */
|
---|
45 | class Thread
|
---|
46 | {
|
---|
47 | public:
|
---|
48 | /**
|
---|
49 | * Sleep for the given number of milliseconds.
|
---|
50 | */
|
---|
51 | static void sleep(unsigned millis);
|
---|
52 |
|
---|
53 | private:
|
---|
54 | /**
|
---|
55 | * The thread-runner function.
|
---|
56 | */
|
---|
57 | static DWORD WINAPI threadFn(LPVOID arg);
|
---|
58 |
|
---|
59 | /**
|
---|
60 | * Indicate if the thread is detached.
|
---|
61 | */
|
---|
62 | bool detached;
|
---|
63 |
|
---|
64 | /**
|
---|
65 | * The thread handle.
|
---|
66 | */
|
---|
67 | HANDLE handle;
|
---|
68 |
|
---|
69 | public:
|
---|
70 | /**
|
---|
71 | * Construct the thread object.
|
---|
72 | */
|
---|
73 | Thread(bool detached = false);
|
---|
74 |
|
---|
75 | /**
|
---|
76 | * Virtual destructor.
|
---|
77 | */
|
---|
78 | virtual ~Thread();
|
---|
79 |
|
---|
80 | /**
|
---|
81 | * Start the thread.
|
---|
82 | *
|
---|
83 | * @return if the thread could be started
|
---|
84 | */
|
---|
85 | bool start();
|
---|
86 |
|
---|
87 | /**
|
---|
88 | * Perform the thread's real operation.
|
---|
89 | */
|
---|
90 | virtual void run() = 0;
|
---|
91 |
|
---|
92 | /**
|
---|
93 | * Wait for the thread to quit.
|
---|
94 | */
|
---|
95 | void join();
|
---|
96 |
|
---|
97 | void release();
|
---|
98 | };
|
---|
99 |
|
---|
100 | //------------------------------------------------------------------------------
|
---|
101 | // Inline definitions
|
---|
102 | //------------------------------------------------------------------------------
|
---|
103 |
|
---|
104 | inline void Thread::sleep(unsigned millis)
|
---|
105 | {
|
---|
106 | Sleep(millis);
|
---|
107 | }
|
---|
108 |
|
---|
109 | //------------------------------------------------------------------------------
|
---|
110 |
|
---|
111 | inline Thread::Thread(bool detached) :
|
---|
112 | detached(detached),
|
---|
113 | handle(0)
|
---|
114 | {
|
---|
115 | }
|
---|
116 |
|
---|
117 | //------------------------------------------------------------------------------
|
---|
118 |
|
---|
119 | inline Thread::~Thread()
|
---|
120 | {
|
---|
121 | }
|
---|
122 |
|
---|
123 | //------------------------------------------------------------------------------
|
---|
124 |
|
---|
125 | inline bool Thread::start()
|
---|
126 | {
|
---|
127 | handle = CreateThread(0, 0, &threadFn, this, 0, 0);
|
---|
128 | bool isOK = handle!=0;
|
---|
129 | if (detached && handle!=0) {
|
---|
130 | CloseHandle(handle);
|
---|
131 | handle = 0;
|
---|
132 | }
|
---|
133 | return isOK;
|
---|
134 | }
|
---|
135 |
|
---|
136 | //------------------------------------------------------------------------------
|
---|
137 |
|
---|
138 | inline void Thread::join()
|
---|
139 | {
|
---|
140 | if (handle!=0) {
|
---|
141 | WaitForSingleObject(handle, INFINITE);
|
---|
142 | CloseHandle(handle);
|
---|
143 | }
|
---|
144 | }
|
---|
145 |
|
---|
146 | //------------------------------------------------------------------------------
|
---|
147 |
|
---|
148 | } /* namespace xplcommon::win32 */ } /* namespace xplcommon */
|
---|
149 |
|
---|
150 | //------------------------------------------------------------------------------
|
---|
151 | #endif // XPLCOMMON_WIN32_THREAD_H
|
---|
152 |
|
---|
153 | // Local Variables:
|
---|
154 | // mode: C++
|
---|
155 | // c-basic-offset: 4
|
---|
156 | // indent-tabs-mode: nil
|
---|
157 | // End:
|
---|