blob: c6de09f8d31119f72b851ae98079ff0cf912d86f (
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
79
80
81
82
|
/**
* Copyright 2015 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/status.h"
#include "mongo/stdx/functional.h"
namespace mongo {
namespace repl {
/**
* Used by cloner test fixture to centralize life cycle testing.
*
* Life cycle interface for collection and database cloners.
*/
class BaseCloner {
public:
/**
* Callback function to report final status of cloning.
*/
using CallbackFn = stdx::function<void(const Status&)>;
virtual ~BaseCloner() {}
/**
* Returns diagnostic information.
*/
virtual std::string getDiagnosticString() const = 0;
/**
* Returns true if the cloner has been started (but has not completed).
*/
virtual bool isActive() const = 0;
/**
* Starts cloning by scheduling initial command to be run by the executor.
*/
virtual Status start() = 0;
/**
* Cancels current remote command request.
* Returns immediately if cloner is not active.
*
* Callback function may be invoked with an ErrorCodes::CallbackCanceled status.
*/
virtual void cancel() = 0;
/**
* Waits for active remote commands and database worker to complete.
* Returns immediately if cloner is not active.
*/
virtual void wait() = 0;
};
} // namespace repl
} // namespace mongo
|
