threadpool.h

Go to the documentation of this file.

/*
 * threadpool.h
 *
 * Copyright (C) 2007,2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Basic thread pool API.
 */

#ifndef WAVEPACKET_THREADPOOL_H__
#define WAVEPACKET_THREADPOOL_H__

// includes --------------------------------------------------------------------
#include "common/common.h"
#include "threadsafe/smart_ptr.h"


// forward declarations
class Datahash;


/// \ingroup threading
/*@{*/

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup threadpool Thread Pool API
///
/// Caller can provide a Datahash containing configuration.  This initializes
/// a pool of worker threads.
///
/// Then the caller can add requests to the pool.  The next available worker
/// will pick up and execute the request.
///
/// NOTE: This isn't actually a thread pool yet!  This library creates threads
/// per request.  But the API should be stable, and a real thread pool can be
/// implemented underneath.
///
////////////////////////////////////////////////////////////////////////////////

/*@{*/


namespace threadpool {


/// caller provides work for threads in this format
typedef void (*thread_work_fn)(IN void * context);



/// base threadpool object
class Pool {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Pool(void) throw();

        // threadpool::Pool class interface methods ----------------------------
        virtual bool addRequest(IN thread_work_fn fn,
                                IN void * context) = 0;

        // static public methods (factory methods) -----------------------------
        static smart_ptr<Pool> create(IN const Datahash * params);
};



};      // threadpool namespace

#endif  // WAVEPACKET_THREADPOOL_H__