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