include/OCResourceHandler.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Corporation 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 /// @file OCResourceHandler.h
  22
  23 /// @brief      This file contains the declaration of classes and its members related to
  24 ///                     ResourceHandler.
  25
  26 #ifndef _OCRESOURCEHANDLER_H
  27 #define _OCRESOURCEHANDLER_H
  28
  29 #include "ocapi.h"
  30 #include "OCResource.h"
  31
  32 namespace OC
  33 {
  34         /**
  35         * @brief        OCResourceHandler is a pure abstract class and it can be used for
  36         *                       resource related callbacks
  37         */
  38         class OCResourceHandler
  39         {
  40         public:
  41                 virtual ~OCResourceHandler(void){}
  42                 /**
  43                 * @fn   This function is called when it finds the resource
  44                 *
  45                 * @param update resource result information
  46                 * @param params reserved
  47                 */
  48                 virtual void onFoundResource(OCResourceResult *update, void *params) = 0;
  49                 /**
  50                 * @fn   This function is called when the find is completed
  51                 *
  52                 * @param propertyName name of the property
  53                 * @param value value of the property
  54                 */
  55                 virtual void onCompleted() = 0;
  56                 /**
  57                 * @fn   This function is called when the find is failed
  58                 *
  59                 */
  60                 virtual void onFailed() = 0;
  61
  62         };
  63 }
  64 #endif //_OCRESOURCEHANDLER_H
  65