threadpool.h

Go to the documentation of this file.
00001 /*
00002  * threadpool.h
00003  *
00004  * Copyright (C) 2007,2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * Basic thread pool API.
00032  */
00033 
00034 #ifndef WAVEPACKET_THREADPOOL_H__
00035 #define WAVEPACKET_THREADPOOL_H__
00036 
00037 // includes --------------------------------------------------------------------
00038 #include "common/common.h"
00039 #include "threadsafe/smart_ptr.h"
00040 
00041 
00042 // forward declarations
00043 class Datahash;
00044 
00045 
00046 /// \ingroup threading
00047 /*@{*/
00048 
00049 ////////////////////////////////////////////////////////////////////////////////
00050 ///
00051 /// \defgroup threadpool Thread Pool API
00052 ///
00053 /// Caller can provide a Datahash containing configuration.  This initializes
00054 /// a pool of worker threads.
00055 ///
00056 /// Then the caller can add requests to the pool.  The next available worker
00057 /// will pick up and execute the request.
00058 ///
00059 /// NOTE: This isn't actually a thread pool yet!  This library creates threads
00060 /// per request.  But the API should be stable, and a real thread pool can be
00061 /// implemented underneath.
00062 ///
00063 ////////////////////////////////////////////////////////////////////////////////
00064 
00065 /*@{*/
00066 
00067 
00068 namespace threadpool {
00069 
00070 
00071 /// caller provides work for threads in this format
00072 typedef void (*thread_work_fn)(IN void * context);
00073 
00074 
00075 
00076 /// base threadpool object
00077 class Pool {
00078 public:
00079         // virtual destructor --------------------------------------------------
00080         virtual ~Pool(void) throw();
00081 
00082         // threadpool::Pool class interface methods ----------------------------
00083         virtual bool addRequest(IN thread_work_fn fn,
00084                                 IN void * context) = 0;
00085 
00086         // static public methods (factory methods) -----------------------------
00087         static smart_ptr<Pool> create(IN const Datahash * params);
00088 };
00089 
00090 
00091 
00092 };      // threadpool namespace
00093 
00094 #endif  // WAVEPACKET_THREADPOOL_H__
00095