include/OCPlatformHandler.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Corporation All Rights Reserved.
   4 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   5
   6 /// @file OCPlatformHandler.h
   7
   8 /// @brief      This file contains the declaration of classes and its members related to
   9 ///                     OCPlatformHandler.
  10
  11 #ifndef __OCPLATFORMHANDLER_H
  12 #define __OCPLATFORMHANDLER_H
  13
  14 #include "OCApi.h"
  15
  16 namespace OC
  17 {
  18         class OCPlatform;
  19
  20         /**
  21         * @brief        OCPlatformHandler is a pure abstract class and it can be used for
  22         *                       registering and getting callbacks
  23         */
  24         class OCPlatformHandler
  25         {
  26         public:
  27                 OCPlatformHandler(void);
  28
  29                 virtual ~OCPlatformHandler(void);
  30
  31                 /**
  32                 * @fn   This function is called when the platform gets initialzed
  33                 *
  34                 * @param platform pointer to OCPlatform object
  35                 */
  36                 virtual void onPlatformInitialized(OCPlatform *platform) = 0;
  37
  38                 /**
  39                 * @fn   This function is called when platform status is changed
  40                 *
  41                 * @param platform - pointer to OCPlatform object
  42                 * @param status - OCPlatform status
  43                 */
  44                 virtual void onPlatformStatusChanged(OCPlatform *platform, OCPlatformStatus status) = 0;
  45         };
  46 }
  47
  48 #endif // __OCPLATFORMHANDLER_H