summaryrefslogtreecommitdiff
path: root/src/mongo/client/sdam/sdam_configuration.h
blob: 895e52f4d8742c441a00d0983d92fc3f26802e56 (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
/**
 *    Copyright (C) 2019-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/client/sdam/sdam_datatypes.h"

namespace mongo::sdam {
class SdamConfiguration {
public:
    SdamConfiguration() : SdamConfiguration(boost::none){};

    /**
     * Initialize the TopologyDescription. This constructor may uassert if the provided
     * configuration options are not valid according to the Server Discovery & Monitoring Spec.
     *
     * Initial Servers
     * initial servers may be set to a seed list of one or more server addresses.
     *
     * Initial TopologyType
     * The initial TopologyType may be set to Single, Unknown, or ReplicaSetNoPrimary.
     *
     * Initial setName
     * The client's initial replica set name is required in order to initially configure the
     * topology type as ReplicaSetNoPrimary.
     *
     * Allowed configuration combinations
     * TopologyType Single cannot be used with multiple seeds.
     * If setName is not null, only TopologyType ReplicaSetNoPrimary and Single, are
     * allowed.
     */
    explicit SdamConfiguration(boost::optional<std::vector<ServerAddress>> seedList,
                               TopologyType initialType = TopologyType::kUnknown,
                               Milliseconds heartBeatFrequencyMs = kDefaultHeartbeatFrequencyMs,
                               boost::optional<std::string> setName = boost::none);

    const boost::optional<std::vector<ServerAddress>>& getSeedList() const;
    TopologyType getInitialType() const;
    Milliseconds getHeartBeatFrequency() const;
    const boost::optional<std::string>& getSetName() const;

    static constexpr Milliseconds kDefaultHeartbeatFrequencyMs = Seconds(10);
    static constexpr Milliseconds kMinHeartbeatFrequencyMS = Milliseconds(500);
    static constexpr Milliseconds kDefaultConnectTimeoutMS = Milliseconds(100);

private:
    boost::optional<std::vector<ServerAddress>> _seedList;
    TopologyType _initialType;
    Milliseconds _heartBeatFrequencyMs;
    boost::optional<std::string> _setName;
};

class ServerSelectionConfiguration {
public:
    explicit ServerSelectionConfiguration(const Milliseconds localThresholdMs,
                                          const Milliseconds serverSelectionTimeoutMs);

    Milliseconds getLocalThresholdMs() const;
    Milliseconds getServerSelectionTimeoutMs() const;
    Milliseconds getHeartBeatFrequencyMs() const;

    static constexpr Milliseconds kDefaultLocalThresholdMS = Milliseconds(15);
    static constexpr Milliseconds kDefaultServerSelectionTimeoutMs = Milliseconds(30000);

    static ServerSelectionConfiguration defaultConfiguration() {
        return ServerSelectionConfiguration{kDefaultLocalThresholdMS,
                                            kDefaultServerSelectionTimeoutMs};
    }

private:
    Milliseconds _localThresholdMs = kDefaultLocalThresholdMS;
    Milliseconds _serverSelectionTimeoutMs = kDefaultServerSelectionTimeoutMs;
    Milliseconds _heartBeatFrequencyMs = SdamConfiguration::kDefaultHeartbeatFrequencyMs;
};
}  // namespace mongo::sdam