1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
24 /* In CoAP sequence number is a 24 bit field */
25 #define MAX_SEQUENCE_NUMBER (0xFFFFFF)
27 #define MAX_OBSERVER_FAILED_COMM (2)
28 #define MAX_OBSERVER_NON_COUNT (3)
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;
39 //token for the observe request
42 // CoAP token for the observe request
47 // IP address & port of client registered for observe
50 /** Remote Endpoint address **/
51 CAAddress_t addressInfo;
52 /** Connectivity of the endpoint**/
53 CAConnectivityType_t connectivityType;
55 // Quality of service of the request
56 OCQualityOfService qos;
57 // number of times the server failed to reach the observer
58 uint8_t failedCommCount;
59 // number of times the server sent NON notifications
61 // force the qos value to CON
63 // next node in this list
64 struct ResourceObserver *next;
68 OCStackResult SendAllObserverNotification (OCMethod method, OCResource *resPtr, uint32_t maxAge,
69 OCResourceType *resourceType, OCQualityOfService qos);
71 OCStackResult SendAllObserverNotification (OCMethod method, OCResource *resPtr, uint32_t maxAge,
72 OCQualityOfService qos);
74 OCStackResult SendListObserverNotification (OCResource * resource,
75 OCObservationId *obsIdList, uint8_t numberOfIds,
76 unsigned char *notificationJSONPayload, uint32_t maxAge,
77 OCQualityOfService qos);
79 void DeleteObserverList();
81 OCStackResult GenerateObserverId (OCObservationId *observationId);
86 OCStackResult AddObserver (const char *resUri,
88 OCObservationId obsId,
91 OCResource *resHandle,
92 OCQualityOfService qos,
93 CAAddress_t *addressInfo,
94 CAConnectivityType_t connectivityType);
96 OCStackResult DeleteObserverUsingToken (CAToken_t * token);
97 ResourceObserver* GetObserverUsingToken (const CAToken_t * token);
99 OCStackResult AddObserver (const char *resUri,
101 OCObservationId obsId,
104 OCResource *resHandle,
105 OCQualityOfService qos);
107 OCStackResult DeleteObserverUsingToken (OCCoAPToken * token);
108 ResourceObserver* GetObserverUsingToken (const OCCoAPToken * token);
111 ResourceObserver* GetObserverUsingId (const OCObservationId observeId);
116 CreateObserveHeaderOption (CAHeaderOption_t **caHdrOpt,
117 OCHeaderOption *ocHdrOpt,
119 uint8_t observeFlag);
121 GetObserveHeaderOption (uint32_t * observationOption,
122 CAHeaderOption_t *options,
123 uint8_t * numOptions);
126 #endif //OC_OBSERVE_H