Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef SHILL_KEY_VALUE_STORE_ |
| 6 | #define SHILL_KEY_VALUE_STORE_ |
| 7 | |
| 8 | #include <map> |
| 9 | #include <string> |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 10 | #include <vector> |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 11 | |
| 12 | #include <base/basictypes.h> |
| 13 | |
| 14 | namespace shill { |
| 15 | |
| 16 | class KeyValueStore { |
| 17 | // A simple store for key-value pairs, which supports (a limited set of) |
| 18 | // heterogenous value types. |
| 19 | // |
| 20 | // Compare to PropertyStore, which enables a class to (selectively) |
| 21 | // expose its instance members as properties accessible via |
| 22 | // RPC. (RPC support for ProperyStore is implemented in a |
| 23 | // protocol-specific adaptor. e.g. dbus_adpator.) |
| 24 | // |
| 25 | // Implemented separately from PropertyStore, to avoid complicating |
| 26 | // the PropertyStore interface. In particular, objects implementing the |
| 27 | // PropertyStore interface always provide the storage themselves. In |
| 28 | // contrast, users of KeyValueStore expect KeyValueStore to provide |
| 29 | // storage. |
| 30 | public: |
| 31 | KeyValueStore(); |
| 32 | |
Paul Stewart | def189e | 2012-08-02 20:12:09 -0700 | [diff] [blame] | 33 | void Clear(); |
Paul Stewart | d2e1c36 | 2013-03-03 19:06:07 -0800 | [diff] [blame] | 34 | void CopyFrom(const KeyValueStore &b); |
Paul Stewart | def189e | 2012-08-02 20:12:09 -0700 | [diff] [blame] | 35 | |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 36 | bool ContainsBool(const std::string &name) const; |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 37 | bool ContainsInt(const std::string &name) const; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 38 | bool ContainsString(const std::string &name) const; |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 39 | bool ContainsStrings(const std::string &name) const; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 40 | bool ContainsUint(const std::string &name) const; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 41 | |
| 42 | bool GetBool(const std::string &name) const; |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 43 | int32 GetInt(const std::string &name) const; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 44 | const std::string &GetString(const std::string &name) const; |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 45 | const std::vector<std::string> &GetStrings(const std::string &name) const; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 46 | uint32 GetUint(const std::string &name) const; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 47 | |
| 48 | void SetBool(const std::string &name, bool value); |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 49 | void SetInt(const std::string &name, int32 value); |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 50 | void SetString(const std::string &name, const std::string &value); |
| 51 | void SetStrings(const std::string &name, |
| 52 | const std::vector<std::string> &value); |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 53 | void SetUint(const std::string &name, uint32 value); |
| 54 | |
Paul Stewart | 88125fb | 2012-03-26 07:13:51 -0700 | [diff] [blame] | 55 | void RemoveString(const std::string &name); |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 56 | void RemoveStrings(const std::string &name); |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 57 | void RemoveInt(const std::string &name); |
Paul Stewart | 88125fb | 2012-03-26 07:13:51 -0700 | [diff] [blame] | 58 | |
Darin Petkov | 7f06033 | 2012-03-14 11:46:47 +0100 | [diff] [blame] | 59 | // If |name| is in this store returns its value, otherwise returns |
| 60 | // |default_value|. |
Darin Petkov | b536a74 | 2012-04-26 11:31:28 +0200 | [diff] [blame] | 61 | bool LookupBool(const std::string &name, bool default_value) const; |
Darin Petkov | 7f06033 | 2012-03-14 11:46:47 +0100 | [diff] [blame] | 62 | std::string LookupString(const std::string &name, |
| 63 | const std::string &default_value) const; |
| 64 | |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 65 | const std::map<std::string, bool> &bool_properties() const { |
| 66 | return bool_properties_; |
| 67 | } |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 68 | const std::map<std::string, int32> &int_properties() const { |
| 69 | return int_properties_; |
| 70 | } |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 71 | const std::map<std::string, std::string> &string_properties() const { |
| 72 | return string_properties_; |
| 73 | } |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 74 | const std::map<std::string, |
| 75 | std::vector<std::string>> &strings_properties() const { |
| 76 | return strings_properties_; |
| 77 | } |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 78 | const std::map<std::string, uint32> &uint_properties() const { |
| 79 | return uint_properties_; |
| 80 | } |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 81 | |
| 82 | private: |
| 83 | std::map<std::string, bool> bool_properties_; |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 84 | std::map<std::string, int32> int_properties_; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 85 | std::map<std::string, std::string> string_properties_; |
Paul Stewart | 3c5e2b3 | 2013-06-13 07:49:49 -0700 | [diff] [blame] | 86 | std::map<std::string, std::vector<std::string>> strings_properties_; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 87 | std::map<std::string, uint32> uint_properties_; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 88 | }; |
| 89 | |
| 90 | } // namespace shill |
| 91 | |
| 92 | #endif // SHILL_KEY_VALUE_STORE_ |