summaryrefslogtreecommitdiff
path: root/src/mongo/db/wire_version.h
blob: f27f0962655f13ae8645737b8fdbd462b82335ff (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
/**
*    Copyright (C) 2013 10gen 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.
*/

namespace mongo {

    /**
     * The 'WireVersion' captures all "protocol events" the write protocol went through.  A
     * protocol event is a change in the syntax of messages on the wire or the semantics of
     * existing messages. We may also add "logical" entries for releases, although that's not
     * mandatory.
     *
     * We use the wire version to determine if two agents (a driver, a mongos, or a mongod) can
     * interact. Each agent carries two versions, a 'max' and a 'min' one. If the two agents
     * are on the same 'max' number, they stricly speak the same wire protocol and it is safe
     * to allow them to communicate. If two agents' ranges do not intersect, they should not be
     * allowed to communicate.
     *
     * If two agents have at least one version in common they can communicate, but one of the
     * sides has to be ready to compensate for not being on its partner version.
     */
    enum WireVersion {
        // Everything before we started tracking.
        RELEASE_2_4_AND_BEFORE = 0,

        // The aggregation command may now be requested to return cursors.
        AGG_RETURNS_CURSORS = 1,

        // insert, update, and delete batch command
        BATCH_COMMANDS = 2,

        // support SCRAM-SHA1, listIndexes, listCollections, new explain
        RELEASE_2_7_7 = 3
    };

    // Latest version that the server accepts. This should always be at the latest entry in
    // WireVersion.
    static const int maxWireVersion = RELEASE_2_7_7;

    // Minimum version that the server accepts. We should bump this whenever we don't want
    // to allow communication with too old agents.
    static const int minWireVersion = RELEASE_2_4_AND_BEFORE;

} // namespace mongo