The Code Project View our sponsorsClick here for Dundas Software - 3D accelerated presentation quality ASP charting Advertise on the CodeProject
Home >> Threads, Processes & Inter-Process Communication >> Threads

How to use the same thread function for multiple threads (safely)
By Derek Lakin

This article shows you how to subclass CWinThread to create a class that allows multiple instances to effectively use the same thread function, safely. 
 Beginner
 VC 4-6, Win95-98, NT4, W2K, MFC
 Posted 29 May 2001
Articles by this author
Send to a friend
Printer friendly version
Lounge New Articles Sign in Forums Contribute
Broken links? Email us!
6 users have rated this article. result:
2.5 out of 5.

Introduction

My recent forray into threads and multithreaded applications has taught me a few lessons which I thought I'd pass on. As I suspect that most people know this already (it was just me taking a while to catch up), the target audience is beginners to the world of multithreading. If you're not a beginner, then please read this anyway and let me know if I've got it all wrong!

The Problem

My problem was that I wanted several threads to basically do the same thing. Being the OO developer that I am I wanted to be able to wrap this up in a class and just create several instances of that class and Bob's your uncle. Unfortunately, the function that you pass to AfxBeginThread must be either declared outside a class or be a static class member function. Being OO-type people who want to try to reduce namespace pollution we'll be using the static class member function approach, unfortunately this means that all of our class instances will be using the same function, which is exactly what I'm trying to avoid.

Racing for the Handle

By way of an introduction I'll start off with a brief description of what AfxBeginThread does. Essentially AfxBeginThread is a helper function that handles setting up and starting a CWinThread object for us. To do this it goes through (broadly speaking) four steps:

  1. Allocate a new CWinThread object on the heap.
  2. Call CWinThread::CreateThread() setting it to initially start suspended.
  3. Set the thread's priority.
  4. Call CWinThread::ResumeThread().

The default usage of CWinThread and AfxBeginThread has a slight problem. By default, as soon as the thread has completed it is deleted and so if our thread doesn't take much time to complete, by the time that AfxBeginThread returns our CWinThread pointer may already have been deleted and so dereferencing this pointer to get at the thread handle for a WaitForSingleObject() call will cause our application to crash.

Fortunately CWinThread provides a simple answer to this by way of the m_bAutoDelete member variable. As described above, this is TRUE by default. However, if we set it to FALSE, then the thread will not delete itself when it completes. This does have the same handle racing problem described above, because we can't access the member until AfxBeginThread returns, by which time it could already have been deleted! The answer is not to use the default AfxBeginThread and to create the thread initially suspended:

	CWinThread* pThread = AfxBeginThread (ThreadFunc, lpVoid, THREAD_PRIORITY_NORMAL, 0, CREATE_SUSPENDED);
	ASSERT (NULL != pThread);
	pThread->m_bAutoDelete = FALSE;
	pThread->ResumeThread ();

Obviously, this does entail a little extra handling ourselves, but we're big boys and girls now aren't we!

The Solution

The solution to our problem isn't too complex and doesn't require too much work. Essentially, we are going to derive a class from CWinThread with a static member thread function, but this thread function will call a non-static member function to do the main guts of what our thread is supposed to do. It will also set the m_bAutoDelete member to FALSE in the constructor to overcome the handle racing problem.

Basically our class will look like this:

class CThreadEx : public CWinThread {
public:
	CMyThread (AFX_THREADPROC pfnThreadProc);
	static UINT ThreadFunc (LPVOID lpParam);
protected:
	virtual UINT Execute ();
};

CThreadEx::CThreadEx (AFX_THREADPROC pfnThreadProc) : CWinThread (pfnThreadProc, NULL) {
	m_bAutoDelete = FALSE;
	
	// Undocumented variable. Need to set the thread parameters variable to this
	m_pThreadParams = this;
}

// Static
UINT CThreadEx::ThreadFunc (LPVOID lpParam) {
	ASSERT (NULL != lpParam);
	CThreadEx* pThread = (CThreadEx*)lpParam;
	return pThread->Execute ();
}

UINT CThreadEx::Execute () {
	// Do something useful ...
	// Return a value to indicate success/failure
	return 0;
}	

Those of you with a keen eye will have noticed that the constructor for CThreadEx uses an initialiser list to call a CWinThread constructor that isn't documented. If you look in "thrdcore.cpp", you'll find a constructor that looks like this:

CWinThread::CWinThread(AFX_THREADPROC pfnThreadProc, LPVOID pParam)
{
	m_pfnThreadProc = pfnThreadProc;
	m_pThreadParams = pParam;

	CommonConstruct();
}

This introduces us to two undocumented features, firstly the constructor itself, and secondly the member variables m_pfnThreadProc and m_pfnThreadParams. Also in "thrdcore.cpp" is the source for AfxBeginThread itself. The line below shows the use of the above constructor:

	CWinThread* pThread = DEBUG_NEW CWinThread(pfnThreadProc, pParam);

This is a rather obscure ommission to have made, but we live and learn. The two parameters to this constructor are clearly the thread function and the parameter to be passed to the thread function. In the class outlined above the parameter to the thread function needs to be a pointer to the class instance, so our constructor sets m_pThreadParams = this.

Implementation

You have two options when it comes to implementing this solution. If you only require a one off solution, then use the above class as a template and build your functionality into it. If you think that this is something you'll be doing quite a lot, then define the above class as your base class and inherit from it putting your functionality in the derived class.

Using it all looks something like this:

	CThreadEx* pThread = new CThreadEx (CThreadEx::ThreadFunc);
	VERIFY (pThread->CreateThread());
	...
	WaitForSingleObject (pThread->m_hThread, INFINITE);
	delete pThread;

The thread can be initially started suspended by specifying CREATE_SUSPENDED as the first parameter to the CreateThread() call if this functionality is required. Also, if you need to use a thread priority other than THREAD_PRIORITY_NORMAL just call SetThreadPriority() after CreateThread().

Conclusion

And there you have it ... a thread class that allows multiple instances to manipulate their own member data, etc. without having to have a separate thread function for each one. I hope this helps someone out there, it certainly helped me.

About Derek Lakin

Derek is a first class honours graduate in Software Engineering.
His focus is mainly on GUI application development using VC++ and MFC, but his skillset includes VB and VBScript, Java and JavaScript, web site development and databases such as SQL Server, Access and Interbase.
Derek has recently started his own company to start contracting.

Click here to visit Derek Lakin's homepage.

[Top] Sign in to vote for this article:     PoorExcellent  
Hint: For improved responsiveness, use Internet Explorer 4 (or above) with Javascript enabled, choose 'Use DHTML' from the View dropdown and hit 'Set Options'.
 Keyword Filter
 View   Per page   Messages since
New threadMessages 1 to 5 of 5 (Total: 5)First Prev Next Last
Subject 
Author 
Date 
  Thank you for your comments
Derek Lakin 9:41 6 Jun 01 
  No problem to use AfxBeginThread
Martin Richter 9:13 6 Jun 01 
  Questions?
Karl Klose 13:15 30 May 01 
  Re: Questions?
Derek Lakin 11:29 31 May 01 
  Re: Questions?
Mike Klimentiev 17:09 4 Jun 01 
Last Visit: 12:00 Friday 1st January, 1999First Prev Next Last

Home >> Threads, Processes & Inter-Process Communication >> Threads
last updated 29 May 2001
Article content copyright Derek Lakin, 2001
everything else © CodeProject, 1999-2001.
The Code Project View our sponsorsGet your new domain name now!Advertise on the CodeProject