[IOT-2537] Filter eps returned from RD queries.
[iotivity.git] / 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 OC_CALL OCRDDatabaseInit();
36
37 /**
38  * Stores in database the published resource.
39  *
40  * @param payload is the the published resource payload.
41  *
42  * @return ::OC_STACK_OK in case of success or else other value.
43  */
44 OCStackResult OC_CALL OCRDDatabaseStoreResources(const OCRepPayload *payload);
45
46 /**
47  * Stores in database the published resource and marks them as originating at this host so that the
48  * eps can be filtered.
49  *
50  * @param payload is the the published resource payload.
51  *
52  * @return ::OC_STACK_OK in case of success or else other value.
53  */
54 OCStackResult OC_CALL OCRDDatabaseStoreResourcesFromThisHost(const OCRepPayload *payload);
55
56 /**
57  * Delete the RD resources
58  *
59  * @param deviceId of the device containing the resource(s) to be deleted.
60  * @param instanceIds the resource(s) to be deleted.  If NULL then all resources
61  *                    belonging to the device will be deleted.
62  * @param nInstanceIds the number of instanceIds
63  *
64  * @return ::OC_STACK_OK in case of success or else other value.
65  */
66 OCStackResult OC_CALL OCRDDatabaseDeleteResources(const char *deviceId, const int64_t *instanceIds,
67                                           uint16_t nInstanceIds);
68
69 /**
70  * Close the RD publish database.
71  *
72  * @return ::OC_STACK_OK in case of success or else other value.
73  */
74 OCStackResult OC_CALL OCRDDatabaseClose();
75
76 #endif
77
78 #ifdef __cplusplus
79 }
80 #endif
81
82 #endif