keep_alive.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 
29 #pragma once
30 
31 
32 #include "../api_core.h"
33 #include "../Signals/callback_0.h"
34 #include "../Signals/callback_v1.h"
35 #include "../Signals/callback_2.h"
36 
37 namespace clan
38 {
39 
40 class Event;
41 class KeepAliveObject;
42 class KeepAliveObject_Impl;
43 
45 class CL_API_CORE KeepAlive
46 {
47 public:
51  static void process(int timeout = 0);
52 
62  static Callback_2<int /*retval*/, const std::vector<Event> &/*events*/, int /*timeout */ > &func_event_wait();
63 
67  static Callback_0<void *> &func_thread_id();
68 
72  static Callback_v1<void *> &func_awake_thread();
73 
75  static std::vector<KeepAliveObject *> get_objects();
76 };
77 
79 class CL_API_CORE KeepAliveObject
80 {
81 public:
84 
86  virtual ~KeepAliveObject();
87 
89  void set_wakeup_event();
90 
92  virtual void process() = 0;
93 
94 private:
95  std::shared_ptr<KeepAliveObject_Impl> impl;
96  friend class KeepAlive;
97 };
98 
99 }
KeepAlive application loop helper.
Definition: keep_alive.h:45
Callback_0.
Definition: callback_0.h:156
Callback_v1.
Definition: callback_v1.h:156
Callback_2.
Definition: callback_2.h:156
Interface for objects participating in the thread keep-alive processing loop.
Definition: keep_alive.h:79