keep_alive.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 */
00028 
00029 #pragma once
00030 
00031 
00032 #include "../api_core.h"
00033 #include "../Signals/callback_0.h"
00034 #include "../Signals/callback_v1.h"
00035 #include "../Signals/callback_2.h"
00036 
00037 class CL_Event;
00038 class CL_KeepAliveObject;
00039 class CL_KeepAliveObject_Impl;
00040 
00044 class CL_API_CORE CL_KeepAlive
00045 {
00046 public:
00050         static void process(int timeout = 0);
00051 
00061         static CL_Callback_2<int /*retval*/, const std::vector<CL_Event> &/*events*/, int /*timeout */ > &func_event_wait();
00062     
00066     static CL_Callback_0<void *> &func_thread_id();
00067     
00071     static CL_Callback_v1<void *> &func_awake_thread();
00072 
00074         static std::vector<CL_KeepAliveObject *> get_objects();
00075 };
00076 
00080 class CL_API_CORE CL_KeepAliveObject
00081 {
00082 public:
00084         CL_KeepAliveObject();
00085 
00087         virtual ~CL_KeepAliveObject();
00088 
00090     void set_wakeup_event();
00091 
00093         virtual void process() = 0;
00094     
00095 private:
00096     CL_SharedPtr<CL_KeepAliveObject_Impl> impl;
00097     friend class CL_KeepAlive;
00098 };