resource/csdk/stack/include/internal/ocobserve.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 #ifndef OC_OBSERVE_H
  22 #define OC_OBSERVE_H
  23
  24 /* Sequence number is a 24 bit field */
  25 #define MAX_SEQUENCE_NUMBER              (0xFFFFFF)
  26
  27 #define MAX_OBSERVER_FAILED_COMM         (2)
  28 #define MAX_OBSERVER_NON_COUNT           (3)
  29
  30 /* This information is stored for each registerd observer */
  31 typedef struct ResourceObserver
  32 {
  33     // Observation Identifier for request
  34     OCObservationId observeId;
  35     // URI of observed resource
  36     char *resUri;
  37     // Query
  38     char *query;
  39     //token for the observe request
  40     CAToken_t token;
  41     // Resource handle
  42     OCResource *resource;
  43     //TODO bundle it in Endpoint structure(address, uri, type, secured)
  44     /** Remote Endpoint address **/
  45     CAAddress_t addressInfo;
  46     /** Connectivity of the endpoint**/
  47     CAConnectivityType_t connectivityType;
  48     // Quality of service of the request
  49     OCQualityOfService qos;
  50     // number of times the server failed to reach the observer
  51     uint8_t failedCommCount;
  52     // number of times the server sent NON notifications
  53     uint8_t lowQosCount;
  54     // force the qos value to CON
  55     uint8_t forceHighQos;
  56     // next node in this list
  57     struct ResourceObserver *next;
  58 } ResourceObserver;
  59
  60 #ifdef WITH_PRESENCE
  61 OCStackResult SendAllObserverNotification (OCMethod method, OCResource *resPtr, uint32_t maxAge,
  62         OCResourceType *resourceType, OCQualityOfService qos);
  63 #else
  64 OCStackResult SendAllObserverNotification (OCMethod method, OCResource *resPtr, uint32_t maxAge,
  65         OCQualityOfService qos);
  66 #endif
  67 OCStackResult SendListObserverNotification (OCResource * resource,
  68         OCObservationId  *obsIdList, uint8_t numberOfIds,
  69         const char *notificationJSONPayload, uint32_t maxAge,
  70         OCQualityOfService qos);
  71
  72 void DeleteObserverList();
  73
  74 OCStackResult GenerateObserverId (OCObservationId *observationId);
  75
  76 OCStackResult AddObserver (const char         *resUri,
  77                            const char         *query,
  78                            OCObservationId    obsId,
  79                            CAToken_t          *token,
  80                            OCResource         *resHandle,
  81                            OCQualityOfService qos,
  82                            const CAAddress_t  *addressInfo,
  83                            CAConnectivityType_t connectivityType);
  84
  85 OCStackResult DeleteObserverUsingToken (CAToken_t * token);
  86
  87 ResourceObserver* GetObserverUsingToken (const CAToken_t * token);
  88
  89 ResourceObserver* GetObserverUsingId (const OCObservationId observeId);
  90
  91 OCStackResult
  92 CreateObserveHeaderOption (CAHeaderOption_t **caHdrOpt,
  93                            OCHeaderOption *ocHdrOpt,
  94                            uint8_t numOptions,
  95                            uint8_t observeFlag);
  96 OCStackResult
  97 GetObserveHeaderOption (uint32_t * observationOption,
  98                         CAHeaderOption_t *options,
  99                         uint8_t * numOptions);
 100
 101 #endif //OC_OBSERVE_H
 102