3ae3c51039bd311e3cc73f643d157b371451d289
[platform/upstream/iotivity.git] / service / easy-setup / enrollee / src / softap.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
22 #ifndef EASYSETUP_ENROLLEE_SOFTAP_H__
23 #define EASYSETUP_ENROLLEE_SOFTAP_H__
24
25 #include "escommon.h"
26 #include "networkhandler.h"
27
28 /**
29  * @file
30  *
31  * This file contains platform agnostic API for creation of Soft AP
32  * @Note : Some of the APIs of this file need to be modified by the OEM according to the device configuration
33  */
34
35 /**
36  * This function verify if the Soft AP is created at Enrollee device.
37  * @return ::True, if Soft AP is created at Enrollee device.
38  * @Note : This API needs to be modified by the OEM according to the device configuration
39  */
40
41 bool ESSoftapAtEnrollee();
42
43 /**
44  * This function verify if the Soft AP is created at Mediator device.
45  * @return ::True, if Soft AP is created at Mediator device.
46  * @Note : This API needs to be modified by the OEM according to the device configuration
47  */
48
49 bool ESSoftapAtMediator();
50
51
52 /**
53  * This function finds which Device (Enrollee or Mediator) is creating Soft AP.
54  * @return ::DeviceRole (ENROLLEE or MEDIATOR)
55  * @Note : This API needs to be modified by the OEM according to the device configuration
56  */
57
58 DeviceRole ESSoftapHost();
59
60 /**
61  * This function Initializes the EasySetup. This API must be called prior to invoking any other API
62  *
63  * @param ssid                 SSID of the target SoftAP network to which the Enrollee is connecting.
64  * @param passwd               Password of the target SoftAP network to which the Enrollee is connecting
65  * @param NetworkEventCallback Callback function for result update
66  * @return ::void.
67  */
68 void ESCreateSoftap(const char * ssid, const char* passwd, NetworkEventCallback cb);
69
70
71 //#ifdef __cplusplus
72 //}
73 //#endif // __cplusplus
74
75
76 #endif /* EASYSETUP_ENROLLEE_SOFTAP_H__ */
77
78
79