MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
threadingenumerations.h
Go to the documentation of this file.
1 // The DAGFrameScheduler is a Multi-Threaded lock free and wait free scheduling library.
2 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
3 /* This file is part of The DAGFrameScheduler.
4 
5  The DAGFrameScheduler is free software: you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation, either version 3 of the License, or
8  (at your option) any later version.
9 
10  The DAGFrameScheduler is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License
16  along with The DAGFrameScheduler. If not, see <http://www.gnu.org/licenses/>.
17 */
18 /* The original authors have included a copy of the license specified above in the
19  'doc' folder. See 'gpl.txt'
20 */
21 /* We welcome the use of the DAGFrameScheduler to anyone, including companies who wish to
22  Build professional software and charge for their product.
23 
24  However there are some practical restrictions, so if your project involves
25  any of the following you should contact us and we will try to work something
26  out:
27  - DRM or Copy Protection of any kind(except Copyrights)
28  - Software Patents You Do Not Wish to Freely License
29  - Any Kind of Linking to Non-GPL licensed Works
30  - Are Currently In Violation of Another Copyright Holder's GPL License
31  - If You want to change our code and not add a few hundred MB of stuff to
32  your distribution
33 
34  These and other limitations could cause serious legal problems if you ignore
35  them, so it is best to simply contact us or the Free Software Foundation, if
36  you have any questions.
37 
38  Joseph Toppi - toppij@gmail.com
39  John Blackwood - makoenergy02@gmail.com
40 */
41 #ifndef _DAGenumerations_h
42 #define _DAGenumerations_h
43 
44 #include "datatypes.h"
45 
46 /// @file
47 /// @brief Any enumerations the threading library requires are all declared here.
48 
49 namespace Mezzanine
50 {
51  namespace Threading
52  {
53  /// @brief Used to track whether a thread has started, completed, etc...
55  {
56  NotStarted=0, ///< Task is not yet started this frame, this can change without notice.
57  Starting=1, ///< Only used when a thread successfully attempts to gain ownership of a task, or some other tasks successfully starts
58  Running=2, ///< Task is running when the value was check, it could become Complete or Failed with no notice.
59  Complete=3, ///< Thread has completed all work this from frame, will not change until this frame ends.
60  Failed=4 ///< Indicates an abnormal termination of a Workunit or other failure, Likely the whole application will need to stop.
61  };//RunningState
62  }//Threading
63 }//Mezzanine
64 #endif