aboutsummaryrefslogtreecommitdiff
path: root/paludis/util/idle_action_pool.hh
blob: e8c5fd0fe661f63a240c0ebd2c934ebedc6a0ff1 (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * 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_IDLE_ACTION_POOL_HH
#define PALUDIS_GUARD_PALUDIS_UTIL_IDLE_ACTION_POOL_HH 1

#include <paludis/util/idle_action_pool-fwd.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/tr1_functional.hh>

namespace paludis
{
    /**
     * An IdleActionPool is an ActionQueue holding actions that can be executed
     * if there is idle CPU time available.
     *
     * \ingroup g_threads
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE IdleActionPool :
        public InstantiationPolicy<IdleActionPool, instantiation_method::SingletonTag>,
        private PrivateImplementationPattern<IdleActionPool>
    {
        friend class InstantiationPolicy<IdleActionPool, instantiation_method::SingletonTag>;

        private:
            IdleActionPool();
            ~IdleActionPool();

            void _count_result(const tr1::function<IdleActionResult () throw ()> &);

        public:
            /**
             * The specified function must be executed at some point, but it
             * doesn't matter when.
             */
            void required_idle_action(const tr1::function<IdleActionResult () throw ()> &);

            /**
             * The specified function can be executed at some point.
             */
            void optional_idle_action(const tr1::function<IdleActionResult () throw ()> &);

            /**
             * Increment the 'unused' stat.
             */
            void increase_used_stat();

            /**
             * Increment the 'unprepared' stat.
             */
            void increase_unprepared_stat();
    };
}

#endif