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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/**
* Copyright (C) 2012 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 here.
*/
#pragma once
#include <string>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/string_data.h"
#include "mongo/db/jsobj.h"
namespace mongo {
/**
* This class represents the layout and contents of documents contained in the
* config.lockpings collection. All manipulation of documents coming from that
* collection should be done with this class.
*
* Usage Example:
*
* // Contact the config. 'conn' has been obtained before.
* DBClientBase* conn;
* BSONObj query = QUERY(LockpingsType::exampleField("exampleFieldName"));
* exampleDoc = conn->findOne(LockpingsType::ConfigNS, query);
*
* // Process the response.
* LockpingsType exampleType;
* string errMsg;
* if (!exampleType.parseBSON(exampleDoc, &errMsg) || !exampleType.isValid(&errMsg)) {
* // Can't use 'exampleType'. Take action.
* }
* // use 'exampleType'
*
*/
class LockpingsType {
MONGO_DISALLOW_COPYING(LockpingsType);
public:
//
// schema declarations
//
// Name of the lockpings collection in the config server.
static const std::string ConfigNS;
// Field names and types in the lockpings collection type.
static const BSONField<std::string> process;
static const BSONField<Date_t> ping;
//
// lockpings type methods
//
LockpingsType();
~LockpingsType();
/**
* Returns true if all the mandatory fields are present and have valid
* representations. Otherwise returns false and fills in the optional 'errMsg' string.
*/
bool isValid(std::string* errMsg) const;
/**
* Returns the BSON representation of the entry.
*/
BSONObj toBSON() const;
/**
* Clears and populates the internal state using the 'source' BSON object if the
* latter contains valid values. Otherwise sets errMsg and returns false.
*/
bool parseBSON(const BSONObj& source, std::string* errMsg);
/**
* Clears the internal state.
*/
void clear();
/**
* Copies all the fields present in 'this' to 'other'.
*/
void cloneTo(LockpingsType* other) const;
/**
* Returns a string representation of the current internal state.
*/
std::string toString() const;
//
// individual field accessors
//
// Mandatory Fields
void setProcess(const StringData& process) {
_process = process.toString();
_isProcessSet = true;
}
void unsetProcess() { _isProcessSet = false; }
bool isProcessSet() const { return _isProcessSet; }
// Calling get*() methods when the member is not set results in undefined behavior
const std::string& getProcess() const {
dassert(_isProcessSet);
return _process;
}
void setPing(const Date_t ping) {
_ping = ping;
_isPingSet = true;
}
void unsetPing() { _isPingSet = false; }
bool isPingSet() const { return _isPingSet; }
// Calling get*() methods when the member is not set results in undefined behavior
const Date_t getPing() const {
dassert(_isPingSet);
return _ping;
}
// Optional Fields
private:
// Convention: (M)andatory, (O)ptional, (S)pecial rule.
std::string _process; // (M) string describing the process holding the lock
bool _isProcessSet;
Date_t _ping; // (M) last time the holding process updated this document
bool _isPingSet;
};
} // namespace mongo
|
