ThreadControl Class Reference

Thread synchronization and communication class. More...

#include <ThreadControl.h>

Public Member Functions
	ThreadControl ()
virtual	~ThreadControl (void)
bool	Init (UINT threadMsg, DWORD parentID, AFX_THREADPROC threadProc, void *data)
void	Quit ()
void	Run ()
	ThreadControl ()
virtual	~ThreadControl (void)
bool	Init (UINT threadMsg, DWORD parentID, AFX_THREADPROC threadProc, void *data)
void	Quit ()
void	Run ()

Public Attributes
CWinThread *	m_thread
	the thread that we want to control More...
CEvent *	m_runEvent
	when this event is received, run the child's function once More...
CEvent *	m_doneEvent
	when this event is received, terminate the thread More...
HANDLE	m_events [2]
UINT	m_threadMsg
	message to send to parent thread More...
DWORD	m_parentID
	the thread to send the message to More...
void *	m_data
	pointer to whatever is useful More...

Protected Member Functions
void	InitEvents ()
bool	InitThread (AFX_THREADPROC threadProc)
void	InitEvents ()
bool	InitThread (AFX_THREADPROC threadProc)

Detailed Description

Thread synchronization and communication class.

This class simplifies the task of having 2 threads communicate with each other.

Thread control is done using CEvent objects, by calling WaitForMultipleObjects(). The child thread will block until it receives either of 2 objects: RUN_OBJECT tells the thread to run its function, and send a message to its parent thread DONE_OBJECT tells the thread to quit

A pointer to a ThreadControl object should be passed as the thread function's single parameter

Constructor & Destructor Documentation

ThreadControl::ThreadControl

(

)

References DONE_INDEX, m_data, m_doneEvent, m_events, m_runEvent, m_thread, and RUN_INDEX.

{
   m_thread    = NULL;
   m_data      = NULL;
   m_runEvent  = new CEvent(FALSE, FALSE);
   m_doneEvent = new CEvent(FALSE, FALSE);
   m_events[RUN_INDEX]  = m_runEvent->m_hObject;
   m_events[DONE_INDEX] = m_doneEvent->m_hObject;
}

ThreadControl::~ThreadControl ( void  )

virtual

References m_doneEvent, m_runEvent, and m_thread.

{
   if (m_runEvent != NULL)
   {
      delete m_runEvent;
   }

   if (m_doneEvent != NULL)
   {
      delete m_doneEvent;
   }

   if (m_thread != NULL)
   {
      delete m_thread;
   }
}

ThreadControl::ThreadControl

(

)

virtual ThreadControl::~ThreadControl ( void  )

virtual

Member Function Documentation

bool ThreadControl::Init	(	UINT	threadMsg,
		DWORD	parentID,
		AFX_THREADPROC	threadProc,
		void *	data
	)

References InitThread(), m_data, m_parentID, and m_threadMsg.

Referenced by COperatorConsoleApp::InitBlemishThread(), COperatorConsoleApp::InitCameraThread(), and COperatorConsoleApp::InitSFRplusThread().

{
   bool  success;

   m_threadMsg = threadMsg;
   m_parentID  = parentID;
   m_data      = data;

   success = InitThread(threadProc);

   return success;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool ThreadControl::Init	(	UINT	threadMsg,
		DWORD	parentID,
		AFX_THREADPROC	threadProc,
		void *	data
	)

void ThreadControl::InitEvents ( )

protected

void ThreadControl::InitEvents ( )

protected

bool ThreadControl::InitThread ( AFX_THREADPROC  threadProc )

protected

References m_thread.

Referenced by Init().

{
   SECURITY_ATTRIBUTES  security;

   security.nLength              = sizeof(security);
   security.lpSecurityDescriptor = NULL;
   security.bInheritHandle       = TRUE;

   //
   // Create the thread.  We set auto delete to false so that we can tell when the thread
   // quits (otherwise Windows would delete the thread when threadProc returns, and its handle
   // would be invalid).
   //
   // In order to *safely* set auto delete, we have to create the thread in suspended mode.  
   // This ensures that the thread won't quit before we set auto delete.
   //
   m_thread = ::AfxBeginThread(threadProc, this, 0, 0, CREATE_SUSPENDED, &security);//NULL);

   if (m_thread != NULL)
   {
      m_thread->m_bAutoDelete = FALSE;
      m_thread->ResumeThread();
   }

   return m_thread != NULL;
}

Here is the caller graph for this function:

bool ThreadControl::InitThread ( AFX_THREADPROC  threadProc )

protected

void ThreadControl::Quit

(

)

void ThreadControl::Quit

(

)

References m_doneEvent, and m_thread.

Referenced by COperatorConsoleApp::Quit(), and COperatorConsoleApp::ReInit().

{
   if (m_thread != NULL)
   {
      m_doneEvent->SetEvent();                        // trigger the Quit event
      ::WaitForSingleObject(m_thread->m_hThread, INFINITE); // wait for it to quit
      delete m_thread;                             // delete the thread
      m_thread = NULL;
   }
}

Here is the caller graph for this function:

void ThreadControl::Run

(

)

References m_runEvent.

Referenced by COperatorConsoleApp::OnFrameReady(), and COperatorConsoleApp::OnRunTest().

{
   m_runEvent->SetEvent(); // trigger the Run event
}

Here is the caller graph for this function:

void ThreadControl::Run

(

)

Member Data Documentation

void * ThreadControl::m_data

pointer to whatever is useful

Referenced by COperatorConsoleApp::GetTestName(), Init(), ThreadControl(), ImageAcquisition::ThreadProc(), and ImageTest::ThreadProc().

CEvent * ThreadControl::m_doneEvent

when this event is received, terminate the thread

Referenced by Quit(), ThreadControl(), and ~ThreadControl().

HANDLE ThreadControl::m_events

Referenced by ThreadControl(), ImageAcquisition::ThreadProc(), and ImageTest::ThreadProc().

DWORD ThreadControl::m_parentID

the thread to send the message to

Referenced by Init(), ImageAcquisition::ThreadProc(), and ImageTest::ThreadProc().

CEvent * ThreadControl::m_runEvent

when this event is received, run the child's function once

Referenced by Run(), ThreadControl(), and ~ThreadControl().

CWinThread * ThreadControl::m_thread

the thread that we want to control

Referenced by InitThread(), Quit(), ThreadControl(), and ~ThreadControl().

UINT ThreadControl::m_threadMsg

message to send to parent thread

Referenced by Init(), ImageAcquisition::ThreadProc(), and ImageTest::ThreadProc().

---

The documentation for this class was generated from the following files:

• Documentation/Operator-Console/ThreadControl.h
• Documentation/Operator-Console/ThreadControl.cpp