src/platform/Zephyr/KeyValueStoreManagerImpl.h

   1 /*
   2  *
   3  *    Copyright (c) 2021 Project CHIP Authors
   4  *    All rights reserved.
   5  *
   6  *    Licensed under the Apache License, Version 2.0 (the "License");
   7  *    you may not use this file except in compliance with the License.
   8  *    You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *    Unless required by applicable law or agreed to in writing, software
  13  *    distributed under the License is distributed on an "AS IS" BASIS,
  14  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *    See the License for the specific language governing permissions and
  16  *    limitations under the License.
  17  */
  18
  19 /**
  20  *    @file
  21  *          Platform-specific key value storage implementation for Zephyr.
  22  *
  23  */
  24
  25 #pragma once
  26
  27 #include <zephyr.h>
  28
  29 namespace chip {
  30 namespace DeviceLayer {
  31 namespace PersistedStorage {
  32
  33 class KeyValueStoreManagerImpl final : public KeyValueStoreManager
  34 {
  35     // Allow the KeyValueStoreManager interface class to delegate method calls to
  36     // the implementation methods provided by this class.
  37     friend class KeyValueStoreManager;
  38
  39 public:
  40     void Init();
  41
  42     // NOTE: Currently this platform does not support partial and offset reads
  43     //       these will return CHIP_ERROR_NOT_IMPLEMENTED.
  44     CHIP_ERROR _Get(const char * key, void * value, size_t value_size, size_t * read_bytes_size = nullptr, size_t offset = 0) const;
  45
  46     CHIP_ERROR _Delete(const char * key);
  47
  48     CHIP_ERROR _Put(const char * key, const void * value, size_t value_size);
  49
  50 private:
  51     // ===== Members for internal use by the following friends.
  52
  53     friend KeyValueStoreManager & KeyValueStoreMgr();
  54     friend KeyValueStoreManagerImpl & KeyValueStoreMgrImpl();
  55
  56     static KeyValueStoreManagerImpl sInstance;
  57 };
  58
  59 /**
  60  * Returns the public interface of the KeyValueStoreManager singleton object.
  61  *
  62  * Chip applications should use this to access features of the KeyValueStoreManager object
  63  * that are common to all platforms.
  64  */
  65 inline KeyValueStoreManager & KeyValueStoreMgr()
  66 {
  67     return KeyValueStoreManagerImpl::sInstance;
  68 }
  69
  70 /**
  71  * Returns the platform-specific implementation of the KeyValueStoreManager singleton object.
  72  *
  73  * Chip applications can use this to gain access to features of the KeyValueStoreManager
  74  * that are specific to the Zephyr platform.
  75  */
  76 inline KeyValueStoreManagerImpl & KeyValueStoreMgrImpl()
  77 {
  78     return KeyValueStoreManagerImpl::sInstance;
  79 }
  80
  81 } // namespace PersistedStorage
  82 } // namespace DeviceLayer
  83 } // namespace chip