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) 2018-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 <string>
#include "mongo/db/jsobj.h"
namespace mongo {
class Status;
struct WriteConcernOptions {
public:
enum class SyncMode { UNSET, NONE, FSYNC, JOURNAL };
static constexpr int kNoTimeout = 0;
static constexpr int kNoWaiting = -1;
static const BSONObj Default;
static const BSONObj Acknowledged;
static const BSONObj Unacknowledged;
static const BSONObj Majority;
static constexpr StringData kWriteConcernField = "writeConcern"_sd;
static const char kMajority[]; // = "majority"
static constexpr Seconds kWriteConcernTimeoutSystem{15};
static constexpr Seconds kWriteConcernTimeoutMigration{30};
static constexpr Seconds kWriteConcernTimeoutSharding{60};
static constexpr Seconds kWriteConcernTimeoutUserCommand{60};
// It is assumed that a default-constructed WriteConcernOptions will be populated with the
// default options. If it is subsequently populated with non-default options, it is the caller's
// responsibility to set the usedDefault and usedDefaultW flag correctly.
WriteConcernOptions()
: syncMode(SyncMode::UNSET),
wNumNodes(1),
wMode(""),
wTimeout(0),
usedDefault(true),
usedDefaultW(true) {}
WriteConcernOptions(int numNodes, SyncMode sync, int timeout);
WriteConcernOptions(int numNodes, SyncMode sync, Milliseconds timeout);
WriteConcernOptions(const std::string& mode, SyncMode sync, int timeout);
WriteConcernOptions(const std::string& mode, SyncMode sync, Milliseconds timeout);
Status parse(const BSONObj& obj);
/**
* Returns an instance of WriteConcernOptions from a BSONObj.
*
* uasserts() if the obj cannot be deserialized.
*/
static WriteConcernOptions deserializerForIDL(const BSONObj& obj);
/**
* Attempts to extract a writeConcern from cmdObj.
* Verifies that the writeConcern is of type Object (BSON type).
*/
static StatusWith<WriteConcernOptions> extractWCFromCommand(const BSONObj& cmdObj);
/**
* Return true if the server needs to wait for other secondary nodes to satisfy this
* write concern setting. Errs on the false positive for non-empty wMode.
*/
bool needToWaitForOtherNodes() const;
// Returns the BSON representation of this object.
// Warning: does not return the same object passed on the last parse() call.
BSONObj toBSON() const;
SyncMode syncMode;
// The w parameter for this write concern. The wMode represents the string format and
// takes precedence over the numeric format wNumNodes.
int wNumNodes;
std::string wMode;
// Timeout in milliseconds.
int wTimeout;
// Deadline. If this is set to something other than Date_t::max(), this takes precedence over
// wTimeout.
Date_t wDeadline = Date_t::max();
// True if the default write concern was used.
bool usedDefault = false;
// True if the default 'w' value of w:1 was used.
bool usedDefaultW = false;
};
} // namespace mongo
|
