resource/csdk/resource-directory/include/rd_database.h

   1 //******************************************************************
   2 //
   3 // Copyright 2016 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   7 // Licensed under the Apache License, Version 2.0 (the "License");
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an "AS IS" BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef OC_RESOURCE_DIRECTORY_DATABASE_H_
  22 #define OC_RESOURCE_DIRECTORY_DATABASE_H_
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif // __cplusplus
  27
  28 #ifdef RD_SERVER
  29
  30 /**
  31  * Opens the RD publish database.
  32  *
  33  * @return ::OC_STACK_OK in case of success or else other value.
  34  */
  35 OCStackResult OCRDDatabaseInit();
  36
  37 /**
  38  * Stores in database the published resource.
  39  *
  40  * @param payload is the the published resource payload.
  41  * @param address provide information about endpoint connectivity details.
  42  *
  43  * @return ::OC_STACK_OK in case of success or else other value.
  44  */
  45 OCStackResult OCRDDatabaseStoreResources(const OCRepPayload *payload, const OCDevAddr *address);
  46
  47 /**
  48  * Delete the RD resources
  49  *
  50  * @param deviceId of the device containing the resource(s) to be deleted.
  51  * @param instanceIds the resource(s) to be deleted.  If NULL then all resources
  52  *                    belonging to the device will be deleted.
  53  * @param nInstanceIds the number of instanceIds
  54  *
  55  * @return ::OC_STACK_OK in case of success or else other value.
  56  */
  57 OCStackResult OCRDDatabaseDeleteResources(const char *deviceId, const uint8_t *instanceIds,
  58                                           uint8_t nInstanceIds);
  59
  60 /**
  61  * Close the RD publish database.
  62  *
  63  * @return ::OC_STACK_OK in case of success or else other value.
  64  */
  65 OCStackResult OCRDDatabaseClose();
  66
  67 #endif
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif