src/darwin/Framework/CHIP/CHIPPersistentStorageDelegate.h

   1 /**
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 #import <Foundation/Foundation.h>
  19
  20 NS_ASSUME_NONNULL_BEGIN
  21
  22 typedef void (^SendKeyValue)(NSString * key, NSString * value);
  23 typedef void (^CHIPSendSetStatus)(NSString * key, NSError * status);
  24 typedef void (^CHIPSendDeleteStatus)(NSString * key, NSError * status);
  25
  26 /**
  27  * The protocol definition for the CHIPPersistenStorageDelegate
  28  *
  29  * All delegate methods will be called on the supplied Delegate Queue.
  30  */
  31 @protocol CHIPPersistentStorageDelegate <NSObject>
  32 @required
  33
  34 /**
  35  * Get the value for the given key
  36  *
  37  */
  38 - (void)CHIPGetKeyValue:(NSString *)key handler:(SendKeyValue)completionHandler;
  39
  40 /**
  41  * Get the value for the given key
  42  *
  43  */
  44 - (NSString *)CHIPGetKeyValue:(NSString *)key;
  45
  46 /**
  47  * Set the value of the key to the given value
  48  *
  49  */
  50 - (void)CHIPSetKeyValue:(NSString *)key value:(NSString *)value handler:(CHIPSendSetStatus)completionHandler;
  51
  52 /**
  53  * Delete the key and corresponding value
  54  *
  55  */
  56 - (void)CHIPDeleteKeyValue:(NSString *)key handler:(CHIPSendDeleteStatus)completionHandler;
  57
  58 @end
  59
  60 NS_ASSUME_NONNULL_END