service/easy-setup/enrollee/inc/easysetup.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_H__
  23 #define EASYSETUP_ENROLLEE_H__
  24
  25 #include "escommon.h"
  26
  27 /**
  28  * @file
  29  *
  30  * This file contains Enrollee APIs
  31  */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif // __cplusplus
  36
  37 /*
  38  * Callback function for updating the Enrollee OnBoarding and Provisioning status result
  39  * to the application
  40  *
  41  * @param esResult ESResult provides the current state of the Enrollee Device
  42  */
  43 typedef void (*ESEnrolleeEventCallback)(ESResult esResult, ESEnrolleeState enrolleeState);
  44
  45 /**
  46  * This function Initializes the EasySetup. This API must be called prior to invoking any other API
  47  *
  48  * @param networkType       NetworkType on which OnBoarding has to be performed.
  49  * @param ssid              SSID of the target SoftAP network to which the Enrollee is connecting.
  50  * @param passwd            Password of the target SoftAP network to which the Enrollee is
  51  *                          connecting
  52  * @param isSecured         True if the Enrollee is operating in secured mode.
  53  * @param eventCallback     ESEnrolleeEventCallback for for updating the Enrollee OnBoarding status
  54  *                          result to the application
  55  * @return ::ES_OK on success, some other value upon failure.
  56  */
  57 ESResult ESInitEnrollee(OCConnectivityType networkType, const char *ssid, const char *passwd,
  58                                 bool isSecured, ESEnrolleeEventCallback eventCallback);
  59
  60 /**
  61  * This function performs initialization of Provisioning and Network resources needed for EasySetup
  62  * process.
  63  * @return ::ES_OK on success, some other value upon failure.
  64  */
  65 ESResult ESInitProvisioning();
  66
  67 /**
  68  * This function performs termination of Provisioning and Network resources.
  69  * Also terminates the IoTivity core stack.
  70  *
  71  * @return ::ES_OK on success, some other value upon failure.
  72  */
  73 ESResult ESTerminateEnrollee();
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif // __cplusplus
  78
  79
  80 #endif /* EASYSETUP_ENROLLEE_H__ */
  81