aboutsummaryrefslogtreecommitdiff
path: root/paludis/util/action_queue.hh
blob: 479cff502d726c51a4656677414c94e9b21fc590 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2007, 2008, 2010, 2011 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_UTIL_ACTION_QUEUE_HH
#define PALUDIS_GUARD_PALUDIS_UTIL_ACTION_QUEUE_HH 1

#include <paludis/util/pimp.hh>
#include <paludis/util/attributes.hh>
#include <functional>

namespace paludis
{
    /**
     * An ActionQueue consists of a number of threads that take tasks from a
     * queue.
     *
     * If threads are disabled, enqueueing an item executes it immediately.
     *
     * \ingroup g_threads
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE ActionQueue
    {
        private:
            Pimp<ActionQueue> _imp;

        public:
            ///\name Basic operations
            ///\{

            ActionQueue(const unsigned n_threads = 1, const bool nice = false, const bool limit_size = true);
            ~ActionQueue();

            ///\}

            /**
             * Enqueue an item.
             */
            void enqueue(const std::function<void () throw ()> &);

            /**
             * Complete any pending tasks.
             */
            void complete_pending();

            /**
             * Forget any pending tasks.
             */
            void forget_pending();

            /**
             * How many threads do we have?
             */
            unsigned number_of_threads() const;
    };

    extern template class Pimp<ActionQueue>;

}

#endif