summaryrefslogtreecommitdiff
path: root/src/mongo/client/replica_set_monitor_transport.h
blob: cf6d3607dc2118af00fe3f86b1628ebd330badce (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
/**
 *    Copyright (C) 2021-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 Server Side 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/platform/basic.h"

#include "mongo/client/mongo_uri.h"
#include "mongo/executor/task_executor.h"
#include "mongo/s/is_mongos.h"
#include "mongo/transport/transport_layer.h"
#include "mongo/util/duration.h"
#include "mongo/util/future.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/timer.h"

namespace mongo {

/**
 * Interface for the ReplicaSetMonitorTransport. Implementations of this interface obtain a respone
 * to the 'hello' command with a provided timeout.
 */
class ReplicaSetMonitorTransport {
public:
    /**
     * Runs the 'hello' command on 'host' and returns the result. If the timeout value is reached,
     * the Future result will contain the error.
     */
    virtual Future<BSONObj> sayHello(HostAndPort host,
                                     const std::string& setName,
                                     const MongoURI& setUri,
                                     Milliseconds timeout) noexcept = 0;
    virtual ~ReplicaSetMonitorTransport();
};
using ReplicaSetMonitorTransportPtr = std::unique_ptr<ReplicaSetMonitorTransport>;

/**
 * This class uses the DBClient object to make hello requests. It is utilized in unit tests
 * to accomodate mocking the hello responses.
 */
class ReplicaSetMonitorDbClientTransport : public ReplicaSetMonitorTransport {
public:
    Future<BSONObj> sayHello(HostAndPort host,
                             const std::string& setName,
                             const MongoURI& setUri,
                             Milliseconds timeout) noexcept override;
};

/**
 * This class is used in the production version of the server to obtain hello responses.
 * It uses an executor to run the hello commands with an appropriate timeout value. The
 * executor should be multithreaded to accomodate TCP requests that do not get a reply in a
 * timely fashion.
 */
class ReplicaSetMonitorExecutorTransport : public ReplicaSetMonitorTransport {
public:
    explicit ReplicaSetMonitorExecutorTransport(executor::TaskExecutor* executor);
    Future<BSONObj> sayHello(HostAndPort host,
                             const std::string& setName,
                             const MongoURI& setUri,
                             Milliseconds timeout) noexcept override;

private:
    void _haltIfIncompatibleServer(Status status);

    struct HelloRequest {
        HelloRequest(HostAndPort h, Promise<BSONObj>&& p)
            : host(h), timer(Timer()), promise(std::move(p)) {}
        HostAndPort host;
        Timer timer;
        Promise<BSONObj> promise;
    };

    executor::TaskExecutor* const _executor;
};
}