blob: 044c3d55d6f3772e5f445326260fb9b07771fdc3 [file] [log] [blame]
/*
*
* Copyright (c) 2022 Project CHIP Authors
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* Provides an implementation of the ConfigurationManager class
* for the Open IOT SDK platform.
*/
#pragma once
#include <platform/internal/GenericConfigurationManagerImpl.h>
#include CHIP_OPEN_IOT_SDK_KV_STORE_CONFIG_INCLUDE
namespace chip {
namespace DeviceLayer {
/**
* Concrete implementation of the ConfigurationManager singleton object for the Zephyr platform.
*/
class ConfigurationManagerImpl : public Internal::GenericConfigurationManagerImpl<KVStoreConfig>
{
public:
// This returns an instance of this class.
static ConfigurationManagerImpl & GetDefaultInstance();
private:
// ===== Members that implement the ConfigurationManager public interface.
CHIP_ERROR Init(void) override;
bool CanFactoryReset(void) override;
void InitiateFactoryReset(void) override;
CHIP_ERROR ReadPersistedStorageValue(::chip::Platform::PersistedStorage::Key key, uint32_t & value) override;
CHIP_ERROR WritePersistedStorageValue(::chip::Platform::PersistedStorage::Key key, uint32_t value) override;
// NOTE: Other public interface methods are implemented by GenericConfigurationManagerImpl<>.
// ===== Members that implement the GenericConfigurationManagerImpl protected interface.
CHIP_ERROR ReadConfigValue(Key key, bool & val) override;
CHIP_ERROR ReadConfigValue(Key key, uint32_t & val) override;
CHIP_ERROR ReadConfigValue(Key key, uint64_t & val) override;
CHIP_ERROR ReadConfigValueStr(Key key, char * buf, size_t bufSize, size_t & outLen) override;
CHIP_ERROR ReadConfigValueBin(Key key, uint8_t * buf, size_t bufSize, size_t & outLen) override;
CHIP_ERROR WriteConfigValue(Key key, bool val) override;
CHIP_ERROR WriteConfigValue(Key key, uint32_t val) override;
CHIP_ERROR WriteConfigValue(Key key, uint64_t val) override;
CHIP_ERROR WriteConfigValueStr(Key key, const char * str) override;
CHIP_ERROR WriteConfigValueStr(Key key, const char * str, size_t strLen) override;
CHIP_ERROR WriteConfigValueBin(Key key, const uint8_t * data, size_t dataLen) override;
void RunConfigUnitTest(void) override;
// ===== Private members reserved for use by this class only.
static void DoFactoryReset(intptr_t arg);
};
/**
* Returns the platform-specific implementation of the ConfigurationManager object.
*
* Applications can use this to gain access to features of the ConfigurationManager
* that are specific to the selected platform.
*/
ConfigurationManager & ConfigurationMgrImpl();
} // namespace DeviceLayer
} // namespace chip