[Easy-setup] Updated Doxygen comments
[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 "networkhandler.h"
28 #include "octypes.h"
29
30 #ifndef ES_RESOURCE_HANDLER_H_
31 #define ES_RESOURCE_HANDLER_H_
32
33 typedef void (*ResourceEventCallback)(ESResult);
34
35 /* Structure to represent a Light resource */
36 typedef struct PROVRESOURCE
37 {
38     OCResourceHandle handle;
39     int64_t ps; // provisiong status, 1 : need to provisioning, 2 : Connected to Enroller.
40     int64_t tr; // Trigger network connection, 0 : Init value, 1 : Connected to the target network.
41     int64_t tnt; // target network type, 1: WLAN, 2: BT, 3: BLE, 4: Zigbee.
42     char tnn[MAXSSIDLEN]; // target network name, i.e. SSID for WLAN, MAC address for BT.
43     char cd[MAXNETCREDLEN]; // credential information.
44 } ProvResource;
45
46 /* Structure to represent a Light resource */
47 typedef struct NETRESOURCE
48 {
49     OCResourceHandle handle;
50     int64_t cnt; // current network type, 1: WLAN, 2: BT, 3: BLE, 4: Zigbee.
51     int64_t ant[MAXNUMTYPE]; // available network type, 1: WLAN, 2: BT, 3: BLE, 4: Zigbee.
52     char ipaddr[MAXADDRLEN]; // ip address.
53     char cnn[MAXSSIDLEN]; // current network name.
54 } NetResource;
55
56 OCStackResult CreateProvisioningResource(bool isSecured);
57 OCStackResult DeleteProvisioningResource();
58
59 void GetTargetNetworkInfoFromProvResource(char *, char *);
60 void RegisterResourceEventCallBack(ResourceEventCallback);
61 void UnRegisterResourceEventCallBack(void);
62
63 #endif