blob: a13b913d9aa64a1a24edd6b8da28b4e83bf74f61 (
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
|
/** \file throttle.h */ // -*-c++-*-
// Copyright (C) 2010 Daniel Burrows
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program 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; see the file COPYING. If not, write to
// the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.
#ifndef APTITUDE_UTIL_THROTTLE_H
#define APTITUDE_UTIL_THROTTLE_H
#include <memory>
namespace aptitude
{
namespace util
{
/** \brief Used to ensure that an expensive operation (such as
* updating a progress indicator) doesn't run too often.
*
* To test code that uses this class, use the mock that's
* available in mocks/.
*/
class throttle
{
public:
virtual ~throttle() = 0;
/** \return \b true if the timer has expired. */
virtual bool update_required() = 0;
/** \brief Reset the timer that controls when the display is
* updated.
*/
virtual void reset_timer() = 0;
};
/** \brief Create a throttle object.
*
* \todo This should take an argument giving the update interval
* in seconds.
*/
std::shared_ptr<throttle> create_throttle();
}
}
#endif // APTITUDE_UTIL_THROTTLE_H
|
