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