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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
22 //-----------------------------------------------------------------------------
24 //-----------------------------------------------------------------------------
26 // Defining _POSIX_C_SOURCE macro with 200112L (or greater) as value
27 // causes header files to expose definitions
28 // corresponding to the POSIX.1-2001 base
29 // specification (excluding the XSI extension).
30 // For POSIX.1-2001 base specification,
31 // Refer http://pubs.opengroup.org/onlinepubs/009695399/
32 #define _POSIX_C_SOURCE 200112L
33 #ifndef __STDC_FORMAT_MACROS
34 #define __STDC_FORMAT_MACROS
36 #ifndef __STDC_LIMIT_MACROS
37 #define __STDC_LIMIT_MACROS
39 #include "iotivity_config.h"
45 #include "ocstackinternal.h"
46 #include "ocresourcehandler.h"
47 #include "occlientcb.h"
48 #include "ocobserve.h"
50 #include "oic_malloc.h"
51 #include "oic_string.h"
53 #include "ocserverrequest.h"
54 #include "secureresourcemanager.h"
55 #include "psinterface.h"
56 #include "doxmresource.h"
58 #include "cainterface.h"
59 #include "ocpayload.h"
60 #include "ocpayloadcbor.h"
61 #include "cautilinterface.h"
64 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
65 #include "routingutility.h"
66 #ifdef ROUTING_GATEWAY
67 #include "routingmanager.h"
72 #include "oickeepalive.h"
75 //#ifdef DIRECT_PAIRING
76 #include "directpairing.h"
79 #ifdef HAVE_ARDUINO_TIME_H
82 #ifdef HAVE_SYS_TIME_H
85 #include <coap/coap.h>
87 #ifdef HAVE_ARPA_INET_H
88 #include <arpa/inet.h>
92 #define UINT32_MAX (0xFFFFFFFFUL)
95 //-----------------------------------------------------------------------------
97 //-----------------------------------------------------------------------------
100 OC_STACK_UNINITIALIZED = 0,
101 OC_STACK_INITIALIZED,
102 OC_STACK_UNINIT_IN_PROGRESS
108 OC_PRESENCE_UNINITIALIZED = 0,
109 OC_PRESENCE_INITIALIZED
113 //-----------------------------------------------------------------------------
115 //-----------------------------------------------------------------------------
116 static OCStackState stackState = OC_STACK_UNINITIALIZED;
118 OCResource *headResource = NULL;
119 static OCResource *tailResource = NULL;
120 static OCResourceHandle platformResource = {0};
121 static OCResourceHandle deviceResource = {0};
123 static OCResourceHandle brokerResource = {0};
127 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
128 static PresenceResource presenceResource = {0};
129 static uint8_t PresenceTimeOutSize = 0;
130 static uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
133 static OCMode myStackMode;
135 //TODO: revisit this design
136 static bool gRASetInfo = false;
138 OCDeviceEntityHandler defaultDeviceHandler;
139 void* defaultDeviceHandlerCallbackParameter = NULL;
140 static const char COAP_TCP_SCHEME[] = "coap+tcp:";
141 static const char COAPS_TCP_SCHEME[] = "coaps+tcp:";
142 static const char CORESPEC[] = "core";
144 CAAdapterStateChangedCB g_adapterHandler = NULL;
145 CAConnectionStateChangedCB g_connectionHandler = NULL;
147 //-----------------------------------------------------------------------------
149 //-----------------------------------------------------------------------------
150 #define TAG "OIC_RI_STACK"
151 #define VERIFY_SUCCESS(op, successCode) { if ((op) != (successCode)) \
152 {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
153 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
154 TAG, #arg " is NULL"); return (retVal); } }
155 #define VERIFY_NON_NULL_NR(arg, logLevel) { if (!(arg)) { OIC_LOG((logLevel), \
156 TAG, #arg " is NULL"); return; } }
157 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL");\
160 //TODO: we should allow the server to define this
161 #define MAX_OBSERVE_AGE (0x2FFFFUL)
163 #define MILLISECONDS_PER_SECOND (1000)
165 //-----------------------------------------------------------------------------
166 // Private internal function prototypes
167 //-----------------------------------------------------------------------------
170 * Generate handle of OCDoResource invocation for callback management.
172 * @return Generated OCDoResource handle.
174 static OCDoHandle GenerateInvocationHandle();
177 * Initialize resource data structures, variables, etc.
179 * @return ::OC_STACK_OK on success, some other value upon failure.
181 static OCStackResult initResources();
184 * Add a resource to the end of the linked list of resources.
186 * @param resource Resource to be added
188 static void insertResource(OCResource *resource);
191 * Find a resource in the linked list of resources.
193 * @param resource Resource to be found.
194 * @return Pointer to resource that was found in the linked list or NULL if the resource was not
197 static OCResource *findResource(OCResource *resource);
200 * Insert a resource type into a resource's resource type linked list.
201 * If resource type already exists, it will not be inserted and the
202 * resourceType will be free'd.
203 * resourceType->next should be null to avoid memory leaks.
204 * Function returns silently for null args.
206 * @param resource Resource where resource type is to be inserted.
207 * @param resourceType Resource type to be inserted.
209 static void insertResourceType(OCResource *resource,
210 OCResourceType *resourceType);
213 * Get a resource type at the specified index within a resource.
215 * @param handle Handle of resource.
216 * @param index Index of resource type.
218 * @return Pointer to resource type if found, NULL otherwise.
220 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
224 * Insert a resource interface into a resource's resource interface linked list.
225 * If resource interface already exists, it will not be inserted and the
226 * resourceInterface will be free'd.
227 * resourceInterface->next should be null to avoid memory leaks.
229 * @param resource Resource where resource interface is to be inserted.
230 * @param resourceInterface Resource interface to be inserted.
232 static void insertResourceInterface(OCResource *resource,
233 OCResourceInterface *resourceInterface);
236 * Get a resource interface at the specified index within a resource.
238 * @param handle Handle of resource.
239 * @param index Index of resource interface.
241 * @return Pointer to resource interface if found, NULL otherwise.
243 static OCResourceInterface *findResourceInterfaceAtIndex(
244 OCResourceHandle handle, uint8_t index);
247 * Delete all of the dynamically allocated elements that were created for the resource type.
249 * @param resourceType Specified resource type.
251 static void deleteResourceType(OCResourceType *resourceType);
254 * Delete all of the dynamically allocated elements that were created for the resource interface.
256 * @param resourceInterface Specified resource interface.
258 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
261 * Delete all of the dynamically allocated elements that were created for the resource.
263 * @param resource Specified resource.
265 static void deleteResourceElements(OCResource *resource);
268 * Delete resource specified by handle. Deletes resource and all resourcetype and resourceinterface
271 * @param handle Handle of resource to be deleted.
273 * @return ::OC_STACK_OK on success, some other value upon failure.
275 static OCStackResult deleteResource(OCResource *resource);
278 * Delete all of the resources in the resource list.
280 static void deleteAllResources();
283 * Increment resource sequence number. Handles rollover.
285 * @param resPtr Pointer to resource.
287 static void incrementSequenceNumber(OCResource * resPtr);
290 * Attempts to initialize every network interface that the CA Layer might have compiled in.
292 * Note: At least one interface must succeed to initialize. If all calls to @ref CASelectNetwork
293 * return something other than @ref CA_STATUS_OK, then this function fails.
295 * @return ::CA_STATUS_OK on success, some other value upon failure.
297 static CAResult_t OCSelectNetwork();
300 * Convert CAResponseResult_t to OCStackResult.
302 * @param caCode CAResponseResult_t code.
303 * @return ::OC_STACK_OK on success, some other value upon failure.
305 static OCStackResult CAResponseToOCStackResult(CAResponseResult_t caCode);
308 * Convert OCTransportFlags_t to CATransportModifiers_t.
310 * @param ocConType OCTransportFlags_t input.
311 * @return CATransportFlags
313 static CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocConType);
316 * Convert CATransportFlags_t to OCTransportModifiers_t.
318 * @param caConType CATransportFlags_t input.
319 * @return OCTransportFlags
321 static OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caConType);
324 * Handle response from presence request.
326 * @param endPoint CA remote endpoint.
327 * @param responseInfo CA response info.
328 * @return ::OC_STACK_OK on success, some other value upon failure.
330 static OCStackResult HandlePresenceResponse(const CAEndpoint_t *endPoint,
331 const CAResponseInfo_t *responseInfo);
334 * This function will be called back by CA layer when a response is received.
336 * @param endPoint CA remote endpoint.
337 * @param responseInfo CA response info.
339 static void HandleCAResponses(const CAEndpoint_t* endPoint,
340 const CAResponseInfo_t* responseInfo);
343 * This function will be called back by CA layer when a request is received.
345 * @param endPoint CA remote endpoint.
346 * @param requestInfo CA request info.
348 static void HandleCARequests(const CAEndpoint_t* endPoint,
349 const CARequestInfo_t* requestInfo);
352 * Extract query from a URI.
354 * @param uri Full URI with query.
355 * @param query Pointer to string that will contain query.
356 * @param newURI Pointer to string that will contain URI.
357 * @return ::OC_STACK_OK on success, some other value upon failure.
359 static OCStackResult getQueryFromUri(const char * uri, char** resourceType, char ** newURI);
362 * Finds a resource type in an OCResourceType link-list.
364 * @param resourceTypeList The link-list to be searched through.
365 * @param resourceTypeName The key to search for.
367 * @return Resource type that matches the key (ie. resourceTypeName) or
368 * NULL if there is either an invalid parameter or this function was unable to find the key.
370 static OCResourceType *findResourceType(OCResourceType * resourceTypeList,
371 const char * resourceTypeName);
374 * Reset presence TTL for a ClientCB struct. ttlLevel will be set to 0.
375 * TTL will be set to maxAge.
377 * @param cbNode Callback Node for which presence ttl is to be reset.
378 * @param maxAge New value of ttl in seconds.
380 * @return ::OC_STACK_OK on success, some other value upon failure.
382 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds);
385 * Ensure the accept header option is set appropriatly before sending the requests and routing
386 * header option is updated with destination.
388 * @param object CA remote endpoint.
389 * @param requestInfo CA request info.
391 * @return ::OC_STACK_OK on success, some other value upon failure.
393 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo);
396 * default adapter state change callback method
398 * @param adapter CA network adapter type.
399 * @param enabled current adapter state.
401 static void OCDefaultAdapterStateChangedHandler(CATransportAdapter_t adapter, bool enabled);
404 * default connection state change callback method
406 * @param info CAEndpoint which has address, port and etc.
407 * @param isConnected current connection state.
409 static void OCDefaultConnectionStateChangedHandler(const CAEndpoint_t *info, bool isConnected);
412 * Register network monitoring callback.
413 * Network status changes are delivered these callback.
414 * @param adapterHandler Adapter state monitoring callback.
415 * @param connectionHandler Connection state monitoring callback.
417 static void OCSetNetworkMonitorHandler(CAAdapterStateChangedCB adapterHandler,
418 CAConnectionStateChangedCB connectionHandler);
420 //-----------------------------------------------------------------------------
421 // Internal functions
422 //-----------------------------------------------------------------------------
424 bool checkProxyUri(OCHeaderOption *options, uint8_t numOptions)
426 if (!options || 0 == numOptions)
428 OIC_LOG (INFO, TAG, "No options present");
432 for (uint8_t i = 0; i < numOptions; i++)
434 if (options[i].protocolID == OC_COAP_ID && options[i].optionID == OC_RSRVD_PROXY_OPTION_ID)
436 OIC_LOG(DEBUG, TAG, "Proxy URI is present");
443 uint32_t GetTicks(uint32_t milliSeconds)
448 // Guard against overflow of uint32_t
449 if (milliSeconds <= ((UINT32_MAX - (uint32_t)now) * MILLISECONDS_PER_SECOND) /
450 COAP_TICKS_PER_SECOND)
452 return now + (milliSeconds * COAP_TICKS_PER_SECOND)/MILLISECONDS_PER_SECOND;
460 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out)
462 VERIFY_NON_NULL_NR(in, FATAL);
463 VERIFY_NON_NULL_NR(out, FATAL);
465 out->adapter = (OCTransportAdapter)in->adapter;
466 out->flags = CAToOCTransportFlags(in->flags);
467 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
468 out->port = in->port;
469 out->ifindex = in->ifindex;
470 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
471 /* This assert is to prevent accidental mismatch between address size macros defined in
472 * RI and CA and cause crash here. */
473 OC_STATIC_ASSERT(MAX_ADDR_STR_SIZE_CA == MAX_ADDR_STR_SIZE,
474 "Address size mismatch between RI and CA");
475 memcpy(out->routeData, in->routeData, sizeof(in->routeData));
479 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out)
481 VERIFY_NON_NULL_NR(in, FATAL);
482 VERIFY_NON_NULL_NR(out, FATAL);
484 out->adapter = (CATransportAdapter_t)in->adapter;
485 out->flags = OCToCATransportFlags(in->flags);
486 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
487 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
488 /* This assert is to prevent accidental mismatch between address size macros defined in
489 * RI and CA and cause crash here. */
490 OC_STATIC_ASSERT(MAX_ADDR_STR_SIZE_CA == MAX_ADDR_STR_SIZE,
491 "Address size mismatch between RI and CA");
492 memcpy(out->routeData, in->routeData, sizeof(in->routeData));
494 out->port = in->port;
495 out->ifindex = in->ifindex;
498 void FixUpClientResponse(OCClientResponse *cr)
500 VERIFY_NON_NULL_NR(cr, FATAL);
502 cr->addr = &cr->devAddr;
503 cr->connType = (OCConnectivityType)
504 ((cr->devAddr.adapter << CT_ADAPTER_SHIFT) | (cr->devAddr.flags & CT_MASK_FLAGS));
507 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo)
509 VERIFY_NON_NULL(object, FATAL, OC_STACK_INVALID_PARAM);
510 VERIFY_NON_NULL(requestInfo, FATAL, OC_STACK_INVALID_PARAM);
512 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
513 OCStackResult rmResult = RMAddInfo(object->routeData, requestInfo, true, NULL);
514 if (OC_STACK_OK != rmResult)
516 OIC_LOG(ERROR, TAG, "Add destination option failed");
521 // OC stack prefer CBOR encoded payloads.
522 requestInfo->info.acceptFormat = CA_FORMAT_APPLICATION_CBOR;
523 CAResult_t result = CASendRequest(object, requestInfo);
524 if(CA_STATUS_OK != result)
526 OIC_LOG_V(ERROR, TAG, "CASendRequest failed with CA error %u", result);
527 return CAResultToOCResult(result);
531 //-----------------------------------------------------------------------------
532 // Internal API function
533 //-----------------------------------------------------------------------------
535 // This internal function is called to update the stack with the status of
536 // observers and communication failures
537 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status)
539 OCStackResult result = OC_STACK_ERROR;
540 ResourceObserver * observer = NULL;
541 OCEntityHandlerRequest ehRequest = {0};
545 case OC_OBSERVER_NOT_INTERESTED:
546 OIC_LOG(DEBUG, TAG, "observer not interested in our notifications");
547 observer = GetObserverUsingToken (token, tokenLength);
550 result = FormOCEntityHandlerRequest(&ehRequest,
554 (OCResourceHandle)NULL,
555 NULL, PAYLOAD_TYPE_REPRESENTATION,
557 OC_OBSERVE_DEREGISTER,
560 if(result != OC_STACK_OK)
564 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
565 observer->resource->entityHandlerCallbackParam);
568 result = DeleteObserverUsingToken (token, tokenLength);
569 if(result == OC_STACK_OK)
571 OIC_LOG(DEBUG, TAG, "Removed observer successfully");
575 result = OC_STACK_OK;
576 OIC_LOG(DEBUG, TAG, "Observer Removal failed");
580 case OC_OBSERVER_STILL_INTERESTED:
581 OIC_LOG(DEBUG, TAG, "observer still interested, reset the failedCount");
582 observer = GetObserverUsingToken (token, tokenLength);
585 observer->forceHighQos = 0;
586 observer->failedCommCount = 0;
587 result = OC_STACK_OK;
591 result = OC_STACK_OBSERVER_NOT_FOUND;
595 case OC_OBSERVER_FAILED_COMM:
596 OIC_LOG(DEBUG, TAG, "observer is unreachable");
597 observer = GetObserverUsingToken (token, tokenLength);
600 if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
602 result = FormOCEntityHandlerRequest(&ehRequest,
606 (OCResourceHandle)NULL,
607 NULL, PAYLOAD_TYPE_REPRESENTATION,
609 OC_OBSERVE_DEREGISTER,
612 if(result != OC_STACK_OK)
614 return OC_STACK_ERROR;
616 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
617 observer->resource->entityHandlerCallbackParam);
619 result = DeleteObserverUsingToken (token, tokenLength);
620 if(result == OC_STACK_OK)
622 OIC_LOG(DEBUG, TAG, "Removed observer successfully");
626 result = OC_STACK_OK;
627 OIC_LOG(DEBUG, TAG, "Observer Removal failed");
632 observer->failedCommCount++;
633 observer->forceHighQos = 1;
634 OIC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",
635 observer->failedCommCount);
636 result = OC_STACK_CONTINUE;
641 OIC_LOG(ERROR, TAG, "Unknown status");
642 result = OC_STACK_ERROR;
648 OCStackResult CAResponseToOCStackResult(CAResponseResult_t caCode)
650 OCStackResult ret = OC_STACK_ERROR;
654 ret = OC_STACK_RESOURCE_CREATED;
657 ret = OC_STACK_RESOURCE_DELETED;
660 ret = OC_STACK_RESOURCE_CHANGED;
667 ret = OC_STACK_INVALID_QUERY;
669 case CA_UNAUTHORIZED_REQ:
670 ret = OC_STACK_UNAUTHORIZED_REQ;
673 ret = OC_STACK_INVALID_OPTION;
676 ret = OC_STACK_NO_RESOURCE;
678 case CA_RETRANSMIT_TIMEOUT:
679 ret = OC_STACK_COMM_ERROR;
681 case CA_REQUEST_ENTITY_TOO_LARGE:
682 ret = OC_STACK_TOO_LARGE_REQ;
684 case CA_FORBIDDEN_REQ:
685 ret = OC_STACK_FORBIDDEN_REQ;
687 case CA_INTERNAL_SERVER_ERROR:
688 ret = OC_STACK_INTERNAL_SERVER_ERROR;
696 CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method)
698 CAResponseResult_t ret = CA_INTERNAL_SERVER_ERROR;
707 // This Response Code is like HTTP 204 "No Content" but only used in
708 // response to POST and PUT requests.
712 // This Response Code is like HTTP 200 "OK" but only used in response to
717 // This should not happen but,
718 // give it a value just in case but output an error
720 OIC_LOG_V(ERROR, TAG, "Unexpected OC_STACK_OK return code for method [%d].",
724 case OC_STACK_RESOURCE_CREATED:
727 case OC_STACK_RESOURCE_DELETED:
730 case OC_STACK_RESOURCE_CHANGED:
733 case OC_STACK_INVALID_QUERY:
736 case OC_STACK_INVALID_OPTION:
739 case OC_STACK_NO_RESOURCE:
742 case OC_STACK_COMM_ERROR:
743 ret = CA_RETRANSMIT_TIMEOUT;
745 case OC_STACK_UNAUTHORIZED_REQ:
746 ret = CA_UNAUTHORIZED_REQ;
748 case OC_STACK_FORBIDDEN_REQ:
749 ret = CA_FORBIDDEN_REQ;
751 case OC_STACK_INTERNAL_SERVER_ERROR:
752 ret = CA_INTERNAL_SERVER_ERROR;
760 CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocFlags)
762 CATransportFlags_t caFlags = (CATransportFlags_t)ocFlags;
764 // supply default behavior.
765 if ((caFlags & (CA_IPV6|CA_IPV4)) == 0)
767 caFlags = (CATransportFlags_t)(caFlags|CA_IPV6|CA_IPV4);
769 if ((caFlags & OC_MASK_SCOPE) == 0)
771 caFlags = (CATransportFlags_t)(caFlags|OC_SCOPE_LINK);
776 OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caFlags)
778 return (OCTransportFlags)caFlags;
781 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds)
783 uint32_t lowerBound = 0;
784 uint32_t higherBound = 0;
786 if (!cbNode || !cbNode->presence || !cbNode->presence->timeOut)
788 return OC_STACK_INVALID_PARAM;
791 OIC_LOG_V(INFO, TAG, "Update presence TTL, time is %u", GetTicks(0));
793 cbNode->presence->TTL = maxAgeSeconds;
795 for (int index = 0; index < PresenceTimeOutSize; index++)
797 // Guard against overflow
798 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index]))
801 lowerBound = GetTicks((PresenceTimeOut[index] *
802 cbNode->presence->TTL *
803 MILLISECONDS_PER_SECOND)/100);
807 lowerBound = GetTicks(UINT32_MAX);
810 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index+1]))
813 higherBound = GetTicks((PresenceTimeOut[index + 1] *
814 cbNode->presence->TTL *
815 MILLISECONDS_PER_SECOND)/100);
819 higherBound = GetTicks(UINT32_MAX);
822 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
824 OIC_LOG_V(DEBUG, TAG, "lowerBound timeout %d", lowerBound);
825 OIC_LOG_V(DEBUG, TAG, "higherBound timeout %d", higherBound);
826 OIC_LOG_V(DEBUG, TAG, "timeOut entry %d", cbNode->presence->timeOut[index]);
829 cbNode->presence->TTLlevel = 0;
831 OIC_LOG_V(DEBUG, TAG, "this TTL level %d", cbNode->presence->TTLlevel);
835 const char *convertTriggerEnumToString(OCPresenceTrigger trigger)
837 if (trigger == OC_PRESENCE_TRIGGER_CREATE)
839 return OC_RSRVD_TRIGGER_CREATE;
841 else if (trigger == OC_PRESENCE_TRIGGER_CHANGE)
843 return OC_RSRVD_TRIGGER_CHANGE;
847 return OC_RSRVD_TRIGGER_DELETE;
851 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr)
855 return OC_PRESENCE_TRIGGER_CREATE;
857 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CREATE) == 0)
859 return OC_PRESENCE_TRIGGER_CREATE;
861 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CHANGE) == 0)
863 return OC_PRESENCE_TRIGGER_CHANGE;
867 return OC_PRESENCE_TRIGGER_DELETE;
871 OCStackResult OCEncodeAddressForRFC6874(char *outputAddress,
873 const char *inputAddress)
875 VERIFY_NON_NULL(inputAddress, FATAL, OC_STACK_INVALID_PARAM);
876 VERIFY_NON_NULL(outputAddress, FATAL, OC_STACK_INVALID_PARAM);
878 size_t inputLength = strnlen(inputAddress, outputSize);
880 // inputSize includes the null terminator
881 size_t inputSize = inputLength + 1;
883 if (inputSize > outputSize)
885 OIC_LOG_V(ERROR, TAG,
886 "OCEncodeAddressForRFC6874 failed: "
887 "outputSize (%zu) < inputSize (%zu)",
888 outputSize, inputSize);
890 return OC_STACK_ERROR;
893 char* percentChar = strchr(inputAddress, '%');
895 // If there is no '%' character, then no change is required to the string.
896 if (NULL == percentChar)
898 OICStrcpy(outputAddress, outputSize, inputAddress);
902 const char* addressPart = &inputAddress[0];
903 const char* scopeIdPart = percentChar + 1;
905 // Sanity check to make sure this string doesn't have more '%' characters
906 if (NULL != strchr(scopeIdPart, '%'))
908 return OC_STACK_ERROR;
911 // If no string follows the first '%', then the input was invalid.
912 if (scopeIdPart[0] == '\0')
914 OIC_LOG(ERROR, TAG, "OCEncodeAddressForRFC6874 failed: Invalid input string: no scope ID!");
915 return OC_STACK_ERROR;
918 // Check to see if the string is already encoded
919 if ((scopeIdPart[0] == '2') && (scopeIdPart[1] == '5'))
921 OIC_LOG(ERROR, TAG, "OCEncodeAddressForRFC6874 failed: Input string is already encoded");
922 return OC_STACK_ERROR;
925 // Fail if we don't have room for encoded string's two additional chars
926 if (outputSize < (inputSize + 2))
928 OIC_LOG(ERROR, TAG, "OCEncodeAddressForRFC6874 failed: encoded output will not fit!");
929 return OC_STACK_ERROR;
932 // Restore the null terminator with an escaped '%' character, per RFC 6874
933 OICStrcpy(outputAddress, scopeIdPart - addressPart, addressPart);
934 strcat(outputAddress, "%25");
935 strcat(outputAddress, scopeIdPart);
940 OCStackResult OCDecodeAddressForRFC6874(char *outputAddress,
942 const char *inputAddress,
945 VERIFY_NON_NULL(inputAddress, FATAL, OC_STACK_INVALID_PARAM);
946 VERIFY_NON_NULL(outputAddress, FATAL, OC_STACK_INVALID_PARAM);
950 end = inputAddress + strlen(inputAddress);
952 size_t inputLength = end - inputAddress;
954 const char *percent = strchr(inputAddress, '%');
955 if (!percent || (percent > end))
957 OICStrcpyPartial(outputAddress, outputSize, inputAddress, inputLength);
961 if (percent[1] != '2' || percent[2] != '5')
963 return OC_STACK_INVALID_URI;
966 int addrlen = percent - inputAddress + 1;
967 OICStrcpyPartial(outputAddress, outputSize, inputAddress, addrlen);
968 OICStrcpyPartial(outputAddress + addrlen, outputSize - addrlen,
969 percent + 3, end - percent - 3);
976 * The cononical presence allows constructed URIs to be string compared.
978 * requestUri must be a char array of size CA_MAX_URI_LENGTH
980 static int FormCanonicalPresenceUri(const CAEndpoint_t *endpoint,
981 char *presenceUri, bool isMulticast)
983 VERIFY_NON_NULL(endpoint , FATAL, OC_STACK_INVALID_PARAM);
984 VERIFY_NON_NULL(presenceUri, FATAL, OC_STACK_INVALID_PARAM);
988 OIC_LOG(DEBUG, TAG, "Make Multicast Presence URI");
989 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "%s", OC_RSRVD_PRESENCE_URI);
992 CAEndpoint_t *ep = (CAEndpoint_t *)endpoint;
993 if (ep->adapter == CA_ADAPTER_IP)
995 if ((ep->flags & CA_IPV6) && !(ep->flags & CA_IPV4))
997 if ('\0' == ep->addr[0]) // multicast
999 return snprintf(presenceUri, CA_MAX_URI_LENGTH, OC_RSRVD_PRESENCE_URI);
1003 char addressEncoded[CA_MAX_URI_LENGTH] = {0};
1005 OCStackResult result = OCEncodeAddressForRFC6874(addressEncoded,
1006 sizeof(addressEncoded),
1009 if (OC_STACK_OK != result)
1014 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://[%s]:%u%s",
1015 addressEncoded, ep->port, OC_RSRVD_PRESENCE_URI);
1020 if ('\0' == ep->addr[0]) // multicast
1022 OICStrcpy(ep->addr, sizeof(ep->addr), OC_MULTICAST_IP);
1023 ep->port = OC_MULTICAST_PORT;
1025 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s:%u%s",
1026 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
1030 // might work for other adapters (untested, but better than nothing)
1031 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s%s", ep->addr,
1032 OC_RSRVD_PRESENCE_URI);
1036 OCStackResult HandlePresenceResponse(const CAEndpoint_t *endpoint,
1037 const CAResponseInfo_t *responseInfo)
1039 VERIFY_NON_NULL(endpoint, FATAL, OC_STACK_INVALID_PARAM);
1040 VERIFY_NON_NULL(responseInfo, FATAL, OC_STACK_INVALID_PARAM);
1042 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
1043 ClientCB * cbNode = NULL;
1044 char *resourceTypeName = NULL;
1045 OCClientResponse response = {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1046 OCStackResult result = OC_STACK_ERROR;
1047 uint32_t maxAge = 0;
1049 char presenceUri[CA_MAX_URI_LENGTH];
1051 int presenceSubscribe = 0;
1052 int multicastPresenceSubscribe = 0;
1054 if (responseInfo->result != CA_CONTENT)
1056 OIC_LOG_V(ERROR, TAG, "HandlePresenceResponse failed %d", responseInfo->result);
1057 return OC_STACK_ERROR;
1060 response.payload = NULL;
1061 response.result = OC_STACK_OK;
1063 CopyEndpointToDevAddr(endpoint, &response.devAddr);
1064 FixUpClientResponse(&response);
1066 if (responseInfo->info.payload)
1068 result = OCParsePayload(&response.payload,
1069 PAYLOAD_TYPE_PRESENCE,
1070 responseInfo->info.payload,
1071 responseInfo->info.payloadSize);
1073 if(result != OC_STACK_OK)
1075 OIC_LOG(ERROR, TAG, "Presence parse failed");
1078 if(!response.payload || response.payload->type != PAYLOAD_TYPE_PRESENCE)
1080 OIC_LOG(ERROR, TAG, "Presence payload was wrong type");
1081 result = OC_STACK_ERROR;
1084 response.sequenceNumber = ((OCPresencePayload*)response.payload)->sequenceNumber;
1085 resourceTypeName = ((OCPresencePayload*)response.payload)->resourceType;
1086 maxAge = ((OCPresencePayload*)response.payload)->maxAge;
1089 // check for unicast presence
1090 uriLen = FormCanonicalPresenceUri(endpoint, presenceUri,
1091 responseInfo->isMulticast);
1092 if (uriLen < 0 || (size_t)uriLen >= sizeof (presenceUri))
1094 return OC_STACK_INVALID_URI;
1096 OIC_LOG(ERROR, TAG, "check for unicast presence");
1097 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
1100 presenceSubscribe = 1;
1104 // check for multicast presence
1105 OIC_LOG(ERROR, TAG, "check for multicast presence");
1106 cbNode = GetClientCB(NULL, 0, NULL, OC_RSRVD_PRESENCE_URI);
1109 multicastPresenceSubscribe = 1;
1113 if (!presenceSubscribe && !multicastPresenceSubscribe)
1115 OIC_LOG(ERROR, TAG, "Received a presence notification, but no callback, ignoring");
1119 if (presenceSubscribe)
1121 if(cbNode->sequenceNumber == response.sequenceNumber)
1123 OIC_LOG(INFO, TAG, "No presence change");
1124 ResetPresenceTTL(cbNode, maxAge);
1125 OIC_LOG_V(INFO, TAG, "ResetPresenceTTL - TTLlevel:%d\n", cbNode->presence->TTLlevel);
1131 OIC_LOG(INFO, TAG, "Stopping presence");
1132 response.result = OC_STACK_PRESENCE_STOPPED;
1133 if(cbNode->presence)
1135 OICFree(cbNode->presence->timeOut);
1136 OICFree(cbNode->presence);
1137 cbNode->presence = NULL;
1142 if(!cbNode->presence)
1144 cbNode->presence = (OCPresence *)OICMalloc(sizeof (OCPresence));
1146 if(!(cbNode->presence))
1148 OIC_LOG(ERROR, TAG, "Could not allocate memory for cbNode->presence");
1149 result = OC_STACK_NO_MEMORY;
1153 VERIFY_NON_NULL_V(cbNode->presence);
1154 cbNode->presence->timeOut = NULL;
1155 cbNode->presence->timeOut = (uint32_t *)
1156 OICMalloc(PresenceTimeOutSize * sizeof(uint32_t));
1157 if(!(cbNode->presence->timeOut)){
1159 "Could not allocate memory for cbNode->presence->timeOut");
1160 OICFree(cbNode->presence);
1161 result = OC_STACK_NO_MEMORY;
1166 ResetPresenceTTL(cbNode, maxAge);
1168 cbNode->sequenceNumber = response.sequenceNumber;
1173 // This is the multicast case
1174 OIC_LOG(INFO, TAG, "this is the multicast presence");
1177 OIC_LOG(INFO, TAG, "Stopping presence");
1178 response.result = OC_STACK_PRESENCE_STOPPED;
1182 // Ensure that a filter is actually applied.
1183 if (resourceTypeName && cbNode->filterResourceType)
1185 OIC_LOG_V(INFO, TAG, "find resource type : %s", resourceTypeName);
1186 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1192 OIC_LOG(INFO, TAG, "Callback for presence");
1194 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
1196 if (cbResult == OC_STACK_DELETE_TRANSACTION)
1198 FindAndDeleteClientCB(cbNode);
1202 OCPayloadDestroy(response.payload);
1206 void OCHandleResponse(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1208 OIC_LOG(DEBUG, TAG, "Enter OCHandleResponse");
1210 if(responseInfo->info.resourceUri &&
1211 strcmp(responseInfo->info.resourceUri, OC_RSRVD_PRESENCE_URI) == 0)
1213 HandlePresenceResponse(endPoint, responseInfo);
1217 ClientCB *cbNode = GetClientCB(responseInfo->info.token,
1218 responseInfo->info.tokenLength, NULL, NULL);
1220 ResourceObserver * observer = GetObserverUsingToken (responseInfo->info.token,
1221 responseInfo->info.tokenLength);
1225 OIC_LOG(INFO, TAG, "There is a cbNode associated with the response token");
1226 if(responseInfo->result == CA_EMPTY)
1228 OIC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1229 // We do not have a case for the client to receive a RESET
1230 if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1232 //This is the case of receiving an ACK on a request to a slow resource!
1233 OIC_LOG(INFO, TAG, "This is a pure ACK");
1234 //TODO: should we inform the client
1235 // app that at least the request was received at the server?
1238 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1240 OIC_LOG(INFO, TAG, "Receiving A Timeout for this token");
1241 OIC_LOG(INFO, TAG, "Calling into application address space");
1243 OCClientResponse response =
1244 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1245 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1246 FixUpClientResponse(&response);
1247 response.resourceUri = responseInfo->info.resourceUri;
1248 memcpy(response.identity.id, responseInfo->info.identity.id,
1249 sizeof (response.identity.id));
1250 response.identity.id_length = responseInfo->info.identity.id_length;
1252 response.result = CAResponseToOCStackResult(responseInfo->result);
1253 cbNode->callBack(cbNode->context,
1254 cbNode->handle, &response);
1255 FindAndDeleteClientCB(cbNode);
1259 OIC_LOG(INFO, TAG, "This is a regular response, A client call back is found");
1260 OIC_LOG(INFO, TAG, "Calling into application address space");
1262 OCClientResponse response =
1263 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1264 response.sequenceNumber = MAX_SEQUENCE_NUMBER + 1;
1265 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1266 FixUpClientResponse(&response);
1267 response.resourceUri = responseInfo->info.resourceUri;
1268 memcpy(response.identity.id, responseInfo->info.identity.id,
1269 sizeof (response.identity.id));
1270 response.identity.id_length = responseInfo->info.identity.id_length;
1272 response.result = CAResponseToOCStackResult(responseInfo->result);
1274 if(responseInfo->info.payload &&
1275 responseInfo->info.payloadSize)
1277 OCPayloadType type = PAYLOAD_TYPE_INVALID;
1278 // check the security resource
1279 if (SRMIsSecurityResourceURI(cbNode->requestUri))
1281 type = PAYLOAD_TYPE_SECURITY;
1283 else if (cbNode->method == OC_REST_DISCOVER)
1285 if (strncmp(OC_RSRVD_WELL_KNOWN_URI,cbNode->requestUri,
1286 sizeof(OC_RSRVD_WELL_KNOWN_URI) - 1) == 0)
1288 type = PAYLOAD_TYPE_DISCOVERY;
1291 else if (strcmp(cbNode->requestUri, OC_RSRVD_WELL_KNOWN_MQ_URI) == 0)
1293 type = PAYLOAD_TYPE_DISCOVERY;
1296 else if (strcmp(cbNode->requestUri, OC_RSRVD_DEVICE_URI) == 0)
1298 type = PAYLOAD_TYPE_REPRESENTATION;
1300 else if (strcmp(cbNode->requestUri, OC_RSRVD_PLATFORM_URI) == 0)
1302 type = PAYLOAD_TYPE_REPRESENTATION;
1305 #ifdef ROUTING_GATEWAY
1306 else if (strcmp(cbNode->requestUri, OC_RSRVD_GATEWAY_URI) == 0)
1308 type = PAYLOAD_TYPE_REPRESENTATION;
1311 else if (strcmp(cbNode->requestUri, OC_RSRVD_RD_URI) == 0)
1313 type = PAYLOAD_TYPE_REPRESENTATION;
1316 else if (strcmp(cbNode->requestUri, KEEPALIVE_RESOURCE_URI) == 0)
1318 type = PAYLOAD_TYPE_REPRESENTATION;
1323 OIC_LOG_V(ERROR, TAG, "Unknown Payload type in Discovery: %d %s",
1324 cbNode->method, cbNode->requestUri);
1328 else if (cbNode->method == OC_REST_GET ||
1329 cbNode->method == OC_REST_PUT ||
1330 cbNode->method == OC_REST_POST ||
1331 cbNode->method == OC_REST_OBSERVE ||
1332 cbNode->method == OC_REST_OBSERVE_ALL ||
1333 cbNode->method == OC_REST_DELETE)
1335 if (cbNode->requestUri)
1337 if (0 == strcmp(OC_RSRVD_PLATFORM_URI, cbNode->requestUri))
1339 type = PAYLOAD_TYPE_REPRESENTATION;
1341 else if (0 == strcmp(OC_RSRVD_DEVICE_URI, cbNode->requestUri))
1343 type = PAYLOAD_TYPE_REPRESENTATION;
1345 if (type == PAYLOAD_TYPE_INVALID)
1347 OIC_LOG_V(INFO, TAG, "Assuming PAYLOAD_TYPE_REPRESENTATION: %d %s",
1348 cbNode->method, cbNode->requestUri);
1349 type = PAYLOAD_TYPE_REPRESENTATION;
1354 OIC_LOG(INFO, TAG, "No Request URI, PROXY URI");
1355 type = PAYLOAD_TYPE_REPRESENTATION;
1360 OIC_LOG_V(ERROR, TAG, "Unknown Payload type: %d %s",
1361 cbNode->method, cbNode->requestUri);
1365 if(OC_STACK_OK != OCParsePayload(&response.payload,
1367 responseInfo->info.payload,
1368 responseInfo->info.payloadSize))
1370 OIC_LOG(ERROR, TAG, "Error converting payload");
1371 OCPayloadDestroy(response.payload);
1376 response.numRcvdVendorSpecificHeaderOptions = 0;
1377 if(responseInfo->info.numOptions > 0)
1380 //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
1381 if(responseInfo->info.options
1382 && responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
1385 uint32_t observationOption;
1386 uint8_t* optionData = (uint8_t*)responseInfo->info.options[0].optionData;
1387 for (observationOption=0, i=0;
1388 i<sizeof(uint32_t) && i<responseInfo->info.options[0].optionLength;
1392 (observationOption << 8) | optionData[i];
1394 response.sequenceNumber = observationOption;
1395 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
1400 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
1403 if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
1405 OIC_LOG(ERROR, TAG, "#header options are more than MAX_HEADER_OPTIONS");
1406 OCPayloadDestroy(response.payload);
1410 for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
1412 if(&(responseInfo->info.options[i]))
1414 memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
1415 &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
1420 if (cbNode->method == OC_REST_OBSERVE &&
1421 response.sequenceNumber > OC_OFFSET_SEQUENCE_NUMBER &&
1422 cbNode->sequenceNumber <= MAX_SEQUENCE_NUMBER &&
1423 response.sequenceNumber <= cbNode->sequenceNumber)
1425 OIC_LOG_V(INFO, TAG, "Received stale notification. Number :%d",
1426 response.sequenceNumber);
1431 // if request uri is '/oic/rd', update ins value of resource.
1432 char *targetUri = strstr(cbNode->requestUri, OC_RSRVD_RD_URI);
1435 OCUpdateResourceInsWithResponse(cbNode->requestUri, &response);
1438 OCStackApplicationResult appFeedback = cbNode->callBack(cbNode->context,
1441 cbNode->sequenceNumber = response.sequenceNumber;
1443 if (appFeedback == OC_STACK_DELETE_TRANSACTION)
1445 FindAndDeleteClientCB(cbNode);
1449 // To keep discovery callbacks active.
1450 cbNode->TTL = GetTicks(MAX_CB_TIMEOUT_SECONDS *
1451 MILLISECONDS_PER_SECOND);
1455 //Need to send ACK when the response is CON
1456 if(responseInfo->info.type == CA_MSG_CONFIRM)
1458 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1459 CA_MSG_ACKNOWLEDGE, 0, NULL, NULL, 0, NULL, CA_RESPONSE_FOR_RES);
1462 OCPayloadDestroy(response.payload);
1469 OIC_LOG(INFO, TAG, "There is an observer associated with the response token");
1470 if(responseInfo->result == CA_EMPTY)
1472 OIC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1473 if(responseInfo->info.type == CA_MSG_RESET)
1475 OIC_LOG(INFO, TAG, "This is a RESET");
1476 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1477 OC_OBSERVER_NOT_INTERESTED);
1479 else if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1481 OIC_LOG(INFO, TAG, "This is a pure ACK");
1482 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1483 OC_OBSERVER_STILL_INTERESTED);
1486 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1488 OIC_LOG(INFO, TAG, "Receiving Time Out for an observer");
1489 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1490 OC_OBSERVER_FAILED_COMM);
1495 if(!cbNode && !observer)
1497 if(myStackMode == OC_CLIENT || myStackMode == OC_CLIENT_SERVER
1498 || myStackMode == OC_GATEWAY)
1500 OIC_LOG(INFO, TAG, "This is a client, but no cbNode was found for token");
1501 if(responseInfo->result == CA_EMPTY)
1503 OIC_LOG(INFO, TAG, "Receiving CA_EMPTY in the ocstack");
1507 OIC_LOG(INFO, TAG, "Received a message without callbacks. Sending RESET");
1508 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1509 CA_MSG_RESET, 0, NULL, NULL, 0, NULL, CA_RESPONSE_FOR_RES);
1513 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER
1514 || myStackMode == OC_GATEWAY)
1516 OIC_LOG(INFO, TAG, "This is a server, but no observer was found for token");
1517 if (responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1519 OIC_LOG_V(INFO, TAG, "Received ACK at server for messageId : %d",
1520 responseInfo->info.messageId);
1522 if (responseInfo->info.type == CA_MSG_RESET)
1524 OIC_LOG_V(INFO, TAG, "Received RESET at server for messageId : %d",
1525 responseInfo->info.messageId);
1533 void HandleCAResponses(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1535 VERIFY_NON_NULL_NR(endPoint, FATAL);
1536 VERIFY_NON_NULL_NR(responseInfo, FATAL);
1538 OIC_LOG(INFO, TAG, "Enter HandleCAResponses");
1540 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1541 #ifdef ROUTING_GATEWAY
1542 bool needRIHandling = false;
1544 * Routing manager is going to update either of endpoint or response or both.
1545 * This typecasting is done to avoid unnecessary duplication of Endpoint and responseInfo
1546 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1549 OCStackResult ret = RMHandleResponse((CAResponseInfo_t *)responseInfo, (CAEndpoint_t *)endPoint,
1551 if(ret != OC_STACK_OK || !needRIHandling)
1553 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1559 * Put source in sender endpoint so that the next packet from application can be routed to
1560 * proper destination and remove "RM" coap header option before passing request / response to
1561 * RI as this option will make no sense to either RI or application.
1563 RMUpdateInfo((CAHeaderOption_t **) &(responseInfo->info.options),
1564 (uint8_t *) &(responseInfo->info.numOptions),
1565 (CAEndpoint_t *) endPoint);
1568 OCHandleResponse(endPoint, responseInfo);
1570 OIC_LOG(INFO, TAG, "Exit HandleCAResponses");
1574 * This function handles error response from CA
1575 * code shall be added to handle the errors
1577 void HandleCAErrorResponse(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errorInfo)
1579 VERIFY_NON_NULL_NR(endPoint, FATAL);
1580 VERIFY_NON_NULL_NR(errorInfo, FATAL);
1582 OIC_LOG(INFO, TAG, "Enter HandleCAErrorResponse");
1584 ClientCB *cbNode = GetClientCB(errorInfo->info.token,
1585 errorInfo->info.tokenLength, NULL, NULL);
1588 OCClientResponse response = { .devAddr = { .adapter = OC_DEFAULT_ADAPTER } };
1589 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1590 FixUpClientResponse(&response);
1591 response.resourceUri = errorInfo->info.resourceUri;
1592 memcpy(response.identity.id, errorInfo->info.identity.id,
1593 sizeof (response.identity.id));
1594 response.identity.id_length = errorInfo->info.identity.id_length;
1595 response.result = CAResultToOCResult(errorInfo->result);
1597 cbNode->callBack(cbNode->context, cbNode->handle, &response);
1600 ResourceObserver *observer = GetObserverUsingToken(errorInfo->info.token,
1601 errorInfo->info.tokenLength);
1604 OIC_LOG(INFO, TAG, "Receiving communication error for an observer");
1605 OCStackResult result = CAResultToOCResult(errorInfo->result);
1606 if (OC_STACK_COMM_ERROR == result)
1608 OCStackFeedBack(errorInfo->info.token, errorInfo->info.tokenLength,
1609 OC_OBSERVER_FAILED_COMM);
1613 OIC_LOG(INFO, TAG, "Exit HandleCAErrorResponse");
1617 * This function sends out Direct Stack Responses. These are responses that are not coming
1618 * from the application entity handler. These responses have no payload and are usually ACKs,
1619 * RESETs or some error conditions that were caught by the stack.
1621 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
1622 const CAResponseResult_t responseResult, const CAMessageType_t type,
1623 const uint8_t numOptions, const CAHeaderOption_t *options,
1624 CAToken_t token, uint8_t tokenLength, const char *resourceUri,
1625 CADataType_t dataType)
1627 OIC_LOG(DEBUG, TAG, "Entering SendDirectStackResponse");
1628 CAResponseInfo_t respInfo = {
1629 .result = responseResult
1631 respInfo.info.messageId = coapID;
1632 respInfo.info.numOptions = numOptions;
1634 if (respInfo.info.numOptions)
1636 respInfo.info.options =
1637 (CAHeaderOption_t *)OICCalloc(respInfo.info.numOptions, sizeof(CAHeaderOption_t));
1638 memcpy (respInfo.info.options, options,
1639 sizeof(CAHeaderOption_t) * respInfo.info.numOptions);
1643 respInfo.info.payload = NULL;
1644 respInfo.info.token = token;
1645 respInfo.info.tokenLength = tokenLength;
1646 respInfo.info.type = type;
1647 respInfo.info.resourceUri = OICStrdup (resourceUri);
1648 respInfo.info.acceptFormat = CA_FORMAT_UNDEFINED;
1649 respInfo.info.dataType = dataType;
1651 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1652 // Add the destination to route option from the endpoint->routeData.
1653 bool doPost = false;
1654 OCStackResult result = RMAddInfo(endPoint->routeData, &respInfo, false, &doPost);
1655 if(OC_STACK_OK != result)
1657 OIC_LOG_V(ERROR, TAG, "Add routing option failed [%d]", result);
1658 OICFree (respInfo.info.resourceUri);
1659 OICFree (respInfo.info.options);
1664 OIC_LOG(DEBUG, TAG, "Sending a POST message for EMPTY ACK in Client Mode");
1665 CARequestInfo_t reqInfo = {.method = CA_POST };
1666 /* The following initialization is not done in a single initializer block as in
1667 * arduino, .c file is compiled as .cpp and moves it from C99 to C++11. The latter
1668 * does not have designated initalizers. This is a work-around for now.
1670 reqInfo.info.type = CA_MSG_NONCONFIRM;
1671 reqInfo.info.messageId = coapID;
1672 reqInfo.info.tokenLength = tokenLength;
1673 reqInfo.info.token = token;
1674 reqInfo.info.numOptions = respInfo.info.numOptions;
1675 reqInfo.info.payload = NULL;
1676 reqInfo.info.resourceUri = OICStrdup (OC_RSRVD_GATEWAY_URI);
1677 if (reqInfo.info.numOptions)
1679 reqInfo.info.options =
1680 (CAHeaderOption_t *)OICCalloc(reqInfo.info.numOptions, sizeof(CAHeaderOption_t));
1681 if (NULL == reqInfo.info.options)
1683 OIC_LOG(ERROR, TAG, "Calloc failed");
1684 OICFree (reqInfo.info.resourceUri);
1685 OICFree (respInfo.info.resourceUri);
1686 OICFree (respInfo.info.options);
1687 return OC_STACK_NO_MEMORY;
1689 memcpy (reqInfo.info.options, respInfo.info.options,
1690 sizeof(CAHeaderOption_t) * reqInfo.info.numOptions);
1693 CAResult_t caResult = CASendRequest(endPoint, &reqInfo);
1694 OICFree (reqInfo.info.resourceUri);
1695 OICFree (reqInfo.info.options);
1696 OICFree (respInfo.info.resourceUri);
1697 OICFree (respInfo.info.options);
1698 if (CA_STATUS_OK != caResult)
1700 OIC_LOG(ERROR, TAG, "CASendRequest error");
1701 return CAResultToOCResult(caResult);
1707 CAResult_t caResult = CASendResponse(endPoint, &respInfo);
1709 // resourceUri in the info field is cloned in the CA layer and
1710 // thus ownership is still here.
1711 OICFree (respInfo.info.resourceUri);
1712 OICFree (respInfo.info.options);
1713 if(CA_STATUS_OK != caResult)
1715 OIC_LOG(ERROR, TAG, "CASendResponse error");
1716 return CAResultToOCResult(caResult);
1719 OIC_LOG(DEBUG, TAG, "Exit SendDirectStackResponse");
1723 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
1725 OIC_LOG(INFO, TAG, "Entering HandleStackRequests (OCStack Layer)");
1726 OCStackResult result = OC_STACK_ERROR;
1727 if(!protocolRequest)
1729 OIC_LOG(ERROR, TAG, "protocolRequest is NULL");
1730 return OC_STACK_INVALID_PARAM;
1733 OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken,
1734 protocolRequest->tokenLength);
1737 OIC_LOG(INFO, TAG, "This is a new Server Request");
1738 result = AddServerRequest(&request, protocolRequest->coapID,
1739 protocolRequest->delayedResNeeded, 0, protocolRequest->method,
1740 protocolRequest->numRcvdVendorSpecificHeaderOptions,
1741 protocolRequest->observationOption, protocolRequest->qos,
1742 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
1743 protocolRequest->payload, protocolRequest->requestToken,
1744 protocolRequest->tokenLength, protocolRequest->resourceUrl,
1745 protocolRequest->reqTotalSize, protocolRequest->acceptFormat,
1746 &protocolRequest->devAddr);
1747 if (OC_STACK_OK != result)
1749 OIC_LOG(ERROR, TAG, "Error adding server request");
1755 OIC_LOG(ERROR, TAG, "Out of Memory");
1756 return OC_STACK_NO_MEMORY;
1759 if(!protocolRequest->reqMorePacket)
1761 request->requestComplete = 1;
1766 OIC_LOG(INFO, TAG, "This is either a repeated or blocked Server Request");
1769 if(request->requestComplete)
1771 OIC_LOG(INFO, TAG, "This Server Request is complete");
1772 ResourceHandling resHandling = OC_RESOURCE_VIRTUAL;
1773 OCResource *resource = NULL;
1774 result = DetermineResourceHandling (request, &resHandling, &resource);
1775 if (result == OC_STACK_OK)
1777 result = ProcessRequest(resHandling, resource, request);
1782 OIC_LOG(INFO, TAG, "This Server Request is incomplete");
1783 result = OC_STACK_CONTINUE;
1788 void OCHandleRequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1790 OIC_LOG(DEBUG, TAG, "Enter OCHandleRequests");
1792 OCStackResult requestResult = OC_STACK_ERROR;
1794 if(myStackMode == OC_CLIENT)
1796 //TODO: should the client be responding to requests?
1800 OCServerProtocolRequest serverRequest = {0};
1802 OIC_LOG_V(INFO, TAG, "Endpoint URI : %s", requestInfo->info.resourceUri);
1804 char * uriWithoutQuery = NULL;
1805 char * query = NULL;
1807 requestResult = getQueryFromUri(requestInfo->info.resourceUri, &query, &uriWithoutQuery);
1809 if (requestResult != OC_STACK_OK || !uriWithoutQuery)
1811 OIC_LOG_V(ERROR, TAG, "getQueryFromUri() failed with OC error code %d\n", requestResult);
1814 OIC_LOG_V(INFO, TAG, "URI without query: %s", uriWithoutQuery);
1815 OIC_LOG_V(INFO, TAG, "Query : %s", query);
1817 if(strlen(uriWithoutQuery) < MAX_URI_LENGTH)
1819 OICStrcpy(serverRequest.resourceUrl, sizeof(serverRequest.resourceUrl), uriWithoutQuery);
1820 OICFree(uriWithoutQuery);
1824 OIC_LOG(ERROR, TAG, "URI length exceeds MAX_URI_LENGTH.");
1825 OICFree(uriWithoutQuery);
1832 if(strlen(query) < MAX_QUERY_LENGTH)
1834 OICStrcpy(serverRequest.query, sizeof(serverRequest.query), query);
1839 OIC_LOG(ERROR, TAG, "Query length exceeds MAX_QUERY_LENGTH.");
1845 if ((requestInfo->info.payload) && (0 < requestInfo->info.payloadSize))
1847 serverRequest.reqTotalSize = requestInfo->info.payloadSize;
1848 serverRequest.payload = (uint8_t *) OICMalloc(requestInfo->info.payloadSize);
1849 if (!serverRequest.payload)
1851 OIC_LOG(ERROR, TAG, "Allocation for payload failed.");
1854 memcpy (serverRequest.payload, requestInfo->info.payload,
1855 requestInfo->info.payloadSize);
1859 serverRequest.reqTotalSize = 0;
1862 switch (requestInfo->method)
1865 serverRequest.method = OC_REST_GET;
1868 serverRequest.method = OC_REST_PUT;
1871 serverRequest.method = OC_REST_POST;
1874 serverRequest.method = OC_REST_DELETE;
1877 OIC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1878 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1879 requestInfo->info.type, requestInfo->info.numOptions,
1880 requestInfo->info.options, requestInfo->info.token,
1881 requestInfo->info.tokenLength, requestInfo->info.resourceUri,
1883 OICFree(serverRequest.payload);
1887 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1888 requestInfo->info.tokenLength);
1890 serverRequest.tokenLength = requestInfo->info.tokenLength;
1891 if (serverRequest.tokenLength) {
1893 serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1895 if (!serverRequest.requestToken)
1897 OIC_LOG(FATAL, TAG, "Allocation for token failed.");
1898 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1899 requestInfo->info.type, requestInfo->info.numOptions,
1900 requestInfo->info.options, requestInfo->info.token,
1901 requestInfo->info.tokenLength, requestInfo->info.resourceUri,
1903 OICFree(serverRequest.payload);
1906 memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1909 switch (requestInfo->info.acceptFormat)
1911 case CA_FORMAT_APPLICATION_CBOR:
1912 serverRequest.acceptFormat = OC_FORMAT_CBOR;
1914 case CA_FORMAT_UNDEFINED:
1915 serverRequest.acceptFormat = OC_FORMAT_UNDEFINED;
1918 serverRequest.acceptFormat = OC_FORMAT_UNSUPPORTED;
1921 if (requestInfo->info.type == CA_MSG_CONFIRM)
1923 serverRequest.qos = OC_HIGH_QOS;
1927 serverRequest.qos = OC_LOW_QOS;
1929 // CA does not need the following field
1930 // Are we sure CA does not need them? how is it responding to multicast
1931 serverRequest.delayedResNeeded = 0;
1933 serverRequest.coapID = requestInfo->info.messageId;
1935 CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1937 // copy vendor specific header options
1938 uint8_t tempNum = (requestInfo->info.numOptions);
1940 // Assume no observation requested and it is a pure GET.
1941 // If obs registration/de-registration requested it'll be fetched from the
1942 // options in GetObserveHeaderOption()
1943 serverRequest.observationOption = OC_OBSERVE_NO_OPTION;
1945 GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1946 if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1949 "The request info numOptions is greater than MAX_HEADER_OPTIONS");
1950 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1951 requestInfo->info.type, requestInfo->info.numOptions,
1952 requestInfo->info.options, requestInfo->info.token,
1953 requestInfo->info.tokenLength, requestInfo->info.resourceUri,
1955 OICFree(serverRequest.payload);
1956 OICFree(serverRequest.requestToken);
1959 serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1960 if (serverRequest.numRcvdVendorSpecificHeaderOptions && requestInfo->info.options)
1962 memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1963 sizeof(CAHeaderOption_t)*tempNum);
1966 requestResult = HandleStackRequests (&serverRequest);
1968 // Send ACK to client as precursor to slow response
1969 if (requestResult == OC_STACK_SLOW_RESOURCE)
1971 if (requestInfo->info.type == CA_MSG_CONFIRM)
1973 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1974 CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0, NULL,
1978 if (requestResult == OC_STACK_RESOURCE_ERROR
1979 && serverRequest.observationOption == OC_OBSERVE_REGISTER)
1981 OIC_LOG_V(ERROR, TAG, "Observe Registration failed due to resource error");
1983 else if(!OCResultToSuccess(requestResult))
1985 OIC_LOG_V(ERROR, TAG, "HandleStackRequests failed. error: %d", requestResult);
1987 CAResponseResult_t stackResponse =
1988 OCToCAStackResult(requestResult, serverRequest.method);
1990 SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1991 requestInfo->info.type, requestInfo->info.numOptions,
1992 requestInfo->info.options, requestInfo->info.token,
1993 requestInfo->info.tokenLength, requestInfo->info.resourceUri,
1996 // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1997 // The token is copied in there, and is thus still owned by this function.
1998 OICFree(serverRequest.payload);
1999 OICFree(serverRequest.requestToken);
2000 OIC_LOG(INFO, TAG, "Exit OCHandleRequests");
2003 //This function will be called back by CA layer when a request is received
2004 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
2006 OIC_LOG(INFO, TAG, "Enter HandleCARequests");
2009 OIC_LOG(ERROR, TAG, "endPoint is NULL");
2015 OIC_LOG(ERROR, TAG, "requestInfo is NULL");
2019 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
2020 #ifdef ROUTING_GATEWAY
2021 bool needRIHandling = false;
2022 bool isEmptyMsg = false;
2024 * Routing manager is going to update either of endpoint or request or both.
2025 * This typecasting is done to avoid unnecessary duplication of Endpoint and requestInfo
2026 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
2027 * destination. It can also remove "RM" coap header option before passing request / response to
2028 * RI as this option will make no sense to either RI or application.
2030 OCStackResult ret = RMHandleRequest((CARequestInfo_t *)requestInfo, (CAEndpoint_t *)endPoint,
2031 &needRIHandling, &isEmptyMsg);
2032 if(OC_STACK_OK != ret || !needRIHandling)
2034 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
2040 * Put source in sender endpoint so that the next packet from application can be routed to
2041 * proper destination and remove RM header option.
2043 RMUpdateInfo((CAHeaderOption_t **) &(requestInfo->info.options),
2044 (uint8_t *) &(requestInfo->info.numOptions),
2045 (CAEndpoint_t *) endPoint);
2047 #ifdef ROUTING_GATEWAY
2051 * In Gateways, the MSGType in route option is used to check if the actual
2052 * response is EMPTY message(4 bytes CoAP Header). In case of Client, the
2053 * EMPTY response is sent in the form of POST request which need to be changed
2054 * to a EMPTY response by RM. This translation is done in this part of the code.
2056 OIC_LOG(INFO, TAG, "This is a Empty response from the Client");
2057 CAResponseInfo_t respInfo = {.result = CA_EMPTY,
2058 .info.messageId = requestInfo->info.messageId,
2059 .info.type = CA_MSG_ACKNOWLEDGE};
2060 OCHandleResponse(endPoint, &respInfo);
2066 // Normal handling of the packet
2067 OCHandleRequests(endPoint, requestInfo);
2069 OIC_LOG(INFO, TAG, "Exit HandleCARequests");
2072 //-----------------------------------------------------------------------------
2074 //-----------------------------------------------------------------------------
2076 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
2079 !raInfo->username ||
2080 !raInfo->hostname ||
2081 !raInfo->xmpp_domain)
2084 return OC_STACK_INVALID_PARAM;
2086 OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
2087 gRASetInfo = (result == OC_STACK_OK)? true : false;
2093 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
2097 return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
2100 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
2102 if(stackState == OC_STACK_INITIALIZED)
2104 OIC_LOG(INFO, TAG, "Subsequent calls to OCInit() without calling \
2105 OCStop() between them are ignored.");
2109 #ifndef ROUTING_GATEWAY
2110 if (OC_GATEWAY == mode)
2112 OIC_LOG(ERROR, TAG, "Routing Manager not supported");
2113 return OC_STACK_INVALID_PARAM;
2120 OIC_LOG(ERROR, TAG, "Need to call OCSetRAInfo before calling OCInit");
2121 return OC_STACK_ERROR;
2125 OCStackResult result = OC_STACK_ERROR;
2126 OIC_LOG(INFO, TAG, "Entering OCInit");
2129 if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)
2130 || (mode == OC_GATEWAY)))
2132 OIC_LOG(ERROR, TAG, "Invalid mode");
2133 return OC_STACK_ERROR;
2137 if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
2139 caglobals.client = true;
2141 if (mode == OC_SERVER || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
2143 caglobals.server = true;
2146 caglobals.serverFlags = (CATransportFlags_t)serverFlags;
2147 if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
2149 caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4|CA_IPV6);
2151 caglobals.clientFlags = (CATransportFlags_t)clientFlags;
2152 if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
2154 caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4|CA_IPV6);
2157 defaultDeviceHandler = NULL;
2158 defaultDeviceHandlerCallbackParameter = NULL;
2160 result = InitializeScheduleResourceList();
2161 VERIFY_SUCCESS(result, OC_STACK_OK);
2163 result = CAResultToOCResult(CAInitialize());
2164 VERIFY_SUCCESS(result, OC_STACK_OK);
2166 result = CAResultToOCResult(OCSelectNetwork());
2167 VERIFY_SUCCESS(result, OC_STACK_OK);
2169 result = CAResultToOCResult(CARegisterNetworkMonitorHandler(
2170 OCDefaultAdapterStateChangedHandler, OCDefaultConnectionStateChangedHandler));
2171 VERIFY_SUCCESS(result, OC_STACK_OK);
2173 switch (myStackMode)
2176 CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2177 result = CAResultToOCResult(CAStartDiscoveryServer());
2178 OIC_LOG(INFO, TAG, "Client mode: CAStartDiscoveryServer");
2181 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2182 result = CAResultToOCResult(CAStartListeningServer());
2183 OIC_LOG(INFO, TAG, "Server mode: CAStartListeningServer");
2185 case OC_CLIENT_SERVER:
2187 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2188 result = CAResultToOCResult(CAStartListeningServer());
2189 if(result == OC_STACK_OK)
2191 result = CAResultToOCResult(CAStartDiscoveryServer());
2195 VERIFY_SUCCESS(result, OC_STACK_OK);
2198 CARegisterKeepAliveHandler(HandleKeepAliveConnCB);
2201 #ifdef WITH_PRESENCE
2202 PresenceTimeOutSize = sizeof (PresenceTimeOut) / sizeof (PresenceTimeOut[0]) - 1;
2203 #endif // WITH_PRESENCE
2205 //Update Stack state to initialized
2206 stackState = OC_STACK_INITIALIZED;
2208 // Initialize resource
2209 if(myStackMode != OC_CLIENT)
2211 result = initResources();
2214 // Initialize the SRM Policy Engine
2215 if(result == OC_STACK_OK)
2217 result = SRMInitPolicyEngine();
2218 // TODO after BeachHead delivery: consolidate into single SRMInit()
2220 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
2221 RMSetStackMode(mode);
2222 #ifdef ROUTING_GATEWAY
2223 if (OC_GATEWAY == myStackMode)
2225 result = RMInitialize();
2231 if (result == OC_STACK_OK)
2233 result = InitializeKeepAlive(myStackMode);
2238 if(result != OC_STACK_OK)
2240 OIC_LOG(ERROR, TAG, "Stack initialization error");
2241 deleteAllResources();
2243 TerminateScheduleResourceList();
2244 stackState = OC_STACK_UNINITIALIZED;
2249 OCStackResult OCStop()
2251 OIC_LOG(INFO, TAG, "Entering OCStop");
2253 if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
2255 OIC_LOG(DEBUG, TAG, "Stack already stopping, exiting");
2258 else if (stackState != OC_STACK_INITIALIZED)
2260 OIC_LOG(ERROR, TAG, "Stack not initialized");
2261 return OC_STACK_ERROR;
2264 stackState = OC_STACK_UNINIT_IN_PROGRESS;
2266 #ifdef WITH_PRESENCE
2267 // Ensure that the TTL associated with ANY and ALL presence notifications originating from
2268 // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
2269 presenceResource.presenceTTL = 0;
2270 #endif // WITH_PRESENCE
2272 #ifdef ROUTING_GATEWAY
2273 if (OC_GATEWAY == myStackMode)
2280 TerminateKeepAlive(myStackMode);
2283 // Free memory dynamically allocated for resources
2284 deleteAllResources();
2286 TerminateScheduleResourceList();
2287 // Remove all observers
2288 DeleteObserverList();
2289 // Remove all the client callbacks
2290 DeleteClientCBList();
2292 // De-init the SRM Policy Engine
2293 // TODO after BeachHead delivery: consolidate into single SRMDeInit()
2294 SRMDeInitPolicyEngine();
2297 stackState = OC_STACK_UNINITIALIZED;
2301 OCStackResult OCStartMulticastServer()
2303 if(stackState != OC_STACK_INITIALIZED)
2305 OIC_LOG(ERROR, TAG, "OCStack is not initalized. Cannot start multicast server.");
2306 return OC_STACK_ERROR;
2308 CAResult_t ret = CAStartListeningServer();
2309 if (CA_STATUS_OK != ret)
2311 OIC_LOG_V(ERROR, TAG, "Failed starting listening server: %d", ret);
2312 return OC_STACK_ERROR;
2317 OCStackResult OCStopMulticastServer()
2319 CAResult_t ret = CAStopListeningServer();
2320 if (CA_STATUS_OK != ret)
2322 OIC_LOG_V(ERROR, TAG, "Failed stopping listening server: %d", ret);
2323 return OC_STACK_ERROR;
2328 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
2333 return CA_MSG_CONFIRM;
2338 return CA_MSG_NONCONFIRM;
2343 * A request uri consists of the following components in order:
2346 * CoAP over UDP prefix "coap://"
2347 * CoAP over TCP prefix "coap+tcp://"
2348 * CoAP over DTLS prefix "coaps://"
2349 * CoAP over TLS prefix "coaps+tcp://"
2351 * IPv6 address "[1234::5678]"
2352 * IPv4 address "192.168.1.1"
2353 * optional port ":5683"
2354 * resource uri "/oc/core..."
2356 * for PRESENCE requests, extract resource type.
2358 static OCStackResult ParseRequestUri(const char *fullUri,
2359 OCTransportAdapter adapter,
2360 OCTransportFlags flags,
2361 OCDevAddr **devAddr,
2363 char **resourceType)
2365 VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
2367 OCStackResult result = OC_STACK_OK;
2368 OCDevAddr *da = NULL;
2372 // provide defaults for all returned values
2379 *resourceUri = NULL;
2383 *resourceType = NULL;
2386 // delimit url prefix, if any
2387 const char *start = fullUri;
2388 char *slash2 = strstr(start, "//");
2393 char *slash = strchr(start, '/');
2396 return OC_STACK_INVALID_URI;
2399 // process url scheme
2400 size_t prefixLen = slash2 - fullUri;
2404 if (((prefixLen == sizeof(COAP_TCP_SCHEME) - 1) && (!strncmp(fullUri, COAP_TCP_SCHEME, prefixLen)))
2405 || ((prefixLen == sizeof(COAPS_TCP_SCHEME) - 1) && (!strncmp(fullUri, COAPS_TCP_SCHEME, prefixLen))))
2411 // TODO: this logic should come in with unit tests exercising the various strings
2412 // processs url prefix, if any
2413 size_t urlLen = slash - start;
2417 if (urlLen && devAddr)
2418 { // construct OCDevAddr
2419 if (start[0] == '[')
2421 char *close = strchr(++start, ']');
2422 if (!close || close > slash)
2424 return OC_STACK_INVALID_URI;
2427 if (close[1] == ':')
2434 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2438 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2440 flags = (OCTransportFlags)(flags | OC_IP_USE_V6);
2444 char *dot = strchr(start, '.');
2445 if (dot && dot < slash)
2447 colon = strchr(start, ':');
2448 end = (colon && colon < slash) ? colon : slash;
2453 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2457 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2459 flags = (OCTransportFlags)(flags | OC_IP_USE_V4);
2467 if (len >= sizeof(da->addr))
2469 return OC_STACK_INVALID_URI;
2471 // collect port, if any
2472 if (colon && colon < slash)
2474 for (colon++; colon < slash; colon++)
2477 if (c < '0' || c > '9')
2479 return OC_STACK_INVALID_URI;
2481 port = 10 * port + c - '0';
2486 if (len >= sizeof(da->addr))
2488 return OC_STACK_INVALID_URI;
2491 da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
2494 return OC_STACK_NO_MEMORY;
2497 // Decode address per RFC 6874.
2498 result = OCDecodeAddressForRFC6874(da->addr, sizeof(da->addr), start, end);
2499 if (result != OC_STACK_OK)
2506 da->adapter = adapter;
2508 if (!strncmp(fullUri, "coaps", 5))
2510 da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
2515 // process resource uri, if any
2517 { // request uri and query
2518 size_t ulen = strlen(slash); // resource uri length
2519 size_t tlen = 0; // resource type length
2522 static const char strPresence[] = "/oic/ad?rt=";
2523 static const size_t lenPresence = sizeof(strPresence) - 1;
2524 if (!strncmp(slash, strPresence, lenPresence))
2526 type = slash + lenPresence;
2527 tlen = ulen - lenPresence;
2532 *resourceUri = (char *)OICMalloc(ulen + 1);
2535 result = OC_STACK_NO_MEMORY;
2538 strcpy(*resourceUri, slash);
2541 if (type && resourceType)
2543 *resourceType = (char *)OICMalloc(tlen + 1);
2546 result = OC_STACK_NO_MEMORY;
2550 OICStrcpy(*resourceType, (tlen+1), type);
2557 // free all returned values
2564 OICFree(*resourceUri);
2568 OICFree(*resourceType);
2573 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
2577 char uri[CA_MAX_URI_LENGTH];
2579 FormCanonicalPresenceUri(endpoint, uri, isMulticast);
2581 *requestUri = OICStrdup(uri);
2584 return OC_STACK_NO_MEMORY;
2591 * Discover or Perform requests on a specified resource
2593 OCStackResult OCDoResource(OCDoHandle *handle,
2595 const char *requestUri,
2596 const OCDevAddr *destination,
2598 OCConnectivityType connectivityType,
2599 OCQualityOfService qos,
2600 OCCallbackData *cbData,
2601 OCHeaderOption *options,
2604 OIC_LOG(INFO, TAG, "Entering OCDoResource");
2606 // Validate input parameters
2607 VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
2608 VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
2610 OCStackResult result = OC_STACK_ERROR;
2611 CAResult_t caResult;
2612 CAToken_t token = NULL;
2613 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2614 ClientCB *clientCB = NULL;
2615 OCDoHandle resHandle = NULL;
2616 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2617 OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
2619 OCTransportAdapter adapter;
2620 OCTransportFlags flags;
2621 // the request contents are put here
2622 CARequestInfo_t requestInfo = {.method = CA_GET};
2623 // requestUri will be parsed into the following three variables
2624 OCDevAddr *devAddr = NULL;
2625 char *resourceUri = NULL;
2626 char *resourceType = NULL;
2629 * Support original behavior with address on resourceUri argument.
2631 adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2632 flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2636 result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2637 if (result != OC_STACK_OK)
2639 OIC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2643 else if (!checkProxyUri(options, numOptions))
2645 OIC_LOG(ERROR, TAG, "Request doesn't contain RequestURI/Proxy URI");
2652 case OC_REST_OBSERVE:
2653 case OC_REST_OBSERVE_ALL:
2654 requestInfo.method = CA_GET;
2657 requestInfo.method = CA_PUT;
2660 requestInfo.method = CA_POST;
2662 case OC_REST_DELETE:
2663 requestInfo.method = CA_DELETE;
2665 case OC_REST_DISCOVER:
2667 #ifdef WITH_PRESENCE
2668 case OC_REST_PRESENCE:
2670 if (destination || devAddr)
2672 requestInfo.isMulticast = false;
2676 tmpDevAddr.adapter = adapter;
2677 tmpDevAddr.flags = flags;
2678 destination = &tmpDevAddr;
2679 requestInfo.isMulticast = true;
2681 // OC_REST_DISCOVER: CA_DISCOVER will become GET and isMulticast.
2682 // OC_REST_PRESENCE: Since "presence" is a stack layer only implementation.
2683 // replacing method type with GET.
2684 requestInfo.method = CA_GET;
2687 result = OC_STACK_INVALID_METHOD;
2691 if (!devAddr && !destination)
2693 OIC_LOG(DEBUG, TAG, "no devAddr and no destination");
2694 result = OC_STACK_INVALID_PARAM;
2698 /* If not original behavior, use destination argument */
2699 if (destination && !devAddr)
2701 devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2704 result = OC_STACK_NO_MEMORY;
2707 *devAddr = *destination;
2710 resHandle = GenerateInvocationHandle();
2713 result = OC_STACK_NO_MEMORY;
2717 caResult = CAGenerateToken(&token, tokenLength);
2718 if (caResult != CA_STATUS_OK)
2720 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2721 result= OC_STACK_ERROR;
2725 // fill in request data
2726 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2727 requestInfo.info.token = token;
2728 requestInfo.info.tokenLength = tokenLength;
2730 if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2732 result = CreateObserveHeaderOption (&(requestInfo.info.options),
2733 options, numOptions, OC_OBSERVE_REGISTER);
2734 if (result != OC_STACK_OK)
2738 requestInfo.info.numOptions = numOptions + 1;
2742 requestInfo.info.numOptions = numOptions;
2743 requestInfo.info.options =
2744 (CAHeaderOption_t*) OICCalloc(numOptions, sizeof(CAHeaderOption_t));
2745 memcpy(requestInfo.info.options, (CAHeaderOption_t*)options,
2746 numOptions * sizeof(CAHeaderOption_t));
2749 CopyDevAddrToEndpoint(devAddr, &endpoint);
2754 OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2757 OIC_LOG(ERROR, TAG, "Failed to create CBOR Payload");
2760 requestInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
2764 requestInfo.info.payload = NULL;
2765 requestInfo.info.payloadSize = 0;
2766 requestInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
2769 // prepare for response
2770 #ifdef WITH_PRESENCE
2771 if (method == OC_REST_PRESENCE)
2773 char *presenceUri = NULL;
2774 result = OCPreparePresence(&endpoint, &presenceUri,
2775 requestInfo.isMulticast);
2776 if (OC_STACK_OK != result)
2781 // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2782 // Presence notification will form a canonical uri to
2783 // look for callbacks into the application.
2786 OICFree(resourceUri);
2788 resourceUri = presenceUri;
2792 // update resourceUri onto requestInfo after check presence uri
2793 requestInfo.info.resourceUri = resourceUri;
2795 ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2796 result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2797 method, devAddr, resourceUri, resourceType, ttl);
2798 if (OC_STACK_OK != result)
2803 devAddr = NULL; // Client CB list entry now owns it
2804 resourceUri = NULL; // Client CB list entry now owns it
2805 resourceType = NULL; // Client CB list entry now owns it
2807 #ifdef WITH_PRESENCE
2808 if (method == OC_REST_PRESENCE)
2810 OIC_LOG(ERROR, TAG, "AddClientCB for presence done.");
2814 *handle = resHandle;
2822 result = OCSendRequest(&endpoint, &requestInfo);
2823 if (OC_STACK_OK != result)
2830 *handle = resHandle;
2834 if (result != OC_STACK_OK)
2836 OIC_LOG(ERROR, TAG, "OCDoResource error");
2837 FindAndDeleteClientCB(clientCB);
2838 CADestroyToken(token);
2846 // This is the owner of the payload object, so we free it
2847 OCPayloadDestroy(payload);
2848 OICFree(requestInfo.info.payload);
2850 OICFree(resourceUri);
2851 OICFree(resourceType);
2852 OICFree(requestInfo.info.options);
2856 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2860 * This ftn is implemented one of two ways in the case of observation:
2862 * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2863 * Remove the callback associated on client side.
2864 * When the next notification comes in from server,
2865 * reply with RESET message to server.
2866 * Keep in mind that the server will react to RESET only
2867 * if the last notification was sent as CON
2869 * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2870 * and it is associated with an observe request
2871 * (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2872 * Send CON Observe request to server with
2873 * observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2874 * Remove the callback associated on client side.
2876 OCStackResult ret = OC_STACK_OK;
2877 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2878 CARequestInfo_t requestInfo = {.method = CA_GET};
2882 return OC_STACK_INVALID_PARAM;
2885 ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2888 OIC_LOG(ERROR, TAG, "Callback not found. Called OCCancel on same resource twice?");
2889 return OC_STACK_ERROR;
2892 switch (clientCB->method)
2894 case OC_REST_OBSERVE:
2895 case OC_REST_OBSERVE_ALL:
2897 OIC_LOG_V(INFO, TAG, "Canceling observation for resource %s", clientCB->requestUri);
2899 CopyDevAddrToEndpoint(clientCB->devAddr, &endpoint);
2901 if ((endpoint.adapter & CA_ADAPTER_IP) && qos != OC_HIGH_QOS)
2903 FindAndDeleteClientCB(clientCB);
2907 OIC_LOG(INFO, TAG, "Cancelling observation as CONFIRMABLE");
2909 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2910 requestInfo.info.token = clientCB->token;
2911 requestInfo.info.tokenLength = clientCB->tokenLength;
2913 if (CreateObserveHeaderOption (&(requestInfo.info.options),
2914 options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2916 return OC_STACK_ERROR;
2918 requestInfo.info.numOptions = numOptions + 1;
2919 requestInfo.info.resourceUri = OICStrdup (clientCB->requestUri);
2922 ret = OCSendRequest(&endpoint, &requestInfo);
2924 if (requestInfo.info.options)
2926 OICFree (requestInfo.info.options);
2928 if (requestInfo.info.resourceUri)
2930 OICFree (requestInfo.info.resourceUri);
2935 case OC_REST_DISCOVER:
2936 OIC_LOG_V(INFO, TAG, "Cancelling discovery callback for resource %s",
2937 clientCB->requestUri);
2938 FindAndDeleteClientCB(clientCB);
2941 #ifdef WITH_PRESENCE
2942 case OC_REST_PRESENCE:
2943 FindAndDeleteClientCB(clientCB);
2948 ret = OC_STACK_INVALID_METHOD;
2956 * @brief Register Persistent storage callback.
2957 * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2959 * OC_STACK_OK - No errors; Success
2960 * OC_STACK_INVALID_PARAM - Invalid parameter
2962 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2964 OIC_LOG(INFO, TAG, "RegisterPersistentStorageHandler !!");
2965 if(!persistentStorageHandler)
2967 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2968 return OC_STACK_INVALID_PARAM;
2972 if( !persistentStorageHandler->open ||
2973 !persistentStorageHandler->close ||
2974 !persistentStorageHandler->read ||
2975 !persistentStorageHandler->unlink ||
2976 !persistentStorageHandler->write)
2978 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2979 return OC_STACK_INVALID_PARAM;
2982 return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2985 #ifdef WITH_PRESENCE
2987 OCStackResult OCProcessPresence()
2989 OCStackResult result = OC_STACK_OK;
2991 // the following line floods the log with messages that are irrelevant
2992 // to most purposes. Uncomment as needed.
2993 //OIC_LOG(INFO, TAG, "Entering RequestPresence");
2994 ClientCB* cbNode = NULL;
2995 OCClientResponse clientResponse;
2996 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2998 LL_FOREACH(cbList, cbNode)
3000 if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
3005 uint32_t now = GetTicks(0);
3006 OIC_LOG_V(DEBUG, TAG, "this TTL level %d",
3007 cbNode->presence->TTLlevel);
3008 OIC_LOG_V(DEBUG, TAG, "current ticks %d", now);
3010 if (cbNode->presence->TTLlevel > PresenceTimeOutSize)
3015 if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
3017 OIC_LOG_V(DEBUG, TAG, "timeout ticks %d",
3018 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
3020 if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
3022 OIC_LOG(DEBUG, TAG, "No more timeout ticks");
3024 clientResponse.sequenceNumber = 0;
3025 clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
3026 clientResponse.devAddr = *cbNode->devAddr;
3027 FixUpClientResponse(&clientResponse);
3028 clientResponse.payload = NULL;
3030 // Increment the TTLLevel (going to a next state), so we don't keep
3031 // sending presence notification to client.
3032 cbNode->presence->TTLlevel++;
3033 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
3034 cbNode->presence->TTLlevel);
3036 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
3037 if (cbResult == OC_STACK_DELETE_TRANSACTION)
3039 FindAndDeleteClientCB(cbNode);
3043 if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
3048 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
3049 CAInfo_t requestData = {.type = CA_MSG_CONFIRM};
3050 CARequestInfo_t requestInfo = {.method = CA_GET};
3052 OIC_LOG(DEBUG, TAG, "time to test server presence");
3054 CopyDevAddrToEndpoint(cbNode->devAddr, &endpoint);
3056 requestData.type = CA_MSG_NONCONFIRM;
3057 requestData.token = cbNode->token;
3058 requestData.tokenLength = cbNode->tokenLength;
3059 requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
3060 requestInfo.method = CA_GET;
3061 requestInfo.info = requestData;
3063 result = OCSendRequest(&endpoint, &requestInfo);
3064 if (OC_STACK_OK != result)
3069 cbNode->presence->TTLlevel++;
3070 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
3073 if (result != OC_STACK_OK)
3075 OIC_LOG(ERROR, TAG, "OCProcessPresence error");
3080 #endif // WITH_PRESENCE
3082 OCStackResult OCProcess()
3084 #ifdef WITH_PRESENCE
3085 OCProcessPresence();
3087 CAHandleRequestResponse();
3089 #ifdef ROUTING_GATEWAY
3099 #ifdef WITH_PRESENCE
3100 OCStackResult OCStartPresence(const uint32_t ttl)
3102 OIC_LOG(INFO, TAG, "Entering OCStartPresence");
3103 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
3104 OCChangeResourceProperty(
3105 &(((OCResource *)presenceResource.handle)->resourceProperties),
3108 if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
3110 presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
3111 OIC_LOG(INFO, TAG, "Setting Presence TTL to max value");
3115 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
3116 OIC_LOG(INFO, TAG, "Setting Presence TTL to default value");
3120 presenceResource.presenceTTL = ttl;
3122 OIC_LOG_V(DEBUG, TAG, "Presence TTL is %" PRIu32 " seconds", presenceResource.presenceTTL);
3124 if (OC_PRESENCE_UNINITIALIZED == presenceState)
3126 presenceState = OC_PRESENCE_INITIALIZED;
3128 OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
3130 CAToken_t caToken = NULL;
3131 CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
3132 if (caResult != CA_STATUS_OK)
3134 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
3135 CADestroyToken(caToken);
3136 return OC_STACK_ERROR;
3139 AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
3140 (OCResource *)presenceResource.handle, OC_LOW_QOS, OC_FORMAT_UNDEFINED, &devAddr);
3141 CADestroyToken(caToken);
3144 // Each time OCStartPresence is called
3145 // a different random 32-bit integer number is used
3146 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3148 return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
3149 OC_PRESENCE_TRIGGER_CREATE);
3152 OCStackResult OCStopPresence()
3154 OIC_LOG(INFO, TAG, "Entering OCStopPresence");
3155 OCStackResult result = OC_STACK_ERROR;
3157 if(presenceResource.handle)
3159 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3161 // make resource inactive
3162 result = OCChangeResourceProperty(
3163 &(((OCResource *) presenceResource.handle)->resourceProperties),
3167 if(result != OC_STACK_OK)
3170 "Changing the presence resource properties to ACTIVE not successful");
3174 return SendStopNotification();
3178 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
3179 void* callbackParameter)
3181 defaultDeviceHandler = entityHandler;
3182 defaultDeviceHandlerCallbackParameter = callbackParameter;
3187 OCStackResult OCCreateResource(OCResourceHandle *handle,
3188 const char *resourceTypeName,
3189 const char *resourceInterfaceName,
3190 const char *uri, OCEntityHandler entityHandler,
3191 void* callbackParam,
3192 uint8_t resourceProperties)
3195 OCResource *pointer = NULL;
3196 OCStackResult result = OC_STACK_ERROR;
3198 OIC_LOG(INFO, TAG, "Entering OCCreateResource");
3200 if(myStackMode == OC_CLIENT)
3202 return OC_STACK_INVALID_PARAM;
3204 // Validate parameters
3205 if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
3207 OIC_LOG(ERROR, TAG, "URI is empty or too long");
3208 return OC_STACK_INVALID_URI;
3210 // Is it presented during resource discovery?
3211 if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
3213 OIC_LOG(ERROR, TAG, "Input parameter is NULL");
3214 return OC_STACK_INVALID_PARAM;
3217 if (!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
3219 resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
3223 resourceProperties = resourceProperties | OC_MQ_PUBLISHER;
3225 // Make sure resourceProperties bitmask has allowed properties specified
3226 if (resourceProperties
3227 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
3228 OC_EXPLICIT_DISCOVERABLE
3237 OIC_LOG(ERROR, TAG, "Invalid property");
3238 return OC_STACK_INVALID_PARAM;
3241 // If the headResource is NULL, then no resources have been created...
3242 pointer = headResource;
3245 // At least one resources is in the resource list, so we need to search for
3246 // repeated URLs, which are not allowed. If a repeat is found, exit with an error
3249 if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
3251 OIC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
3252 return OC_STACK_INVALID_PARAM;
3254 pointer = pointer->next;
3257 // Create the pointer and insert it into the resource list
3258 pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
3261 result = OC_STACK_NO_MEMORY;
3264 pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
3266 insertResource(pointer);
3269 pointer->uri = OICStrdup(uri);
3272 result = OC_STACK_NO_MEMORY;
3276 // Set properties. Set OC_ACTIVE
3277 pointer->resourceProperties = (OCResourceProperty) (resourceProperties
3280 // Add the resourcetype to the resource
3281 result = BindResourceTypeToResource(pointer, resourceTypeName);
3282 if (result != OC_STACK_OK)
3284 OIC_LOG(ERROR, TAG, "Error adding resourcetype");
3288 // Add the resourceinterface to the resource
3289 result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
3290 if (result != OC_STACK_OK)
3292 OIC_LOG(ERROR, TAG, "Error adding resourceinterface");
3296 // If an entity handler has been passed, attach it to the newly created
3297 // resource. Otherwise, set the default entity handler.
3300 pointer->entityHandler = entityHandler;
3301 pointer->entityHandlerCallbackParam = callbackParam;
3305 pointer->entityHandler = defaultResourceEHandler;
3306 pointer->entityHandlerCallbackParam = NULL;
3309 // Initialize a pointer indicating child resources in case of collection
3310 pointer->rsrcChildResourcesHead = NULL;
3313 result = OC_STACK_OK;
3315 #ifdef WITH_PRESENCE
3316 if (presenceResource.handle)
3318 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3319 SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
3323 if (result != OC_STACK_OK)
3325 // Deep delete of resource and other dynamic elements that it contains
3326 deleteResource(pointer);
3331 OCStackResult OCBindResource(
3332 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3334 OCResource *resource = NULL;
3335 OCChildResource *tempChildResource = NULL;
3336 OCChildResource *newChildResource = NULL;
3338 OIC_LOG(INFO, TAG, "Entering OCBindResource");
3340 // Validate parameters
3341 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3342 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3343 // Container cannot contain itself
3344 if (collectionHandle == resourceHandle)
3346 OIC_LOG(ERROR, TAG, "Added handle equals collection handle");
3347 return OC_STACK_INVALID_PARAM;
3350 // Use the handle to find the resource in the resource linked list
3351 resource = findResource((OCResource *) collectionHandle);
3354 OIC_LOG(ERROR, TAG, "Collection handle not found");
3355 return OC_STACK_INVALID_PARAM;
3358 // Look for an open slot to add add the child resource.
3359 // If found, add it and return success
3361 tempChildResource = resource->rsrcChildResourcesHead;
3363 while(resource->rsrcChildResourcesHead && tempChildResource->next)
3365 // TODO: what if one of child resource was deregistered without unbinding?
3366 tempChildResource = tempChildResource->next;
3369 // Do memory allocation for child resource
3370 newChildResource = (OCChildResource *) OICCalloc(1, sizeof(OCChildResource));
3371 if(!newChildResource)
3373 OIC_LOG(ERROR, TAG, "Adding new child resource is failed due to memory allocation failure");
3374 return OC_STACK_ERROR;
3377 newChildResource->rsrcResource = (OCResource *) resourceHandle;
3378 newChildResource->next = NULL;
3380 if(!resource->rsrcChildResourcesHead)
3382 resource->rsrcChildResourcesHead = newChildResource;
3385 tempChildResource->next = newChildResource;
3388 OIC_LOG(INFO, TAG, "resource bound");
3390 #ifdef WITH_PRESENCE
3391 if (presenceResource.handle)
3393 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3394 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3395 OC_PRESENCE_TRIGGER_CHANGE);
3402 OCStackResult OCUnBindResource(
3403 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3405 OCResource *resource = NULL;
3406 OCChildResource *tempChildResource = NULL;
3407 OCChildResource *tempLastChildResource = NULL;
3409 OIC_LOG(INFO, TAG, "Entering OCUnBindResource");
3411 // Validate parameters
3412 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3413 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3414 // Container cannot contain itself
3415 if (collectionHandle == resourceHandle)
3417 OIC_LOG(ERROR, TAG, "removing handle equals collection handle");
3418 return OC_STACK_INVALID_PARAM;
3421 // Use the handle to find the resource in the resource linked list
3422 resource = findResource((OCResource *) collectionHandle);
3425 OIC_LOG(ERROR, TAG, "Collection handle not found");
3426 return OC_STACK_INVALID_PARAM;
3429 // Look for an open slot to add add the child resource.
3430 // If found, add it and return success
3431 if(!resource->rsrcChildResourcesHead)
3433 OIC_LOG(INFO, TAG, "resource not found in collection");
3435 // Unable to add resourceHandle, so return error
3436 return OC_STACK_ERROR;
3440 tempChildResource = resource->rsrcChildResourcesHead;
3442 while (tempChildResource)
3444 if(tempChildResource->rsrcResource == resourceHandle)
3446 // if resource going to be unbinded is the head one.
3447 if( tempChildResource == resource->rsrcChildResourcesHead )
3449 OCChildResource *temp = resource->rsrcChildResourcesHead->next;
3450 OICFree(resource->rsrcChildResourcesHead);
3451 resource->rsrcChildResourcesHead = temp;
3456 OCChildResource *temp = tempChildResource->next;
3457 OICFree(tempChildResource);
3458 tempLastChildResource->next = temp;
3462 OIC_LOG(INFO, TAG, "resource unbound");
3464 // Send notification when resource is unbounded successfully.
3465 #ifdef WITH_PRESENCE
3466 if (presenceResource.handle)
3468 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3469 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3470 OC_PRESENCE_TRIGGER_CHANGE);
3473 tempChildResource = NULL;
3474 tempLastChildResource = NULL;
3480 tempLastChildResource = tempChildResource;
3481 tempChildResource = tempChildResource->next;
3484 OIC_LOG(INFO, TAG, "resource not found in collection");
3486 tempChildResource = NULL;
3487 tempLastChildResource = NULL;
3489 // Unable to add resourceHandle, so return error
3490 return OC_STACK_ERROR;
3493 static bool ValidateResourceTypeInterface(const char *resourceItemName)
3495 if (!resourceItemName)
3499 // Per RFC 6690 only registered values must follow the first rule below.
3500 // At this point in time the only values registered begin with "core", and
3501 // all other values are specified as opaque strings where multiple values
3502 // are separated by a space.
3503 if (strncmp(resourceItemName, CORESPEC, sizeof(CORESPEC) - 1) == 0)
3505 for(size_t index = sizeof(CORESPEC) - 1; resourceItemName[index]; ++index)
3507 if (resourceItemName[index] != '.'
3508 && resourceItemName[index] != '-'
3509 && (resourceItemName[index] < 'a' || resourceItemName[index] > 'z')
3510 && (resourceItemName[index] < '0' || resourceItemName[index] > '9'))
3518 for (size_t index = 0; resourceItemName[index]; ++index)
3520 if (resourceItemName[index] == ' '
3521 || resourceItemName[index] == '\t'
3522 || resourceItemName[index] == '\r'
3523 || resourceItemName[index] == '\n')
3533 OCStackResult BindResourceTypeToResource(OCResource* resource,
3534 const char *resourceTypeName)
3536 OCResourceType *pointer = NULL;
3538 OCStackResult result = OC_STACK_ERROR;
3540 VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
3542 if (!ValidateResourceTypeInterface(resourceTypeName))
3544 OIC_LOG(ERROR, TAG, "resource type illegal (see RFC 6690)");
3545 return OC_STACK_INVALID_PARAM;
3548 pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
3551 result = OC_STACK_NO_MEMORY;
3555 str = OICStrdup(resourceTypeName);
3558 result = OC_STACK_NO_MEMORY;
3561 pointer->resourcetypename = str;
3562 pointer->next = NULL;
3564 insertResourceType(resource, pointer);
3565 result = OC_STACK_OK;
3568 if (result != OC_STACK_OK)
3577 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
3578 const char *resourceInterfaceName)
3580 OCResourceInterface *pointer = NULL;
3582 OCStackResult result = OC_STACK_ERROR;
3584 VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
3586 if (!ValidateResourceTypeInterface(resourceInterfaceName))
3588 OIC_LOG(ERROR, TAG, "resource /interface illegal (see RFC 6690)");
3589 return OC_STACK_INVALID_PARAM;
3592 OIC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
3594 pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
3597 result = OC_STACK_NO_MEMORY;
3601 str = OICStrdup(resourceInterfaceName);
3604 result = OC_STACK_NO_MEMORY;
3607 pointer->name = str;
3609 // Bind the resourceinterface to the resource
3610 insertResourceInterface(resource, pointer);
3612 result = OC_STACK_OK;
3615 if (result != OC_STACK_OK)
3624 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
3625 const char *resourceTypeName)
3628 OCStackResult result = OC_STACK_ERROR;
3629 OCResource *resource = NULL;
3631 resource = findResource((OCResource *) handle);
3634 OIC_LOG(ERROR, TAG, "Resource not found");
3635 return OC_STACK_ERROR;
3638 result = BindResourceTypeToResource(resource, resourceTypeName);
3640 #ifdef WITH_PRESENCE
3641 if(presenceResource.handle)
3643 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3644 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3651 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
3652 const char *resourceInterfaceName)
3655 OCStackResult result = OC_STACK_ERROR;
3656 OCResource *resource = NULL;
3658 resource = findResource((OCResource *) handle);
3661 OIC_LOG(ERROR, TAG, "Resource not found");
3662 return OC_STACK_ERROR;
3665 result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
3667 #ifdef WITH_PRESENCE
3668 if (presenceResource.handle)
3670 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3671 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3678 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
3680 OCResource *pointer = headResource;
3682 VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
3686 *numResources = *numResources + 1;
3687 pointer = pointer->next;
3692 OCResourceHandle OCGetResourceHandle(uint8_t index)
3694 OCResource *pointer = headResource;
3696 for( uint8_t i = 0; i < index && pointer; ++i)
3698 pointer = pointer->next;
3700 return (OCResourceHandle) pointer;
3703 OCStackResult OCDeleteResource(OCResourceHandle handle)
3707 OIC_LOG(ERROR, TAG, "Invalid handle for deletion");
3708 return OC_STACK_INVALID_PARAM;
3711 OCResource *resource = findResource((OCResource *) handle);
3712 if (resource == NULL)
3714 OIC_LOG(ERROR, TAG, "Resource not found");
3715 return OC_STACK_NO_RESOURCE;
3718 if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3720 OIC_LOG(ERROR, TAG, "Error deleting resource");
3721 return OC_STACK_ERROR;
3727 const char *OCGetResourceUri(OCResourceHandle handle)
3729 OCResource *resource = NULL;
3731 resource = findResource((OCResource *) handle);
3734 return resource->uri;
3736 return (const char *) NULL;
3739 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3741 OCResource *resource = NULL;
3743 resource = findResource((OCResource *) handle);
3746 return resource->resourceProperties;
3748 return (OCResourceProperty)-1;
3751 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3752 uint8_t *numResourceTypes)
3754 OCResource *resource = NULL;
3755 OCResourceType *pointer = NULL;
3757 VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3758 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3760 *numResourceTypes = 0;
3762 resource = findResource((OCResource *) handle);
3765 pointer = resource->rsrcType;
3768 *numResourceTypes = *numResourceTypes + 1;
3769 pointer = pointer->next;
3775 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3777 OCResourceType *resourceType = NULL;
3779 resourceType = findResourceTypeAtIndex(handle, index);
3782 return resourceType->resourcetypename;
3784 return (const char *) NULL;
3787 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3788 uint8_t *numResourceInterfaces)
3790 OCResourceInterface *pointer = NULL;
3791 OCResource *resource = NULL;
3793 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3794 VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3796 *numResourceInterfaces = 0;
3797 resource = findResource((OCResource *) handle);
3800 pointer = resource->rsrcInterface;
3803 *numResourceInterfaces = *numResourceInterfaces + 1;
3804 pointer = pointer->next;
3810 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3812 OCResourceInterface *resourceInterface = NULL;
3814 resourceInterface = findResourceInterfaceAtIndex(handle, index);
3815 if (resourceInterface)
3817 return resourceInterface->name;
3819 return (const char *) NULL;
3822 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3825 OCResource *resource = NULL;
3826 OCChildResource *tempChildResource = NULL;
3829 resource = findResource((OCResource *) collectionHandle);
3835 tempChildResource = resource->rsrcChildResourcesHead;
3837 while(tempChildResource)
3841 return tempChildResource->rsrcResource;
3844 tempChildResource = tempChildResource->next;
3847 // In this case, the number of resource handles in the collection exceeds the index
3848 tempChildResource = NULL;
3852 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3853 OCEntityHandler entityHandler,
3854 void* callbackParam)
3856 OCResource *resource = NULL;
3858 // Validate parameters
3859 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3861 // Use the handle to find the resource in the resource linked list
3862 resource = findResource((OCResource *)handle);
3865 OIC_LOG(ERROR, TAG, "Resource not found");
3866 return OC_STACK_ERROR;
3870 resource->entityHandler = entityHandler;
3871 resource->entityHandlerCallbackParam = callbackParam;
3873 #ifdef WITH_PRESENCE
3874 if (presenceResource.handle)
3876 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3877 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3884 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3886 OCResource *resource = NULL;
3888 resource = findResource((OCResource *)handle);
3891 OIC_LOG(ERROR, TAG, "Resource not found");
3896 return resource->entityHandler;
3899 void incrementSequenceNumber(OCResource * resPtr)
3901 // Increment the sequence number
3902 resPtr->sequenceNum += 1;
3903 if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3905 resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3910 #ifdef WITH_PRESENCE
3911 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3912 OCPresenceTrigger trigger)
3914 OIC_LOG(INFO, TAG, "SendPresenceNotification");
3915 OCResource *resPtr = NULL;
3916 OCStackResult result = OC_STACK_ERROR;
3917 OCMethod method = OC_REST_PRESENCE;
3918 uint32_t maxAge = 0;
3919 resPtr = findResource((OCResource *) presenceResource.handle);
3922 return OC_STACK_NO_RESOURCE;
3925 if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3927 maxAge = presenceResource.presenceTTL;
3929 result = SendAllObserverNotification(method, resPtr, maxAge,
3930 trigger, resourceType, OC_LOW_QOS);
3936 OCStackResult SendStopNotification()
3938 OIC_LOG(INFO, TAG, "SendStopNotification");
3939 OCResource *resPtr = NULL;
3940 OCStackResult result = OC_STACK_ERROR;
3941 OCMethod method = OC_REST_PRESENCE;
3942 resPtr = findResource((OCResource *) presenceResource.handle);
3945 return OC_STACK_NO_RESOURCE;
3948 // maxAge is 0. ResourceType is NULL.
3949 result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3955 #endif // WITH_PRESENCE
3956 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3958 OCResource *resPtr = NULL;
3959 OCStackResult result = OC_STACK_ERROR;
3960 OCMethod method = OC_REST_NOMETHOD;
3961 uint32_t maxAge = 0;
3963 OIC_LOG(INFO, TAG, "Notifying all observers");
3964 #ifdef WITH_PRESENCE
3965 if(handle == presenceResource.handle)
3969 #endif // WITH_PRESENCE
3970 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3972 // Verify that the resource exists
3973 resPtr = findResource ((OCResource *) handle);
3976 return OC_STACK_NO_RESOURCE;
3980 //only increment in the case of regular observing (not presence)
3981 incrementSequenceNumber(resPtr);
3982 method = OC_REST_OBSERVE;
3983 maxAge = MAX_OBSERVE_AGE;
3984 #ifdef WITH_PRESENCE
3985 result = SendAllObserverNotification (method, resPtr, maxAge,
3986 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3988 result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3995 OCNotifyListOfObservers (OCResourceHandle handle,
3996 OCObservationId *obsIdList,
3997 uint8_t numberOfIds,
3998 const OCRepPayload *payload,
3999 OCQualityOfService qos)
4001 OIC_LOG(INFO, TAG, "Entering OCNotifyListOfObservers");
4003 OCResource *resPtr = NULL;
4004 //TODO: we should allow the server to define this
4005 uint32_t maxAge = MAX_OBSERVE_AGE;
4007 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
4008 VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
4009 VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
4011 resPtr = findResource ((OCResource *) handle);
4012 if (NULL == resPtr || myStackMode == OC_CLIENT)
4014 return OC_STACK_NO_RESOURCE;
4018 incrementSequenceNumber(resPtr);
4020 return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
4021 payload, maxAge, qos));
4024 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
4026 OCStackResult result = OC_STACK_ERROR;
4027 OCServerRequest *serverRequest = NULL;
4029 OIC_LOG(INFO, TAG, "Entering OCDoResponse");
4031 // Validate input parameters
4032 VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
4033 VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
4036 // Get pointer to request info
4037 serverRequest = GetServerRequestUsingHandle(ehResponse->requestHandle);
4040 // response handler in ocserverrequest.c. Usually HandleSingleResponse.
4041 result = serverRequest->ehResponseHandler(ehResponse);
4047 //#ifdef DIRECT_PAIRING
4048 const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime)
4050 OIC_LOG(INFO, TAG, "Start OCDiscoverDirectPairingDevices");
4051 if(OC_STACK_OK != DPDeviceDiscovery(waittime))
4053 OIC_LOG(ERROR, TAG, "Fail to discover Direct-Pairing device");
4057 return (const OCDPDev_t*)DPGetDiscoveredDevices();
4060 const OCDPDev_t* OCGetDirectPairedDevices()
4062 return (const OCDPDev_t*)DPGetPairedDevices();
4065 OCStackResult OCDoDirectPairing(void *ctx, OCDPDev_t* peer, OCPrm_t pmSel, char *pinNumber,
4066 OCDirectPairingCB resultCallback)
4068 OIC_LOG(INFO, TAG, "Start OCDoDirectPairing");
4069 if(NULL == peer || NULL == pinNumber)
4071 OIC_LOG(ERROR, TAG, "Invalid parameters");
4072 return OC_STACK_INVALID_PARAM;
4074 if (NULL == resultCallback)
4076 OIC_LOG(ERROR, TAG, "Invalid callback");
4077 return OC_STACK_INVALID_CALLBACK;
4080 return DPDirectPairing(ctx, (OCDirectPairingDev_t*)peer, (OicSecPrm_t)pmSel,
4081 pinNumber, (OCDirectPairingResultCB)resultCallback);
4083 //#endif // DIRECT_PAIRING
4085 //-----------------------------------------------------------------------------
4086 // Private internal function definitions
4087 //-----------------------------------------------------------------------------
4088 static OCDoHandle GenerateInvocationHandle()
4090 OCDoHandle handle = NULL;
4091 // Generate token here, it will be deleted when the transaction is deleted
4092 handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
4095 OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
4101 #ifdef WITH_PRESENCE
4102 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
4103 OCResourceProperty resourceProperties, uint8_t enable)
4107 return OC_STACK_INVALID_PARAM;
4109 if (resourceProperties
4110 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
4112 OIC_LOG(ERROR, TAG, "Invalid property");
4113 return OC_STACK_INVALID_PARAM;
4117 *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
4121 *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
4127 OCStackResult initResources()
4129 OCStackResult result = OC_STACK_OK;
4131 headResource = NULL;
4132 tailResource = NULL;
4133 // Init Virtual Resources
4134 #ifdef WITH_PRESENCE
4135 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
4137 result = OCCreateResource(&presenceResource.handle,
4138 OC_RSRVD_RESOURCE_TYPE_PRESENCE,
4140 OC_RSRVD_PRESENCE_URI,
4144 //make resource inactive
4145 result = OCChangeResourceProperty(
4146 &(((OCResource *) presenceResource.handle)->resourceProperties),
4149 #ifndef WITH_ARDUINO
4150 if (result == OC_STACK_OK)
4152 result = SRMInitSecureResources();
4156 if(result == OC_STACK_OK)
4158 CreateResetProfile();
4159 result = OCCreateResource(&deviceResource,
4160 OC_RSRVD_RESOURCE_TYPE_DEVICE,
4161 OC_RSRVD_INTERFACE_DEFAULT,
4162 OC_RSRVD_DEVICE_URI,
4166 if(result == OC_STACK_OK)
4168 result = BindResourceInterfaceToResource((OCResource *)deviceResource,
4169 OC_RSRVD_INTERFACE_READ);
4173 if(result == OC_STACK_OK)
4175 result = OCCreateResource(&platformResource,
4176 OC_RSRVD_RESOURCE_TYPE_PLATFORM,
4177 OC_RSRVD_INTERFACE_DEFAULT,
4178 OC_RSRVD_PLATFORM_URI,
4182 if(result == OC_STACK_OK)
4184 result = BindResourceInterfaceToResource((OCResource *)platformResource,
4185 OC_RSRVD_INTERFACE_READ);
4192 void insertResource(OCResource *resource)
4196 headResource = resource;
4197 tailResource = resource;
4201 tailResource->next = resource;
4202 tailResource = resource;
4204 resource->next = NULL;
4207 OCResource *findResource(OCResource *resource)
4209 OCResource *pointer = headResource;
4213 if (pointer == resource)
4217 pointer = pointer->next;
4222 void deleteAllResources()
4224 OCResource *pointer = headResource;
4225 OCResource *temp = NULL;
4229 temp = pointer->next;
4230 #ifdef WITH_PRESENCE
4231 if (pointer != (OCResource *) presenceResource.handle)
4233 #endif // WITH_PRESENCE
4234 deleteResource(pointer);
4235 #ifdef WITH_PRESENCE
4237 #endif // WITH_PRESENCE
4240 memset(&platformResource, 0, sizeof(platformResource));
4241 memset(&deviceResource, 0, sizeof(deviceResource));
4243 memset(&brokerResource, 0, sizeof(brokerResource));
4246 SRMDeInitSecureResources();
4248 #ifdef WITH_PRESENCE
4249 // Ensure that the last resource to be deleted is the presence resource. This allows for all
4250 // presence notification attributed to their deletion to be processed.
4251 deleteResource((OCResource *) presenceResource.handle);
4252 memset(&presenceResource, 0, sizeof(presenceResource));
4253 #endif // WITH_PRESENCE
4256 OCStackResult deleteResource(OCResource *resource)
4258 OCResource *prev = NULL;
4259 OCResource *temp = NULL;
4262 OIC_LOG(DEBUG,TAG,"resource is NULL");
4263 return OC_STACK_INVALID_PARAM;
4266 OIC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
4268 temp = headResource;
4271 if (temp == resource)
4273 // Invalidate all Resource Properties.
4274 resource->resourceProperties = (OCResourceProperty) 0;
4275 #ifdef WITH_PRESENCE
4276 if(resource != (OCResource *) presenceResource.handle)
4278 #endif // WITH_PRESENCE
4279 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
4280 #ifdef WITH_PRESENCE
4283 if(presenceResource.handle)
4285 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
4286 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
4289 // Only resource in list.
4290 if (temp == headResource && temp == tailResource)
4292 headResource = NULL;
4293 tailResource = NULL;
4296 else if (temp == headResource)
4298 headResource = temp->next;
4301 else if (temp == tailResource)
4303 tailResource = prev;
4304 tailResource->next = NULL;
4308 prev->next = temp->next;
4311 deleteResourceElements(temp);
4322 return OC_STACK_ERROR;
4325 void deleteResourceElements(OCResource *resource)
4332 OICFree(resource->uri);
4333 deleteResourceType(resource->rsrcType);
4334 deleteResourceInterface(resource->rsrcInterface);
4335 OCDeleteResourceAttributes(resource->rsrcAttributes);
4338 void deleteResourceType(OCResourceType *resourceType)
4340 OCResourceType *pointer = resourceType;
4341 OCResourceType *next = NULL;
4345 next = pointer->next;
4346 OICFree(pointer->resourcetypename);
4352 void deleteResourceInterface(OCResourceInterface *resourceInterface)
4354 OCResourceInterface *pointer = resourceInterface;
4355 OCResourceInterface *next = NULL;
4359 next = pointer->next;
4360 OICFree(pointer->name);
4366 void OCDeleteResourceAttributes(OCAttribute *rsrcAttributes)
4368 OCAttribute *next = NULL;
4369 for (OCAttribute *pointer = rsrcAttributes; pointer; pointer = next)
4371 next = pointer->next;
4372 if (pointer->attrName && 0 == strcmp(OC_RSRVD_DATA_MODEL_VERSION, pointer->attrName))
4374 OCFreeOCStringLL((OCStringLL *)pointer->attrValue);
4378 OICFree(pointer->attrValue);
4380 OICFree(pointer->attrName);
4385 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
4387 OCResourceType *pointer = NULL;
4388 OCResourceType *previous = NULL;
4389 if (!resource || !resourceType)
4393 // resource type list is empty.
4394 else if (!resource->rsrcType)
4396 resource->rsrcType = resourceType;
4400 pointer = resource->rsrcType;
4404 if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
4406 OIC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
4407 OICFree(resourceType->resourcetypename);
4408 OICFree(resourceType);
4412 pointer = pointer->next;
4417 previous->next = resourceType;
4420 resourceType->next = NULL;
4422 OIC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
4425 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
4427 OCResource *resource = NULL;
4428 OCResourceType *pointer = NULL;
4430 // Find the specified resource
4431 resource = findResource((OCResource *) handle);
4437 // Make sure a resource has a resourcetype
4438 if (!resource->rsrcType)
4443 // Iterate through the list
4444 pointer = resource->rsrcType;
4445 for(uint8_t i = 0; i< index && pointer; ++i)
4447 pointer = pointer->next;
4452 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
4454 if(resourceTypeList && resourceTypeName)
4456 OCResourceType * rtPointer = resourceTypeList;
4457 while(resourceTypeName && rtPointer)
4459 OIC_LOG_V(DEBUG, TAG, "current resourceType : %s", rtPointer->resourcetypename);
4460 if(rtPointer->resourcetypename &&
4461 strcmp(resourceTypeName, (const char *)
4462 (rtPointer->resourcetypename)) == 0)
4466 rtPointer = rtPointer->next;
4474 * Insert a new interface into interface linked list only if not already present.
4475 * If alredy present, 2nd arg is free'd.
4476 * Default interface will always be first if present.
4478 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
4480 OCResourceInterface *pointer = NULL;
4481 OCResourceInterface *previous = NULL;
4483 newInterface->next = NULL;
4485 OCResourceInterface **firstInterface = &(resource->rsrcInterface);
4487 if (!*firstInterface)
4489 // If first interface is not oic.if.baseline, by default add it as first interface type.
4490 if (0 == strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT))
4492 *firstInterface = newInterface;
4496 OCStackResult result = BindResourceInterfaceToResource(resource,
4497 OC_RSRVD_INTERFACE_DEFAULT);
4498 if (result != OC_STACK_OK)
4500 OICFree(newInterface->name);
4501 OICFree(newInterface);
4504 if (*firstInterface)
4506 (*firstInterface)->next = newInterface;
4510 // If once add oic.if.baseline, later too below code take care of freeing memory.
4511 else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4513 if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4515 OICFree(newInterface->name);
4516 OICFree(newInterface);
4519 // This code will not hit anymore, keeping
4522 newInterface->next = *firstInterface;
4523 *firstInterface = newInterface;
4528 pointer = *firstInterface;
4531 if (strcmp(newInterface->name, pointer->name) == 0)
4533 OICFree(newInterface->name);
4534 OICFree(newInterface);
4538 pointer = pointer->next;
4543 previous->next = newInterface;
4548 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
4551 OCResource *resource = NULL;
4552 OCResourceInterface *pointer = NULL;
4554 // Find the specified resource
4555 resource = findResource((OCResource *) handle);
4561 // Make sure a resource has a resourceinterface
4562 if (!resource->rsrcInterface)
4567 // Iterate through the list
4568 pointer = resource->rsrcInterface;
4570 for (uint8_t i = 0; i < index && pointer; ++i)
4572 pointer = pointer->next;
4578 * This function splits the uri using the '?' delimiter.
4579 * "uriWithoutQuery" is the block of characters between the beginning
4580 * till the delimiter or '\0' which ever comes first.
4581 * "query" is whatever is to the right of the delimiter if present.
4582 * No delimiter sets the query to NULL.
4583 * If either are present, they will be malloc'ed into the params 2, 3.
4584 * The first param, *uri is left untouched.
4586 * NOTE: This function does not account for whitespace at the end of the uri NOR
4587 * malformed uri's with '??'. Whitespace at the end will be assumed to be
4588 * part of the query.
4590 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
4594 return OC_STACK_INVALID_URI;
4596 if(!query || !uriWithoutQuery)
4598 return OC_STACK_INVALID_PARAM;
4602 *uriWithoutQuery = NULL;
4604 size_t uriWithoutQueryLen = 0;
4605 size_t queryLen = 0;
4606 size_t uriLen = strlen(uri);
4608 char *pointerToDelimiter = strstr(uri, "?");
4610 uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : (size_t)(pointerToDelimiter - uri);
4611 queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
4613 if (uriWithoutQueryLen)
4615 *uriWithoutQuery = (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
4616 if (!*uriWithoutQuery)
4620 OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
4624 *query = (char *) OICCalloc(queryLen + 1, 1);
4627 OICFree(*uriWithoutQuery);
4628 *uriWithoutQuery = NULL;
4631 OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
4637 return OC_STACK_NO_MEMORY;
4640 static const OicUuid_t* OCGetServerInstanceID(void)
4642 static bool generated = false;
4643 static OicUuid_t sid;
4649 if (OC_STACK_OK != GetDoxmDeviceID(&sid))
4651 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
4658 const char* OCGetServerInstanceIDString(void)
4660 static bool generated = false;
4661 static char sidStr[UUID_STRING_SIZE];
4668 const OicUuid_t *sid = OCGetServerInstanceID();
4669 if (sid && OCConvertUuidToString(sid->id, sidStr) != RAND_UUID_OK)
4671 OIC_LOG(FATAL, TAG, "Generate UUID String for Server Instance failed!");
4679 CAResult_t OCSelectNetwork()
4681 CAResult_t retResult = CA_STATUS_FAILED;
4682 CAResult_t caResult = CA_STATUS_OK;
4684 CATransportAdapter_t connTypes[] = {
4686 CA_ADAPTER_RFCOMM_BTEDR,
4687 CA_ADAPTER_GATT_BTLE,
4690 ,CA_ADAPTER_REMOTE_ACCESS
4697 int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
4699 for(int i = 0; i < numConnTypes; i++)
4701 // If CA status is not initialized, CASelectNetwork() will not be called.
4702 if (caResult != CA_STATUS_NOT_INITIALIZED)
4704 caResult = CASelectNetwork(connTypes[i]);
4705 if (caResult == CA_STATUS_OK)
4707 retResult = CA_STATUS_OK;
4712 if (retResult != CA_STATUS_OK)
4714 return caResult; // Returns error of appropriate transport that failed fatally.
4720 OCStackResult CAResultToOCResult(CAResult_t caResult)
4726 case CA_STATUS_INVALID_PARAM:
4727 return OC_STACK_INVALID_PARAM;
4728 case CA_ADAPTER_NOT_ENABLED:
4729 return OC_STACK_ADAPTER_NOT_ENABLED;
4730 case CA_SERVER_STARTED_ALREADY:
4732 case CA_SERVER_NOT_STARTED:
4733 return OC_STACK_ERROR;
4734 case CA_DESTINATION_NOT_REACHABLE:
4735 return OC_STACK_COMM_ERROR;
4736 case CA_SOCKET_OPERATION_FAILED:
4737 return OC_STACK_COMM_ERROR;
4738 case CA_SEND_FAILED:
4739 return OC_STACK_COMM_ERROR;
4740 case CA_RECEIVE_FAILED:
4741 return OC_STACK_COMM_ERROR;
4742 case CA_MEMORY_ALLOC_FAILED:
4743 return OC_STACK_NO_MEMORY;
4744 case CA_REQUEST_TIMEOUT:
4745 return OC_STACK_TIMEOUT;
4746 case CA_DESTINATION_DISCONNECTED:
4747 return OC_STACK_COMM_ERROR;
4748 case CA_STATUS_FAILED:
4749 return OC_STACK_ERROR;
4750 case CA_NOT_SUPPORTED:
4751 return OC_STACK_NOTIMPL;
4753 return OC_STACK_ERROR;
4757 bool OCResultToSuccess(OCStackResult ocResult)
4762 case OC_STACK_RESOURCE_CREATED:
4763 case OC_STACK_RESOURCE_DELETED:
4764 case OC_STACK_CONTINUE:
4765 case OC_STACK_RESOURCE_CHANGED:
4766 case OC_STACK_SLOW_RESOURCE:
4774 OCStackResult OCSetProxyURI(const char *uri)
4776 return CAResultToOCResult(CASetProxyUri(uri));
4780 #if defined(RD_CLIENT) || defined(RD_SERVER)
4781 OCStackResult OCBindResourceInsToResource(OCResourceHandle handle, uint8_t ins)
4783 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
4785 OCResource *resource = NULL;
4787 resource = findResource((OCResource *) handle);
4790 OIC_LOG(ERROR, TAG, "Resource not found");
4791 return OC_STACK_ERROR;
4794 resource->ins = ins;
4800 OCStackResult OCUpdateResourceInsWithResponse(const char *requestUri,
4801 const OCClientResponse *response)
4803 // Validate input parameters
4804 VERIFY_NON_NULL(requestUri, ERROR, OC_STACK_INVALID_PARAM);
4805 VERIFY_NON_NULL(response, ERROR, OC_STACK_INVALID_PARAM);
4807 char *targetUri = (char *) OICMalloc(strlen(requestUri) + 1);
4810 return OC_STACK_NO_MEMORY;
4812 strncpy(targetUri, requestUri, strlen(requestUri) + 1);
4814 if (response->result == OC_STACK_RESOURCE_CHANGED) // publish message
4816 OIC_LOG(DEBUG, TAG, "update the ins of published resource");
4818 char rdPubUri[MAX_URI_LENGTH] = { 0 };
4819 snprintf(rdPubUri, MAX_URI_LENGTH, "%s?rt=%s", OC_RSRVD_RD_URI,
4820 OC_RSRVD_RESOURCE_TYPE_RDPUBLISH);
4822 if (strcmp(rdPubUri, targetUri) == 0)
4824 // Update resource unique id in stack.
4827 if (response->payload)
4829 OCRepPayload *rdPayload = (OCRepPayload *) response->payload;
4830 OCRepPayload **links = NULL;
4831 size_t dimensions[MAX_REP_ARRAY_DEPTH] = { 0 };
4832 if (OCRepPayloadGetPropObjectArray(rdPayload, OC_RSRVD_LINKS,
4833 &links, dimensions))
4836 for (; i < dimensions[0]; i++)
4839 if (OCRepPayloadGetPropString(links[i], OC_RSRVD_HREF, &uri))
4841 OCResourceHandle handle = OCGetResourceHandleAtUri(uri);
4843 if (OCRepPayloadGetPropInt(links[i], OC_RSRVD_INS, &ins))
4845 OCBindResourceInsToResource(handle, ins);
4854 else if (response->result == OC_STACK_RESOURCE_DELETED) // delete message
4856 OIC_LOG(DEBUG, TAG, "update the ins of deleted resource with 0");
4858 uint8_t numResources = 0;
4859 OCGetNumberOfResources(&numResources);
4861 char *ins = strstr(targetUri, OC_RSRVD_INS);
4864 for (uint8_t i = 0; i < numResources; i++)
4866 OCResourceHandle resHandle = OCGetResourceHandle(i);
4869 OCBindResourceInsToResource(resHandle, 0);
4875 const char *token = "&";
4876 char *iterTokenPtr = NULL;
4877 char *start = strtok_r(targetUri, token, &iterTokenPtr);
4879 while (start != NULL)
4881 char *query = start;
4882 query = strstr(query, OC_RSRVD_INS);
4885 uint8_t queryIns = atoi(query + 4);
4886 for (uint8_t i = 0; i < numResources; i++)
4888 OCResourceHandle resHandle = OCGetResourceHandle(i);
4892 OCGetResourceIns(resHandle, &resIns);
4893 if (queryIns && queryIns == resIns)
4895 OCBindResourceInsToResource(resHandle, 0);
4901 start = strtok_r(NULL, token, &iterTokenPtr);
4910 OCResourceHandle OCGetResourceHandleAtUri(const char *uri)
4914 OIC_LOG(ERROR, TAG, "Resource uri is NULL");
4918 OCResource *pointer = headResource;
4922 if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
4924 OIC_LOG_V(DEBUG, TAG, "Found Resource %s", uri);
4927 pointer = pointer->next;
4932 OCStackResult OCGetResourceIns(OCResourceHandle handle, uint8_t *ins)
4934 OCResource *resource = NULL;
4936 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
4937 VERIFY_NON_NULL(ins, ERROR, OC_STACK_INVALID_PARAM);
4939 resource = findResource((OCResource *) handle);
4942 *ins = resource->ins;
4945 return OC_STACK_ERROR;
4949 OCStackResult OCSetHeaderOption(OCHeaderOption* ocHdrOpt, size_t* numOptions, uint16_t optionID,
4950 void* optionData, size_t optionDataLength)
4954 OIC_LOG (INFO, TAG, "Header options are NULL");
4955 return OC_STACK_INVALID_PARAM;
4960 OIC_LOG (INFO, TAG, "optionData are NULL");
4961 return OC_STACK_INVALID_PARAM;
4966 OIC_LOG (INFO, TAG, "numOptions is NULL");
4967 return OC_STACK_INVALID_PARAM;
4970 if (*numOptions >= MAX_HEADER_OPTIONS)
4972 OIC_LOG (INFO, TAG, "Exceeding MAX_HEADER_OPTIONS");
4973 return OC_STACK_NO_MEMORY;
4976 ocHdrOpt += *numOptions;
4977 ocHdrOpt->protocolID = OC_COAP_ID;
4978 ocHdrOpt->optionID = optionID;
4979 ocHdrOpt->optionLength =
4980 optionDataLength < MAX_HEADER_OPTION_DATA_LENGTH ?
4981 optionDataLength : MAX_HEADER_OPTION_DATA_LENGTH;
4982 memcpy(ocHdrOpt->optionData, (const void*) optionData, ocHdrOpt->optionLength);
4988 OCStackResult OCGetHeaderOption(OCHeaderOption* ocHdrOpt, size_t numOptions, uint16_t optionID,
4989 void* optionData, size_t optionDataLength, uint16_t* receivedDataLength)
4991 if (!ocHdrOpt || !numOptions)
4993 OIC_LOG (INFO, TAG, "No options present");
4999 OIC_LOG (INFO, TAG, "optionData are NULL");
5000 return OC_STACK_INVALID_PARAM;
5003 if (!receivedDataLength)
5005 OIC_LOG (INFO, TAG, "receivedDataLength is NULL");
5006 return OC_STACK_INVALID_PARAM;
5009 for (uint8_t i = 0; i < numOptions; i++)
5011 if (ocHdrOpt[i].optionID == optionID)
5013 if (optionDataLength >= ocHdrOpt->optionLength)
5015 memcpy(optionData, ocHdrOpt->optionData, ocHdrOpt->optionLength);
5016 *receivedDataLength = ocHdrOpt->optionLength;
5021 OIC_LOG (ERROR, TAG, "optionDataLength is less than the length of received data");
5022 return OC_STACK_ERROR;
5029 void OCDefaultAdapterStateChangedHandler(CATransportAdapter_t adapter, bool enabled)
5031 OIC_LOG(DEBUG, TAG, "OCDefaultAdapterStateChangedHandler");
5032 if (g_adapterHandler)
5034 g_adapterHandler(adapter, enabled);
5038 void OCDefaultConnectionStateChangedHandler(const CAEndpoint_t *info, bool isConnected)
5040 OIC_LOG(DEBUG, TAG, "OCDefaultConnectionStateChangedHandler");
5041 if (g_connectionHandler)
5043 g_connectionHandler(info, isConnected);
5047 * If the client observes one or more resources over a reliable connection,
5048 * then the CoAP server (or intermediary in the role of the CoAP server)
5049 * MUST remove all entries associated with the client endpoint from the lists
5050 * of observers when the connection is either closed or times out.
5054 OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
5055 CopyEndpointToDevAddr(info, &devAddr);
5057 // remove observer list with remote device address.
5058 DeleteObserverUsingDevAddr(&devAddr);
5062 void OCSetNetworkMonitorHandler(CAAdapterStateChangedCB adapterHandler,
5063 CAConnectionStateChangedCB connectionHandler)
5065 OIC_LOG(DEBUG, TAG, "OCSetNetworkMonitorHandler");
5066 g_adapterHandler = adapterHandler;
5067 g_connectionHandler = connectionHandler;
5070 OCStackResult OCGetDeviceId(OCUUIdentity *deviceId)
5073 OCStackResult ret = OC_STACK_ERROR;
5075 ret = GetDoxmDeviceID(&oicUuid);
5076 if (OC_STACK_OK == ret)
5078 memcpy(deviceId, &oicUuid, UUID_IDENTITY_SIZE);
5082 OIC_LOG(ERROR, TAG, "Device ID Get error");
5087 OCStackResult OCSetDeviceId(const OCUUIdentity *deviceId)
5090 OCStackResult ret = OC_STACK_ERROR;
5092 memcpy(&oicUuid, deviceId, UUID_LENGTH);
5093 for (int i = 0; i < UUID_LENGTH; i++)
5095 OIC_LOG_V(INFO, TAG, "Set Device Id %x", oicUuid.id[i]);
5097 ret = SetDoxmDeviceID(&oicUuid);