ClanLib  2.3.7
Core/System/event.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
31 
32 
33 #pragma once
34 
35 
36 #include "../api_core.h"
37 #include "sharedptr.h"
38 #include "mutex.h"
39 #include <vector>
40 
41 class CL_EventProvider;
42 class CL_Event_Impl;
43 
48 {
51 
52 public:
54  CL_Event(bool manual_reset = true, bool initial_state = false);
55 
56  CL_Event(CL_EventProvider *event_provider);
57 
58  ~CL_Event();
59 
60 
64 
65 public:
67  CL_EventProvider *get_event_provider() const;
68 
69 
73 
74 public:
78  bool wait(int timeout = -1);
79 
80  static int wait(int count, CL_Event const * const * events, int timeout = -1);
81 
82  static int wait(const std::vector<CL_Event *> &events, int timeout = -1);
83 
84  static int wait(const std::vector<CL_Event> &events, int timeout = -1);
85 
86  static int wait(CL_Event &event1, int timeout = -1);
87 
88  static int wait(CL_Event &event1, CL_Event &event2, int timeout = -1);
89 
90  static int wait(CL_Event &event1, CL_Event &event2, CL_Event &event3, int timeout = -1);
91 
92  static int wait(CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, int timeout = -1);
93 
94  static int wait(CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, int timeout = -1);
95 
96  static int wait(CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, CL_Event &event6, int timeout = -1);
97 
98  static int wait(CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, CL_Event &event6, CL_Event &event7, int timeout = -1);
99 
100  static int wait(CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, CL_Event &event6, CL_Event &event7, CL_Event &event8, int timeout = -1);
101 
103  void set();
104 
106  void reset();
107 
108 
112 
113 private:
114  CL_SharedPtr<CL_Event_Impl> impl;
115 
117 };
118 
119