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

/*
 * Copyright (c) 2009, 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_EXECUTOR_HH
#define PALUDIS_GUARD_PALUDIS_UTIL_EXECUTOR_HH 1

#include <paludis/util/executor-fwd.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/mutex-fwd.hh>
#include <string>
#include <memory>

namespace paludis
{
    class PALUDIS_VISIBLE Executive
    {
        public:
            virtual ~Executive() = 0;

            virtual std::string queue_name() const = 0;
            virtual std::string unique_id() const = 0;
            virtual bool can_run() const = 0;

            virtual void pre_execute_exclusive() = 0;
            virtual void execute_threaded() = 0;
            virtual void flush_threaded() = 0;
            virtual void post_execute_exclusive() = 0;
    };

    class PALUDIS_VISIBLE Executor
    {
        private:
            Pimp<Executor> _imp;

            void _one(const std::shared_ptr<Executive>);

        public:
            explicit Executor(const int ms_update_interval = 1000);
            ~Executor();

            int pending() const;
            int active() const;
            int done() const;

            void add(const std::shared_ptr<Executive> & x);

            void execute();

            Mutex & exclusivity_mutex() PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    extern template class Pimp<Executor>;
}

#endif