PeriodicThread.hGo to the documentation of this file.00001 /* 00002 * Copyright (c) 2000-2003 Barak Weichselbaum <barak@komodia.com> 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions 00007 * are met: 00008 * 1. Redistributions of source code must retain the above copyright 00009 * notice, this list of conditions and the following disclaimer. 00010 * 2. Redistributions in binary form must reproduce the above copyright 00011 * notice, this list of conditions and the following disclaimer in the 00012 * documentation and/or other materials provided with the distribution. 00013 * 00014 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 00015 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00016 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00017 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 00018 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00019 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 00020 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00021 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00022 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 00023 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00024 * SUCH DAMAGE. 00025 * 00026 * Contact info: 00027 * ------------- 00028 * 00029 * Site: http://www.komodia.com 00030 * Main contact: barak@komodia.com 00031 * For custom projects, 00032 * consulting, or other 00033 * paid services: sales@komodia.com 00034 */ 00035 00036 #if !defined(AFX_PERIODICTHREAD_H__546E2D99_B36C_4F6A_B339_90BD817B5F2C__INCLUDED_) 00037 #define AFX_PERIODICTHREAD_H__546E2D99_B36C_4F6A_B339_90BD817B5F2C__INCLUDED_ 00038 00039 #if _MSC_VER > 1000 00040 #pragma once 00041 #endif // _MSC_VER > 1000 00042 00043 #include "ErrorHandler.h" 00044 #include "GenericThread.h" 00045 00046 KOMODIA_NAMESPACE_START 00047 00048 class CGenericEvent; 00049 00050 class CPeriodicThread : public CErrorHandler 00051 { 00052 public: 00053 //Our enum 00054 typedef enum _ThreadStage 00055 { 00056 tsStart, 00057 tsBody, 00058 tsEnd 00059 } ThreadStage; 00060 00061 //Our thread proc 00062 //If the proc returns FALSE, the thread will abort 00063 typedef BOOL (*PeriodicThreadProc)(ThreadStage aStage, 00064 LPVOID pParam); 00065 typedef PeriodicThreadProc LPPeriodicThreadProc; 00066 public: 00067 //Set the thread priority 00068 void SetPriority(CGenericThread::ThreadPriority aPriority); 00069 00070 //Get the thread we are using 00071 CGenericThread* GetThread()const; 00072 00073 //Set the thread timeout 00074 void SetThreadTimeout(DWORD dwTimeout); 00075 00076 //Start the thread 00077 //dwInterval - Interval to run the thread at (MS) 00078 //lpData - Custome user data to pass to the thread 00079 BOOL Start(DWORD dwInterval, 00080 LPVOID lpData); 00081 00082 //Stop the thread 00083 BOOL Stop(); 00084 00085 //ctor and dtor 00086 CPeriodicThread(PeriodicThreadProc pProc); 00087 virtual ~CPeriodicThread(); 00088 private: 00089 //No copy ctor 00090 CPeriodicThread(const CPeriodicThread& rThread); 00091 00092 //No assignment operator 00093 CPeriodicThread& operator=(const CPeriodicThread& rThread); 00094 00095 //Our thread proc 00096 static DWORD PeriodicThread(LPVOID lpData); 00097 00098 //Our thread 00099 CGenericThread* m_pThread; 00100 00101 //The user proc 00102 PeriodicThreadProc m_pUserProc; 00103 00104 //Our enter event 00105 CGenericEvent* m_pEnterEvent; 00106 00107 //Our exit event 00108 CGenericEvent* m_pExitEvent; 00109 00110 //Our timeout interval 00111 DWORD m_dwInterval; 00112 00113 //Thread timeout (for events) 00114 DWORD m_dwThreadTimeout; 00115 00116 //Are we in the destructor 00117 BOOL m_bDestructor; 00118 00119 //Did the user abort 00120 BOOL m_bAbort; 00121 00122 //User's data 00123 LPVOID m_lpData; 00124 }; 00125 00126 KOMODIA_NAMESPACE_END 00127 00128 #endif // !defined(AFX_PERIODICTHREAD_H__546E2D99_B36C_4F6A_B339_90BD817B5F2C__INCLUDED_) |