EMANE  1.2.1
configurationservice.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * * Neither the name of Adjacent Link LLC nor the names of its
16  * contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef EMANECONFIGURATIONSERVICE_HEADER_
34 #define EMANECONFIGURATIONSERVICE_HEADER_
35 
41 #include "emane/any.h"
42 #include "emane/types.h"
43 #include "emane/utils/singleton.h"
44 
45 #include <string>
46 #include <map>
47 
48 #include <mutex>
49 
50 namespace EMANE
51 {
52  class ConfigurationService : public Utils::Singleton<ConfigurationService>
53  {
54  public:
56  RunningStateMutable * pRunningStateMutable);
57 
76  void registerNumericAny(BuildId buildId,
77  const std::string & sName,
78  Any::Type type,
79  const ConfigurationProperties & properties,
80  const std::vector<Any> & values,
81  const std::string & sUsage,
82  const Any & minValue,
83  const Any & maxValue,
84  std::size_t minOccurs,
85  std::size_t maxOccurs,
86  const std::string & sRegexPattern);
87 
104  void registerNonNumericAny(BuildId buildId,
105  const std::string & sName,
106  Any::Type type,
107  const ConfigurationProperties & properties,
108  const std::vector<Any> & values,
109  const std::string & sUsage,
110  std::size_t minOccurs,
111  std::size_t maxOccurs,
112  const std::string & sRegexPattern);
113 
125 
126 
139  std::vector<std::pair<std::string,std::vector<Any>>>
140  queryConfiguration(BuildId buildId,
141  const std::vector<std::string> & names = {}) const;
142 
159  buildUpdates(BuildId buildId,
160  const ConfigurationUpdateRequest & parameters);
161 
162 
163  void update(BuildId buildId, const ConfigurationUpdate & update);
164 
165  void registerValidator(BuildId buildId, ConfigurationValidator validator);
166 
167  protected:
169 
170  private:
171  using ConfigurationStore = std::map<std::string,ConfigurationInfo>;
172  using BuildIdConfigurationStore = std::map<BuildId,ConfigurationStore>;
173  using RunningStateMUtables = std::map<BuildId,RunningStateMutable *>;
174  using ValidatorStore = std::map<BuildId,std::vector<ConfigurationValidator>>;
175 
176  BuildIdConfigurationStore buildIdConfigurationStore_;
177  RunningStateMUtables runningStateMutables_;
178  ValidatorStore validatorStore_;
179 
180  mutable std::mutex mutex_;
181 
182  void registerAny(BuildId buildId,
183  const std::string & sName,
184  ConfigurationInfo && configurationInfo);
185  };
186 
188 }
189 
190 #endif //EMANECONFIGURATIONSERVICE_HEADER_
void registerNonNumericAny(BuildId buildId, const std::string &sName, Any::Type type, const ConfigurationProperties &properties, const std::vector< Any > &values, const std::string &sUsage, std::size_t minOccurs, std::size_t maxOccurs, const std::string &sRegexPattern)
void registerNumericAny(BuildId buildId, const std::string &sName, Any::Type type, const ConfigurationProperties &properties, const std::vector< Any > &values, const std::string &sUsage, const Any &minValue, const Any &maxValue, std::size_t minOccurs, std::size_t maxOccurs, const std::string &sRegexPattern)
Ensure a class only has one instance, and provide a global point of access to it. ...
Definition: singleton.h:47
Type
Definition: any.h:52
std::vector< std::pair< std::string, std::vector< Any > > > queryConfiguration(BuildId buildId, const std::vector< std::string > &names={}) const
The RunningStateMutable interface is used to allow dynamic running-state configuration changes...
std::vector< ConfigurationInfo > ConfigurationManifest
void registerRunningStateMutable(BuildId buildId, RunningStateMutable *pRunningStateMutable)
void update(BuildId buildId, const ConfigurationUpdate &update)
void registerValidator(BuildId buildId, ConfigurationValidator validator)
ConfigurationUpdate buildUpdates(BuildId buildId, const ConfigurationUpdateRequest &parameters)
ConfigurationManifest getConfigurationManifest(BuildId buildId) const
std::vector< ConfigurationNameStringValues > ConfigurationUpdateRequest
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
std::function< std::pair< std::string, bool >(const ConfigurationUpdate &update) noexcept > ConfigurationValidator
Holds configuration item meta information.
The Any class can contain an instance of one of any type in its support type set. ...
Definition: any.h:49
std::uint32_t BuildId
Definition: types.h:60
Definition: agent.h:43