include/OCObserverHandler.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH 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 OCObserverHandler.h
  22
  23 /// @brief      This file contains the declaration of classes and its members related to
  24 ///                     ObserverHandler.
  25
  26 #ifndef __OCOBSERVERHANDLER_H
  27 #define __OCOBSERVERHANDLER_H
  28
  29 #include "OCApi.h"
  30
  31 namespace OC
  32 {
  33         /**
  34         * @brief        OCObserverHandler is a pure abstract class and it can be used for
  35         *                       observer related callbacks
  36         */
  37
  38         class OCObserverHandler
  39         {
  40         public:
  41                 virtual ~OCObserverHandler(void)
  42                 {}
  43
  44                 /**
  45                 * @fn   This function is called when the property gets updated
  46                 *
  47                 * @param propertyName name of the property
  48                 * @param value value of the property
  49                 */
  50                 virtual void onObserverUpdate(std::string propertyName, void *value) = 0;
  51         };
  52
  53 }
  54 #endif //__OCOBSERVERHANDLER_H