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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/**
* Copyright (C) 2017 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects
* for all of the code used other than as permitted herein. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you do not
* wish to do so, delete this exception statement from your version. If you
* delete this exception statement from all source files in the program,
* then also delete it in the license file.
*/
#pragma once
#include "mongo/base/disallow_copying.h"
#include "mongo/stdx/functional.h"
#include "mongo/util/time_support.h"
namespace mongo {
class Client;
/**
* An interface for objects that run work items at specified intervals.
*
* Implementations may use whatever internal threading and eventing
* model they wish. Implementations may choose when to stop running
* scheduled jobs (for example, some implementations may stop running
* when the server is in global shutdown).
*
* The runner will create client objects that it passes to jobs to use.
*/
class PeriodicRunner {
public:
using Job = stdx::function<void(Client* client)>;
struct PeriodicJob {
PeriodicJob(Job callable, Milliseconds period)
: job(std::move(callable)), interval(period) {}
/**
* A task to be run at regular intervals by the runner.
*/
Job job;
/**
* An interval at which the job should be run. Defaults to 1 minute.
*/
Milliseconds interval;
};
virtual ~PeriodicRunner();
/**
* Schedules a job to be run at periodic intervals.
*
* If the runner is not running when a job is scheduled, that job should
* be saved so that it may run in the future once startup() is called.
*/
virtual void scheduleJob(PeriodicJob job) = 0;
/**
* Starts up this periodic runner.
*
* This method may safely be called multiple times, either with or without
* calls to shutdown() in between, but implementations may choose whether to
* restart or error on subsequent calls to startup().
*/
virtual Status startup() = 0;
/**
* Shuts down this periodic runner. Stops all jobs from running.
*
* This method may safely be called multiple times, either with or without
* calls to startup() in between. Any jobs that have been scheduled on this
* runner should no longer execute once shutdown() is called.
*/
virtual void shutdown() = 0;
};
} // namespace mongo
|
