1
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited
9 // Copyright (c) 2014-2018 Francois Beaune, The appleseedhq Organization
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining a copy
12 // of this software and associated documentation files (the "Software"), to deal
13 // in the Software without restriction, including without limitation the rights
14 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 // copies of the Software, and to permit persons to whom the Software is
16 // furnished to do so, subject to the following conditions:
17 //
18 // The above copyright notice and this permission notice shall be included in
19 // all copies or substantial portions of the Software.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 // THE SOFTWARE.
28 //
29
30 #pragma once
31
32 // appleseed.foundation headers.
33 #include "foundation/platform/compiler.h"
34 #include "foundation/platform/thread.h"
35 #include "foundation/utility/job/iabortswitch.h"
36
37 // appleseed.main headers.
38 #include "main/dllsymbol.h"
39
40 namespace foundation
41 {
42
43 //
44 // A thread-safe switch to instruct threads to abort their computations.
45 //
46
47 class APPLESEED_DLLSYMBOL AbortSwitch
48 : public IAbortSwitch
49 {
50 public:
51 // Clear the abort flag.
52 void clear();
53
54 // Set the abort flag.
55 void abort();
56
57 // Check whether the abort flag is set.
58 bool is_aborted() override;
59
60 private:
61 ThreadFlag m_abort_flag;
62 };
63
64
65 //
66 // AbortSwitch class implementation.
67 //
68
clear()69 inline void AbortSwitch::clear()
70 {
71 m_abort_flag.clear();
72 }
73
abort()74 inline void AbortSwitch::abort()
75 {
76 m_abort_flag.set();
77 }
78
is_aborted()79 inline bool AbortSwitch::is_aborted()
80 {
81 return m_abort_flag.is_set();
82 }
83
84 } // namespace foundation
85