overview.txt

threadpool is a cross-platform C++ thread pool library

/*! \mainpage threadpool


\section intro_sec threadpool
threadpool is a cross-platform C++ thread pool library. In general terms thread pools
are an efficient mechanism for asynchronous processing within the same process. 
They realise the <A HREF="design/pattern.html"> thread pool pattern</A>.

A thread pool manages a group of threads to process an unlimited number of tasks. 
Since 
multiple threads can be executed in parallel on many computer systems this 
approach may be very efficient regarding the overall program performance. 
By restricting the number of threads and by reusing them system resources are saved.

The threadpool library provides a convenient way for dispatching asynchronous tasks.
It can be customized, managed dynamically and easily integrated into 
your software.


\section dev_status_sec Development Status & Future Work
The threadpool core classes are completed. I'm currently working on helper and service classes which make the 
usage of the pool more comfortable. A small tutorial introduces the thread pool and 
more example code will be added in future. The documentation is far away from being finished.
<BR><A HREF="http://threadpool.cvs.sourceforge.net/threadpool/threadpool">Browse CVS Repository</A>

<P>
Features
- Dynamic pool template that allows growing and shrinking on demand<BR>
- Task schedulers: fifo, lifo and priority<BR>
- Several task wrappers for your own task functions and objects<BR>
- Easy-to-use pool smart pointer<BR>
- Smooth integration into STL and boost<BR>
- Examples: mergesort, boost::iostreams filters
</P>

<P>
Future Work
- Pool adaptor which dynamically adapts the pool's size (static and dynamic threads)<BR>
- Deadline scheduler<BR>
- Pool adaptor which collects statistical data<BR>
- Task adaptor which allows catenation for parallel and sequential scheduling, e.g. (t1 | t2) & t3
- Possibility of limiting the number of pending tasks<BR>
- More examples to illustrate the usage of the library<BR>
</P>




\section down_sec Download Section
<P>
threadpool 0.1.8 (Development)
- <A HREF="http://prdownloads.sourceforge.net/threadpool/threadpool-0_1_8-src.zip?download">threadpool-0_1_8-src.zip</A><BR>
- <A HREF="http://prdownloads.sourceforge.net/threadpool/threadpool-0_1_8-doc.zip?download">threadpool-0_1_8-doc.zip</A><BR>
</P>


\section  platforms_sec Supported Platforms
threadpool is highly portable. It runs on any platform on which Boost threads are available: Linux, Windows, Mac OS 9/X, Solaris, etc.


\section boost_sec Boost Libraries
Boost is a collection of high-quality C++ libraries and works on almost any
modern operating system, including UNIX and Windows variants. 
In fact threadpool is only a small extension to the portable Boost source libraries. 
It incorporates the thread pool concept by using the thread library from William Kempf.
For more information on this excellent library visit <A HREF="http://www.boost.org">Boost.org</A>.


\section installation_sec Installing & Using threadpool
threadpool consists only of header files, and and so there is no need to build the library itself 
before using it in your own applications. You simply need to add the 
following directories to your compiler include path:<BR>
    - threadpool's include directory<BR>
    - the boost directory (e.g. the one called boost_1_33_0)<BR>

Furthermore you have to compile boost's thread library and link against it (libboost_thread-*.lib under Windows).

For more information see \ref installation.


\section license_sec Software License
threadpool is released under the \ref license "Boost Software License". 
This license encourages both commercial and non-commercial use.


\section acknowledgments_sec Acknowledgments
This library was written by Philipp Henkel.
<P>
I appreciate your suggestions, and would love to know if you 
use threadpool. Hopefully you will enjoy it and find it useful. 
Please post questions, comments, bugs, or contact me at:

</P>

[e-mail]<BR>
or<BR>
<A HREF="http://www.sourceforge.net/projects/threadpool">www.sourceforge.net/projects/threadpool</A>
<BR>
<BR>
*/



/*! \page license Software License

\verbinclude LICENSE_1_0.txt 

*/
 
 
 
 /*! \page installation Installation


TODO
 <BR>
 <BR>

 */