thread_pool.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2007, 2008 Ciaran McCreesh
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_UTIL_THREAD_POOL_HH
00021 #define PALUDIS_GUARD_PALUDIS_UTIL_THREAD_POOL_HH 1
00022 
00023 #include <paludis/util/attributes.hh>
00024 #include <paludis/util/private_implementation_pattern.hh>
00025 #include <tr1/functional>
00026 
00027 /** \file
00028  * Declarations for the ThreadPool class.
00029  *
00030  * \ingroup g_threads
00031  *
00032  * \section Examples
00033  *
00034  * - None at this time.
00035  */
00036 namespace paludis
00037 {
00038     /**
00039      * A thread pool holds a number of related threads.
00040      *
00041      * \ingroup g_threads
00042      * \nosubgrouping
00043      * \since 0.26
00044      */
00045     class PALUDIS_VISIBLE ThreadPool :
00046         private PrivateImplementationPattern<ThreadPool>
00047     {
00048         public:
00049             ///\name Basic operations
00050             ///\{
00051 
00052             ThreadPool();
00053             ~ThreadPool();
00054 
00055             ///\}
00056 
00057             /**
00058              * Create a new thread in our pool.
00059              */
00060             void create_thread(const std::tr1::function<void () throw ()> &);
00061 
00062             /**
00063              * How many threads does our pool contain?
00064              */
00065             unsigned number_of_threads() const;
00066     };
00067 }
00068 
00069 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4