Add an API for handling user-specific properties in Enrollee side
[platform/upstream/iotivity.git] / service / easy-setup / enrollee / src / resourcehandler.h
1 //******************************************************************
2 //
3 // Copyright 2015 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 // Do not remove the include below
22
23 #include <string.h>
24 #include "logger.h"
25 #include "ocstack.h"
26 #include "escommon.h"
27 #include "octypes.h"
28
29 #ifndef ES_RESOURCE_HANDLER_H_
30 #define ES_RESOURCE_HANDLER_H_
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 typedef void (*ESWiFiCB) (ESResult, ESWiFiProvData *);
37 typedef void (*ESCloudCB) (ESResult, ESCloudProvData *);
38 typedef void (*ESDevConfCB) (ESResult, ESDevConfProvData *);
39
40 typedef void (*ESWriteUserdataCb)(OCRepPayload* payload, char* resourceType);
41 typedef void (*ESReadUserdataCb)(OCRepPayload* payload, char* resourceType, void* userdata);
42
43 /* Structure to represent a Light resource */
44 typedef struct PROVRESOURCE
45 {
46     OCResourceHandle handle;
47     ProvStatus status; // provisiong status
48     ESErrorCode lastErrCode;
49     char ocfWebLinks[MAX_WEBLINKLEN];
50 } ProvResource;
51
52 typedef struct
53 {
54     OCResourceHandle handle;
55     WIFI_MODE supportedMode[NUM_WIFIMODE];
56     uint8_t numMode;        // the number of device's supported wifi modes
57     WIFI_FREQ supportedFreq;
58     char ssid[MAX_SSIDLEN]; // SSID
59     char cred[MAX_CREDLEN]; // credential information.
60     WIFI_AUTHTYPE authType;
61     WIFI_ENCTYPE encType;
62 } WiFiResource;
63
64 typedef struct
65 {
66     OCResourceHandle handle;
67     char authCode[OIC_STRING_MAX_VALUE];
68     char authProvider[OIC_STRING_MAX_VALUE];
69     char ciServer[OIC_STRING_MAX_VALUE];
70 } CloudResource;
71
72 typedef struct
73 {
74     OCResourceHandle handle;
75     char devName[MAX_DEVICELEN];
76     char language[OIC_STRING_MAX_VALUE];
77     char country[OIC_STRING_MAX_VALUE];
78 } DevConfResource;
79
80 OCStackResult CreateEasySetupResources(bool isSecured, ESResourceMask resourceMask);
81 OCStackResult DeleteEasySetupResources();
82
83 OCStackResult SetDeviceProperty(ESDeviceProperty *deviceProperty);
84 OCStackResult SetEnrolleeState(ESEnrolleeState esState);
85 OCStackResult SetEnrolleeErrCode(ESErrorCode esErrCode);
86
87 void GetTargetNetworkInfoFromProvResource(char *, char *);
88 void RegisterWifiRsrcEventCallBack(ESWiFiCB);
89 void RegisterCloudRsrcEventCallBack(ESCloudCB);
90 void RegisterDevConfRsrcEventCallBack(ESDevConfCB);
91 void UnRegisterResourceEventCallBack(void);
92 ESResult SetCallbackForUserData(ESReadUserdataCb readCb, ESWriteUserdataCb writeCb);
93
94 #ifdef __cplusplus
95 }
96 #endif
97
98 #endif //ES_RESOURCE_HANDLER_H_