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
160
161
162
|
// server_parameters.h
/**
* 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 in the license file.
*/
#pragma once
#include <string>
#include <map>
#include "mongo/base/status.h"
#include "mongo/db/jsobj.h"
namespace mongo {
class ServerParameterSet;
class OperationContext;
/**
* Lets you make server level settings easily configurable.
* Hooks into (set|get)Paramter, as well as command line processing
*/
class ServerParameter {
public:
typedef std::map< std::string, ServerParameter* > Map;
ServerParameter( ServerParameterSet* sps, const std::string& name,
bool allowedToChangeAtStartup, bool allowedToChangeAtRuntime );
ServerParameter( ServerParameterSet* sps, const std::string& name );
virtual ~ServerParameter();
std::string name() const { return _name; }
/**
* @return if you can set on command line or config file
*/
bool allowedToChangeAtStartup() const { return _allowedToChangeAtStartup; }
/**
* @param if you can use (get|set)Parameter
*/
bool allowedToChangeAtRuntime() const { return _allowedToChangeAtRuntime; }
virtual void append(OperationContext* txn, BSONObjBuilder& b, const std::string& name ) = 0;
virtual Status set( const BSONElement& newValueElement ) = 0;
virtual Status setFromString( const std::string& str ) = 0;
private:
std::string _name;
bool _allowedToChangeAtStartup;
bool _allowedToChangeAtRuntime;
};
class ServerParameterSet {
public:
typedef std::map< std::string, ServerParameter* > Map;
void add( ServerParameter* sp );
const Map& getMap() const { return _map; }
static ServerParameterSet* getGlobal();
private:
Map _map;
};
/**
* Implementation of ServerParameter for reading and writing a server parameter with a given
* name and type into a specific C++ variable.
*/
template<typename T>
class ExportedServerParameter : public ServerParameter {
public:
/**
* Construct an ExportedServerParameter in parameter set "sps", named "name", whose storage
* is at "value".
*
* If allowedToChangeAtStartup is true, the parameter may be set at the command line,
* e.g. via the --setParameter switch. If allowedToChangeAtRuntime is true, the parameter
* may be set at runtime, e.g. via the setParameter command.
*/
ExportedServerParameter( ServerParameterSet* sps, const std::string& name, T* value,
bool allowedToChangeAtStartup, bool allowedToChangeAtRuntime)
: ServerParameter( sps, name, allowedToChangeAtStartup, allowedToChangeAtRuntime ),
_value( value ) {}
virtual ~ExportedServerParameter() {}
virtual void append(OperationContext* txn, BSONObjBuilder& b, const std::string& name) {
b.append( name, *_value );
}
virtual Status set( const BSONElement& newValueElement );
virtual Status set( const T& newValue );
virtual const T& get() const { return *_value; }
virtual Status setFromString( const std::string& str );
protected:
virtual Status validate( const T& potentialNewValue ){ return Status::OK(); }
T* _value; // owned elsewhere
};
}
#define MONGO_EXPORT_SERVER_PARAMETER_IMPL( NAME, TYPE, INITIAL_VALUE, \
CHANGE_AT_STARTUP, CHANGE_AT_RUNTIME ) \
TYPE NAME = INITIAL_VALUE; \
ExportedServerParameter<TYPE> _##NAME(\
ServerParameterSet::getGlobal(), #NAME, &NAME, CHANGE_AT_STARTUP, CHANGE_AT_RUNTIME )
/**
* Create a global variable of type "TYPE" named "NAME" with the given INITIAL_VALUE. The
* value may be set at startup or at runtime.
*/
#define MONGO_EXPORT_SERVER_PARAMETER( NAME, TYPE, INITIAL_VALUE ) \
MONGO_EXPORT_SERVER_PARAMETER_IMPL( NAME, TYPE, INITIAL_VALUE, true, true )
/**
* Like MONGO_EXPORT_SERVER_PARAMETER, but the value may only be set at startup.
*/
#define MONGO_EXPORT_STARTUP_SERVER_PARAMETER( NAME, TYPE, INITIAL_VALUE ) \
MONGO_EXPORT_SERVER_PARAMETER_IMPL( NAME, TYPE, INITIAL_VALUE, true, false )
/**
* Like MONGO_EXPORT_SERVER_PARAMETER, but the value may only be set at runtime.
*/
#define MONGO_EXPORT_RUNTIME_SERVER_PARAMETER( NAME, TYPE, INITIAL_VALUE ) \
MONGO_EXPORT_SERVER_PARAMETER_IMPL( NAME, TYPE, INITIAL_VALUE, false, true )
#include "server_parameters_inline.h"
|
