service/resource-encapsulation/src/resourceCache/include/CacheTypes.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 RCM_CACHETYPES_H
  22 #define RCM_CACHETYPES_H
  23
  24 #include <functional>
  25 #include <map>
  26 #include <memory>
  27 #include <string>
  28
  29 #include "logger.h"
  30
  31 #include "PrimitiveResource.h"
  32 #include "RCSResourceAttributes.h"
  33
  34 namespace OIC
  35 {
  36     namespace Service
  37     {
  38
  39         class DataCache;
  40
  41 #define CACHE_TAG  "CACHE"
  42 #define CACHE_DEFAULT_REPORT_MILLITIME 10000
  43 #define CACHE_DEFAULT_EXPIRED_MILLITIME 15000
  44
  45         enum class REPORT_FREQUENCY
  46         {
  47             NONE = 0,
  48             UPTODATE,
  49             PERIODICTY,
  50             WHENEVER_NOTIFIED
  51         };
  52
  53         struct Report_Info
  54         {
  55             REPORT_FREQUENCY rf;
  56             int reportID;
  57             long repeatTime;
  58             unsigned int timerID;
  59         };
  60
  61         enum class CACHE_STATE
  62         {
  63             READY = 0,
  64             READY_YET,
  65             LOST_SIGNAL,
  66             DESTROYED,
  67             UPDATING,
  68             NONE
  69         };
  70
  71         enum class CACHE_MODE
  72         {
  73             OBSERVE = 0,
  74             FREQUENCY
  75         };
  76
  77         enum class CACHE_METHOD
  78         {
  79             OBSERVE_ONLY,
  80             ITERATED_GET
  81         };
  82
  83         typedef int CacheID;
  84
  85         typedef std::function<OCStackResult(std::shared_ptr<PrimitiveResource>,
  86                         const RCSResourceAttributes &, int eCode)> CacheCB;
  87         typedef std::map<int, std::pair<Report_Info, CacheCB>> SubscriberInfo;
  88         typedef std::pair<int, std::pair<Report_Info, CacheCB>> SubscriberInfoPair;
  89
  90         typedef OC::OCResource BaseResource;
  91         typedef PrimitiveResource::GetCallback GetCB;
  92         typedef PrimitiveResource::ObserveCallback ObserveCB;
  93
  94         typedef std::shared_ptr<DataCache> DataCachePtr;
  95         typedef std::shared_ptr<PrimitiveResource> PrimitiveResourcePtr;
  96     } // namespace Service
  97 } // namespace OIC
  98
  99 #endif /* RCM_CACHETYPES_H */