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 00067 //Another flavor is a regular proc that will be called periodically 00068 typedef BOOL (*PeriodicThreadProcNoInit)(LPVOID pParam); 00069 typedef PeriodicThreadProcNoInit LPPeriodicThreadProcNoInit; 00070 public: 00071 //Set the thread priority 00072 void SetPriority(CGenericThread::ThreadPriority aPriority); 00073 00074 //Get the thread we are using 00075 CGenericThread* GetThread()const; 00076 00077 //Set the thread timeout 00078 void SetThreadTimeout(DWORD dwTimeout); 00079 00080 //Start the thread 00081 //dwInterval - Interval to run the thread at (MS) 00082 //lpData - Custome user data to pass to the thread 00083 BOOL Start(DWORD dwInterval, 00084 LPVOID lpData, 00085 BOOL bWaitOneInterval=TRUE, 00086 BOOL bIgnoreEventsOnStartup=FALSE); 00087 00088 //Stop the thread 00089 BOOL Stop(); 00090 00091 //ctor and dtor 00092 CPeriodicThread(PeriodicThreadProc pProc); 00093 CPeriodicThread(LPPeriodicThreadProcNoInit pProc); 00094 virtual ~CPeriodicThread(); 00095 private: 00096 //No copy ctor 00097 CPeriodicThread(const CPeriodicThread& rThread); 00098 00099 //No assignment operator 00100 CPeriodicThread& operator=(const CPeriodicThread& rThread); 00101 00102 //Our thread proc 00103 static DWORD PeriodicThread(LPVOID lpData); 00104 00105 //Our thread 00106 CGenericThread* m_pThread; 00107 00108 //The user proc 00109 LPPeriodicThreadProc m_pUserProc; 00110 00111 //Another option of user proc 00112 LPPeriodicThreadProcNoInit m_pUserProcNoInit; 00113 00114 //Our enter event 00115 CGenericEvent* m_pEnterEvent; 00116 00117 //Our exit event 00118 CGenericEvent* m_pExitEvent; 00119 00120 //Our timeout interval 00121 DWORD m_dwInterval; 00122 00123 //Thread timeout (for events) 00124 DWORD m_dwThreadTimeout; 00125 00126 //Are we in the destructor 00127 BOOL m_bDestructor; 00128 00129 //Did the user abort 00130 BOOL m_bAbort; 00131 00132 //User's data 00133 LPVOID m_lpData; 00134 00135 //Do we wait one interval 00136 BOOL m_bWaitOneInterval; 00137 }; 00138 00139 KOMODIA_NAMESPACE_END 00140 00141 #endif // !defined(AFX_PERIODICTHREAD_H__546E2D99_B36C_4F6A_B339_90BD817B5F2C__INCLUDED_) |