service/resource-hosting/include/Hosting.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 #ifndef _HOSTING_H_
  22 #define _HOSTING_H_
  23
  24 // Standard API
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <stdlib.h>
  28
  29 // Iotivity Base CAPI
  30 #include "ocstack.h"
  31 #include "logger.h"
  32
  33 #define OC_TRANSPORT CT_ADAPTER_IP
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif // __cplusplus
  38
  39 #define HOSTING_TAG  PCF("Hosting")
  40
  41 /**
  42  * Start resource hosting.
  43  * This function will start the resource hosting and the discovery for remote resource which want to be hosted.
  44  *
  45  * @return ::OC_STACK_OK upon success, ::OC_STACK_ERROR is returned except the case that OC_STACK_SUCCESS is returned.
  46  */
  47 OCStackResult OICStartCoordinate();
  48
  49 /**
  50  * Stop resource hosting.
  51  * This function will stop the resource hosting and delete all hosting resource.
  52  *
  53  * @return ::OC_STACK_OK upon success, ::OC_STACK_ERROR is returned except the case that OC_STACK_SUCCESS is returned.
  54  */
  55 OCStackResult OICStopCoordinate();
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif // __cplusplus
  60
  61 #endif //_HOSTING_H_