summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/reporter.h
blob: 36caa78fe6b1db7dc36ca9219a3784974627e22b (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/**
 *    Copyright (C) 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/db/repl/replication_executor.h"
#include "mongo/stdx/functional.h"

namespace mongo {
namespace repl {

    class ReplicationProgressManager {
        public:
            virtual bool prepareReplSetUpdatePositionCommand(BSONObjBuilder* cmdBuilder) = 0;
            virtual ~ReplicationProgressManager();
    };

    class Reporter {
        MONGO_DISALLOW_COPYING(Reporter);

    public:
        Reporter(ReplicationExecutor* executor,
                 ReplicationProgressManager* ReplicationProgressManager,
                 const HostAndPort& target);
        virtual ~Reporter();

        /**
         * Returns true if a remote command has been scheduled (but not completed)
         * with the executor.
         */
        bool isActive() const;

        /**
         * Returns true if a remote command should be scheduled once the current one returns 
         * from the executor.
         */
        bool willRunAgain() const;

        /**
         * Cancels remote command request.
         * Returns immediately if the Reporter is not active.
         */
        void cancel();

        /**
         * Waits for last/current executor handle to finish.
         * Returns immediately if the handle is invalid.
         */
        void wait();

        /**
         * Signals to the Reporter that there is new information to be sent to the "_target" server.
         * Returns the _status, indicating any error the Reporter has encountered.
         */
        Status trigger();

        /**
         * Returns the previous return status so that the owner can decide whether the Reporter
         * needs a new target to whom it can report.
         */
        Status getStatus() const;

    private:
        /**
         * Schedules remote command to be run by the executor
         */
        Status _schedule_inlock();

        /**
         * Callback for remote command.
         */
        void _callback(const ReplicationExecutor::RemoteCommandCallbackData& rcbd);

        // Not owned by us.
        ReplicationExecutor* _executor;
        ReplicationProgressManager* _updatePositionSource;

        // Host to whom the Reporter sends updates.
        HostAndPort _target;

        // Protects member data of this Reporter.
        mutable boost::mutex _mutex;

        // Stores the most recent Status returned from the ReplicationExecutor.
        Status _status;

        // _willRunAgain is true when Reporter is scheduled to be run by the executor and subsequent
        // updates have come in.
        bool _willRunAgain;
        // _active is true when Reporter is scheduled to be run by the executor.
        bool _active;

        // Callback handle to the scheduled remote command.
        ReplicationExecutor::CallbackHandle _remoteCommandCallbackHandle;
    };

} // namespace repl
} // namespace mongo