paludis  Version 2.6.0
thread_pool.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2007, 2008, 2011 Ciaran McCreesh
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_PALUDIS_UTIL_THREAD_POOL_HH
21 #define PALUDIS_GUARD_PALUDIS_UTIL_THREAD_POOL_HH 1
22 
24 #include <paludis/util/pimp.hh>
25 #include <functional>
26 
27 /** \file
28  * Declarations for the ThreadPool class.
29  *
30  * \ingroup g_threads
31  *
32  * \section Examples
33  *
34  * - None at this time.
35  */
36 namespace paludis
37 {
38  /**
39  * A thread pool holds a number of related threads.
40  *
41  * \ingroup g_threads
42  * \nosubgrouping
43  * \since 0.26
44  */
46  {
47  private:
48  Pimp<ThreadPool> _imp;
49 
50  public:
51  ///\name Basic operations
52  ///\{
53 
54  ThreadPool();
55  ~ThreadPool();
56 
57  ///\}
58 
59  /**
60  * Create a new thread in our pool.
61  */
62  void create_thread(const std::function<void () noexcept> &);
63 
64  /**
65  * How many threads does our pool contain?
66  */
67  unsigned number_of_threads() const;
68  };
69 
70  extern template class Pimp<ThreadPool>;
71 }
72 
73 #endif
Definition: pimp.hh:51
Definition: about_metadata-fwd.hh:23
Definition: thread_pool.hh:45
#define PALUDIS_VISIBLE
Definition: attributes.hh:59