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
44 #include "ocstackinternal.h"
45 #include "ocresourcehandler.h"
46 #include "occlientcb.h"
47 #include "ocobserve.h"
49 #include "oic_malloc.h"
50 #include "oic_string.h"
52 #include "ocserverrequest.h"
53 #include "secureresourcemanager.h"
54 #include "doxmresource.h"
56 #include "cainterface.h"
57 #include "ocpayload.h"
58 #include "ocpayloadcbor.h"
60 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
61 #include "routingutility.h"
62 #ifdef ROUTING_GATEWAY
63 #include "routingmanager.h"
68 #include "oickeepalive.h"
76 #include "coap_time.h"
81 #include <arpa/inet.h>
85 #define UINT32_MAX (0xFFFFFFFFUL)
88 //-----------------------------------------------------------------------------
90 //-----------------------------------------------------------------------------
93 OC_STACK_UNINITIALIZED = 0,
95 OC_STACK_UNINIT_IN_PROGRESS
101 OC_PRESENCE_UNINITIALIZED = 0,
102 OC_PRESENCE_INITIALIZED
106 //-----------------------------------------------------------------------------
108 //-----------------------------------------------------------------------------
109 static OCStackState stackState = OC_STACK_UNINITIALIZED;
111 OCResource *headResource = NULL;
112 static OCResource *tailResource = NULL;
113 static OCResourceHandle platformResource = {0};
114 static OCResourceHandle deviceResource = {0};
116 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
117 static PresenceResource presenceResource;
118 static uint8_t PresenceTimeOutSize = 0;
119 static uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
122 static OCMode myStackMode;
124 //TODO: revisit this design
125 static bool gRASetInfo = false;
127 OCDeviceEntityHandler defaultDeviceHandler;
128 void* defaultDeviceHandlerCallbackParameter = NULL;
129 static const char COAP_TCP[] = "coap+tcp:";
131 //-----------------------------------------------------------------------------
133 //-----------------------------------------------------------------------------
134 #define TAG "OIC_RI_STACK"
135 #define VERIFY_SUCCESS(op, successCode) { if ((op) != (successCode)) \
136 {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
137 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
138 TAG, #arg " is NULL"); return (retVal); } }
139 #define VERIFY_NON_NULL_NR(arg, logLevel) { if (!(arg)) { OIC_LOG((logLevel), \
140 TAG, #arg " is NULL"); return; } }
141 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL");\
144 //TODO: we should allow the server to define this
145 #define MAX_OBSERVE_AGE (0x2FFFFUL)
147 #define MILLISECONDS_PER_SECOND (1000)
149 //-----------------------------------------------------------------------------
150 // Private internal function prototypes
151 //-----------------------------------------------------------------------------
154 * Generate handle of OCDoResource invocation for callback management.
156 * @return Generated OCDoResource handle.
158 static OCDoHandle GenerateInvocationHandle();
161 * Initialize resource data structures, variables, etc.
163 * @return ::OC_STACK_OK on success, some other value upon failure.
165 static OCStackResult initResources();
168 * Add a resource to the end of the linked list of resources.
170 * @param resource Resource to be added
172 static void insertResource(OCResource *resource);
175 * Find a resource in the linked list of resources.
177 * @param resource Resource to be found.
178 * @return Pointer to resource that was found in the linked list or NULL if the resource was not
181 static OCResource *findResource(OCResource *resource);
184 * Insert a resource type into a resource's resource type linked list.
185 * If resource type already exists, it will not be inserted and the
186 * resourceType will be free'd.
187 * resourceType->next should be null to avoid memory leaks.
188 * Function returns silently for null args.
190 * @param resource Resource where resource type is to be inserted.
191 * @param resourceType Resource type to be inserted.
193 static void insertResourceType(OCResource *resource,
194 OCResourceType *resourceType);
197 * Get a resource type at the specified index within a resource.
199 * @param handle Handle of resource.
200 * @param index Index of resource type.
202 * @return Pointer to resource type if found, NULL otherwise.
204 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
208 * Insert a resource interface into a resource's resource interface linked list.
209 * If resource interface already exists, it will not be inserted and the
210 * resourceInterface will be free'd.
211 * resourceInterface->next should be null to avoid memory leaks.
213 * @param resource Resource where resource interface is to be inserted.
214 * @param resourceInterface Resource interface to be inserted.
216 static void insertResourceInterface(OCResource *resource,
217 OCResourceInterface *resourceInterface);
220 * Get a resource interface at the specified index within a resource.
222 * @param handle Handle of resource.
223 * @param index Index of resource interface.
225 * @return Pointer to resource interface if found, NULL otherwise.
227 static OCResourceInterface *findResourceInterfaceAtIndex(
228 OCResourceHandle handle, uint8_t index);
231 * Delete all of the dynamically allocated elements that were created for the resource type.
233 * @param resourceType Specified resource type.
235 static void deleteResourceType(OCResourceType *resourceType);
238 * Delete all of the dynamically allocated elements that were created for the resource interface.
240 * @param resourceInterface Specified resource interface.
242 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
245 * Delete all of the dynamically allocated elements that were created for the resource.
247 * @param resource Specified resource.
249 static void deleteResourceElements(OCResource *resource);
252 * Delete resource specified by handle. Deletes resource and all resourcetype and resourceinterface
255 * @param handle Handle of resource to be deleted.
257 * @return ::OC_STACK_OK on success, some other value upon failure.
259 static OCStackResult deleteResource(OCResource *resource);
262 * Delete all of the resources in the resource list.
264 static void deleteAllResources();
267 * Increment resource sequence number. Handles rollover.
269 * @param resPtr Pointer to resource.
271 static void incrementSequenceNumber(OCResource * resPtr);
274 * Verify the lengths of the URI and the query separately.
276 * @param inputUri Input URI and query.
277 * @param uriLen The length of the initial URI with query.
278 * @return ::OC_STACK_OK on success, some other value upon failure.
280 static OCStackResult verifyUriQueryLength(const char * inputUri,
284 * Attempts to initialize every network interface that the CA Layer might have compiled in.
286 * Note: At least one interface must succeed to initialize. If all calls to @ref CASelectNetwork
287 * return something other than @ref CA_STATUS_OK, then this function fails.
289 * @return ::CA_STATUS_OK on success, some other value upon failure.
291 static CAResult_t OCSelectNetwork();
294 * Get the CoAP ticks after the specified number of milli-seconds.
296 * @param afterMilliSeconds Milli-seconds.
300 static uint32_t GetTicks(uint32_t afterMilliSeconds);
303 * Convert CAResponseResult_t to OCStackResult.
305 * @param caCode CAResponseResult_t code.
306 * @return ::OC_STACK_OK on success, some other value upon failure.
308 static OCStackResult CAToOCStackResult(CAResponseResult_t caCode);
311 * Convert OCStackResult to CAResponseResult_t.
313 * @param caCode OCStackResult code.
314 * @param method OCMethod method the return code replies to.
315 * @return ::CA_CONTENT on OK, some other value upon failure.
317 static CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method);
320 * Convert OCTransportFlags_t to CATransportModifiers_t.
322 * @param ocConType OCTransportFlags_t input.
323 * @return CATransportFlags
325 static CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocConType);
328 * Convert CATransportFlags_t to OCTransportModifiers_t.
330 * @param caConType CATransportFlags_t input.
331 * @return OCTransportFlags
333 static OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caConType);
336 * Handle response from presence request.
338 * @param endPoint CA remote endpoint.
339 * @param responseInfo CA response info.
340 * @return ::OC_STACK_OK on success, some other value upon failure.
342 static OCStackResult HandlePresenceResponse(const CAEndpoint_t *endPoint,
343 const CAResponseInfo_t *responseInfo);
346 * This function will be called back by CA layer when a response is received.
348 * @param endPoint CA remote endpoint.
349 * @param responseInfo CA response info.
351 static void HandleCAResponses(const CAEndpoint_t* endPoint,
352 const CAResponseInfo_t* responseInfo);
355 * This function will be called back by CA layer when a request is received.
357 * @param endPoint CA remote endpoint.
358 * @param requestInfo CA request info.
360 static void HandleCARequests(const CAEndpoint_t* endPoint,
361 const CARequestInfo_t* requestInfo);
364 * Extract query from a URI.
366 * @param uri Full URI with query.
367 * @param query Pointer to string that will contain query.
368 * @param newURI Pointer to string that will contain URI.
369 * @return ::OC_STACK_OK on success, some other value upon failure.
371 static OCStackResult getQueryFromUri(const char * uri, char** resourceType, char ** newURI);
374 * Finds a resource type in an OCResourceType link-list.
376 * @param resourceTypeList The link-list to be searched through.
377 * @param resourceTypeName The key to search for.
379 * @return Resource type that matches the key (ie. resourceTypeName) or
380 * NULL if there is either an invalid parameter or this function was unable to find the key.
382 static OCResourceType *findResourceType(OCResourceType * resourceTypeList,
383 const char * resourceTypeName);
386 * Reset presence TTL for a ClientCB struct. ttlLevel will be set to 0.
387 * TTL will be set to maxAge.
389 * @param cbNode Callback Node for which presence ttl is to be reset.
390 * @param maxAge New value of ttl in seconds.
392 * @return ::OC_STACK_OK on success, some other value upon failure.
394 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds);
397 * Ensure the accept header option is set appropriatly before sending the requests and routing
398 * header option is updated with destination.
400 * @param object CA remote endpoint.
401 * @param requestInfo CA request info.
403 * @return ::OC_STACK_OK on success, some other value upon failure.
405 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo);
407 //-----------------------------------------------------------------------------
408 // Internal functions
409 //-----------------------------------------------------------------------------
411 uint32_t GetTicks(uint32_t afterMilliSeconds)
416 // Guard against overflow of uint32_t
417 if (afterMilliSeconds <= ((UINT32_MAX - (uint32_t)now) * MILLISECONDS_PER_SECOND) /
418 COAP_TICKS_PER_SECOND)
420 return now + (afterMilliSeconds * COAP_TICKS_PER_SECOND)/MILLISECONDS_PER_SECOND;
428 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out)
430 VERIFY_NON_NULL_NR(in, FATAL);
431 VERIFY_NON_NULL_NR(out, FATAL);
433 out->adapter = (OCTransportAdapter)in->adapter;
434 out->flags = CAToOCTransportFlags(in->flags);
435 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
436 out->port = in->port;
437 out->interface = in->interface;
438 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
439 memcpy(out->routeData, in->routeData, sizeof(out->routeData));
443 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out)
445 VERIFY_NON_NULL_NR(in, FATAL);
446 VERIFY_NON_NULL_NR(out, FATAL);
448 out->adapter = (CATransportAdapter_t)in->adapter;
449 out->flags = OCToCATransportFlags(in->flags);
450 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
451 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
452 memcpy(out->routeData, in->routeData, sizeof(out->routeData));
454 out->port = in->port;
455 out->interface = in->interface;
458 void FixUpClientResponse(OCClientResponse *cr)
460 VERIFY_NON_NULL_NR(cr, FATAL);
462 cr->addr = &cr->devAddr;
463 cr->connType = (OCConnectivityType)
464 ((cr->devAddr.adapter << CT_ADAPTER_SHIFT) | (cr->devAddr.flags & CT_MASK_FLAGS));
467 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo)
469 VERIFY_NON_NULL(object, FATAL, OC_STACK_INVALID_PARAM);
470 VERIFY_NON_NULL(requestInfo, FATAL, OC_STACK_INVALID_PARAM);
472 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
473 OCStackResult rmResult = RMAddInfo(object->routeData, requestInfo, true, NULL);
474 if (OC_STACK_OK != rmResult)
476 OIC_LOG(ERROR, TAG, "Add destination option failed");
481 // OC stack prefer CBOR encoded payloads.
482 requestInfo->info.acceptFormat = CA_FORMAT_APPLICATION_CBOR;
483 CAResult_t result = CASendRequest(object, requestInfo);
484 if(CA_STATUS_OK != result)
486 OIC_LOG_V(ERROR, TAG, "CASendRequest failed with CA error %u", result);
487 return CAResultToOCResult(result);
491 //-----------------------------------------------------------------------------
492 // Internal API function
493 //-----------------------------------------------------------------------------
495 // This internal function is called to update the stack with the status of
496 // observers and communication failures
497 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status)
499 OCStackResult result = OC_STACK_ERROR;
500 ResourceObserver * observer = NULL;
501 OCEntityHandlerRequest ehRequest = {0};
505 case OC_OBSERVER_NOT_INTERESTED:
506 OIC_LOG(DEBUG, TAG, "observer not interested in our notifications");
507 observer = GetObserverUsingToken (token, tokenLength);
510 result = FormOCEntityHandlerRequest(&ehRequest,
511 (OCRequestHandle)NULL,
514 (OCResourceHandle)NULL,
515 NULL, PAYLOAD_TYPE_REPRESENTATION,
517 OC_OBSERVE_DEREGISTER,
518 observer->observeId);
519 if(result != OC_STACK_OK)
523 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
524 observer->resource->entityHandlerCallbackParam);
527 result = DeleteObserverUsingToken (token, tokenLength);
528 if(result == OC_STACK_OK)
530 OIC_LOG(DEBUG, TAG, "Removed observer successfully");
534 result = OC_STACK_OK;
535 OIC_LOG(DEBUG, TAG, "Observer Removal failed");
539 case OC_OBSERVER_STILL_INTERESTED:
540 OIC_LOG(DEBUG, TAG, "observer still interested, reset the failedCount");
541 observer = GetObserverUsingToken (token, tokenLength);
544 observer->forceHighQos = 0;
545 observer->failedCommCount = 0;
546 result = OC_STACK_OK;
550 result = OC_STACK_OBSERVER_NOT_FOUND;
554 case OC_OBSERVER_FAILED_COMM:
555 OIC_LOG(DEBUG, TAG, "observer is unreachable");
556 observer = GetObserverUsingToken (token, tokenLength);
559 if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
561 result = FormOCEntityHandlerRequest(&ehRequest,
562 (OCRequestHandle)NULL,
565 (OCResourceHandle)NULL,
566 NULL, PAYLOAD_TYPE_REPRESENTATION,
568 OC_OBSERVE_DEREGISTER,
569 observer->observeId);
570 if(result != OC_STACK_OK)
572 return OC_STACK_ERROR;
574 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
575 observer->resource->entityHandlerCallbackParam);
577 result = DeleteObserverUsingToken (token, tokenLength);
578 if(result == OC_STACK_OK)
580 OIC_LOG(DEBUG, TAG, "Removed observer successfully");
584 result = OC_STACK_OK;
585 OIC_LOG(DEBUG, TAG, "Observer Removal failed");
590 observer->failedCommCount++;
591 result = OC_STACK_CONTINUE;
593 observer->forceHighQos = 1;
594 OIC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",observer->failedCommCount);
598 OIC_LOG(ERROR, TAG, "Unknown status");
599 result = OC_STACK_ERROR;
604 OCStackResult CAToOCStackResult(CAResponseResult_t caCode)
606 OCStackResult ret = OC_STACK_ERROR;
611 ret = OC_STACK_RESOURCE_CREATED;
614 ret = OC_STACK_RESOURCE_DELETED;
622 ret = OC_STACK_INVALID_QUERY;
624 case CA_UNAUTHORIZED_REQ:
625 ret = OC_STACK_UNAUTHORIZED_REQ;
628 ret = OC_STACK_INVALID_OPTION;
631 ret = OC_STACK_NO_RESOURCE;
633 case CA_RETRANSMIT_TIMEOUT:
634 ret = OC_STACK_COMM_ERROR;
642 CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method)
644 CAResponseResult_t ret = CA_INTERNAL_SERVER_ERROR;
653 // This Response Code is like HTTP 204 "No Content" but only used in
654 // response to POST and PUT requests.
658 // This Response Code is like HTTP 200 "OK" but only used in response to
663 // This should not happen but,
664 // give it a value just in case but output an error
666 OIC_LOG_V(ERROR, TAG, "Unexpected OC_STACK_OK return code for method [%d].", method);
669 case OC_STACK_RESOURCE_CREATED:
672 case OC_STACK_RESOURCE_DELETED:
675 case OC_STACK_INVALID_QUERY:
678 case OC_STACK_INVALID_OPTION:
681 case OC_STACK_NO_RESOURCE:
684 case OC_STACK_COMM_ERROR:
685 ret = CA_RETRANSMIT_TIMEOUT;
687 case OC_STACK_UNAUTHORIZED_REQ:
688 ret = CA_UNAUTHORIZED_REQ;
696 CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocFlags)
698 CATransportFlags_t caFlags = (CATransportFlags_t)ocFlags;
700 // supply default behavior.
701 if ((caFlags & (CA_IPV6|CA_IPV4)) == 0)
703 caFlags = (CATransportFlags_t)(caFlags|CA_IPV6|CA_IPV4);
705 if ((caFlags & OC_MASK_SCOPE) == 0)
707 caFlags = (CATransportFlags_t)(caFlags|OC_SCOPE_LINK);
712 OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caFlags)
714 return (OCTransportFlags)caFlags;
717 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds)
719 uint32_t lowerBound = 0;
720 uint32_t higherBound = 0;
722 if (!cbNode || !cbNode->presence || !cbNode->presence->timeOut)
724 return OC_STACK_INVALID_PARAM;
727 OIC_LOG_V(INFO, TAG, "Update presence TTL, time is %u", GetTicks(0));
729 cbNode->presence->TTL = maxAgeSeconds;
731 for (int index = 0; index < PresenceTimeOutSize; index++)
733 // Guard against overflow
734 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index]))
737 lowerBound = GetTicks((PresenceTimeOut[index] *
738 cbNode->presence->TTL *
739 MILLISECONDS_PER_SECOND)/100);
743 lowerBound = GetTicks(UINT32_MAX);
746 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index+1]))
749 higherBound = GetTicks((PresenceTimeOut[index + 1] *
750 cbNode->presence->TTL *
751 MILLISECONDS_PER_SECOND)/100);
755 higherBound = GetTicks(UINT32_MAX);
758 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
760 OIC_LOG_V(DEBUG, TAG, "lowerBound timeout %d", lowerBound);
761 OIC_LOG_V(DEBUG, TAG, "higherBound timeout %d", higherBound);
762 OIC_LOG_V(DEBUG, TAG, "timeOut entry %d", cbNode->presence->timeOut[index]);
765 cbNode->presence->TTLlevel = 0;
767 OIC_LOG_V(DEBUG, TAG, "this TTL level %d", cbNode->presence->TTLlevel);
771 const char *convertTriggerEnumToString(OCPresenceTrigger trigger)
773 if (trigger == OC_PRESENCE_TRIGGER_CREATE)
775 return OC_RSRVD_TRIGGER_CREATE;
777 else if (trigger == OC_PRESENCE_TRIGGER_CHANGE)
779 return OC_RSRVD_TRIGGER_CHANGE;
783 return OC_RSRVD_TRIGGER_DELETE;
787 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr)
791 return OC_PRESENCE_TRIGGER_CREATE;
793 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CREATE) == 0)
795 return OC_PRESENCE_TRIGGER_CREATE;
797 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CHANGE) == 0)
799 return OC_PRESENCE_TRIGGER_CHANGE;
803 return OC_PRESENCE_TRIGGER_DELETE;
808 * The cononical presence allows constructed URIs to be string compared.
810 * requestUri must be a char array of size CA_MAX_URI_LENGTH
812 static int FormCanonicalPresenceUri(const CAEndpoint_t *endpoint, char *resourceUri,
815 VERIFY_NON_NULL(endpoint , FATAL, OC_STACK_INVALID_PARAM);
816 VERIFY_NON_NULL(resourceUri, FATAL, OC_STACK_INVALID_PARAM);
817 VERIFY_NON_NULL(presenceUri, FATAL, OC_STACK_INVALID_PARAM);
819 CAEndpoint_t *ep = (CAEndpoint_t *)endpoint;
821 if (ep->adapter == CA_ADAPTER_IP)
823 if ((ep->flags & CA_IPV6) && !(ep->flags & CA_IPV4))
825 if ('\0' == ep->addr[0]) // multicast
827 return snprintf(presenceUri, CA_MAX_URI_LENGTH, OC_RSRVD_PRESENCE_URI);
831 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://[%s]:%u%s",
832 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
837 if ('\0' == ep->addr[0]) // multicast
839 OICStrcpy(ep->addr, sizeof(ep->addr), OC_MULTICAST_IP);
840 ep->port = OC_MULTICAST_PORT;
842 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s:%u%s",
843 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
847 // might work for other adapters (untested, but better than nothing)
848 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s%s", ep->addr,
849 OC_RSRVD_PRESENCE_URI);
853 OCStackResult HandlePresenceResponse(const CAEndpoint_t *endpoint,
854 const CAResponseInfo_t *responseInfo)
856 VERIFY_NON_NULL(endpoint, FATAL, OC_STACK_INVALID_PARAM);
857 VERIFY_NON_NULL(responseInfo, FATAL, OC_STACK_INVALID_PARAM);
859 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
860 ClientCB * cbNode = NULL;
861 char *resourceTypeName = NULL;
862 OCClientResponse response = {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
863 OCStackResult result = OC_STACK_ERROR;
866 char presenceUri[CA_MAX_URI_LENGTH];
868 int presenceSubscribe = 0;
869 int multicastPresenceSubscribe = 0;
871 if (responseInfo->result != CA_CONTENT)
873 OIC_LOG_V(ERROR, TAG, "HandlePresenceResponse failed %d", responseInfo->result);
874 return OC_STACK_ERROR;
877 // check for unicast presence
878 uriLen = FormCanonicalPresenceUri(endpoint, OC_RSRVD_PRESENCE_URI, presenceUri);
879 if (uriLen < 0 || (size_t)uriLen >= sizeof (presenceUri))
881 return OC_STACK_INVALID_URI;
884 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
887 presenceSubscribe = 1;
891 // check for multiicast presence
892 CAEndpoint_t ep = { .adapter = endpoint->adapter,
893 .flags = endpoint->flags };
895 uriLen = FormCanonicalPresenceUri(&ep, OC_RSRVD_PRESENCE_URI, presenceUri);
897 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
900 multicastPresenceSubscribe = 1;
904 if (!presenceSubscribe && !multicastPresenceSubscribe)
906 OIC_LOG(ERROR, TAG, "Received a presence notification, but no callback, ignoring");
910 response.payload = NULL;
911 response.result = OC_STACK_OK;
913 CopyEndpointToDevAddr(endpoint, &response.devAddr);
914 FixUpClientResponse(&response);
916 if (responseInfo->info.payload)
918 result = OCParsePayload(&response.payload,
919 PAYLOAD_TYPE_PRESENCE,
920 responseInfo->info.payload,
921 responseInfo->info.payloadSize);
923 if(result != OC_STACK_OK)
925 OIC_LOG(ERROR, TAG, "Presence parse failed");
928 if(!response.payload || response.payload->type != PAYLOAD_TYPE_PRESENCE)
930 OIC_LOG(ERROR, TAG, "Presence payload was wrong type");
931 result = OC_STACK_ERROR;
934 response.sequenceNumber = ((OCPresencePayload*)response.payload)->sequenceNumber;
935 resourceTypeName = ((OCPresencePayload*)response.payload)->resourceType;
936 maxAge = ((OCPresencePayload*)response.payload)->maxAge;
939 if (presenceSubscribe)
941 if(cbNode->sequenceNumber == response.sequenceNumber)
943 OIC_LOG(INFO, TAG, "No presence change");
944 ResetPresenceTTL(cbNode, maxAge);
945 OIC_LOG_V(INFO, TAG, "ResetPresenceTTL - TTLlevel:%d\n", cbNode->presence->TTLlevel);
951 OIC_LOG(INFO, TAG, "Stopping presence");
952 response.result = OC_STACK_PRESENCE_STOPPED;
955 OICFree(cbNode->presence->timeOut);
956 OICFree(cbNode->presence);
957 cbNode->presence = NULL;
962 if(!cbNode->presence)
964 cbNode->presence = (OCPresence *)OICMalloc(sizeof (OCPresence));
966 if(!(cbNode->presence))
968 OIC_LOG(ERROR, TAG, "Could not allocate memory for cbNode->presence");
969 result = OC_STACK_NO_MEMORY;
973 VERIFY_NON_NULL_V(cbNode->presence);
974 cbNode->presence->timeOut = NULL;
975 cbNode->presence->timeOut = (uint32_t *)
976 OICMalloc(PresenceTimeOutSize * sizeof(uint32_t));
977 if(!(cbNode->presence->timeOut)){
979 "Could not allocate memory for cbNode->presence->timeOut");
980 OICFree(cbNode->presence);
981 result = OC_STACK_NO_MEMORY;
986 ResetPresenceTTL(cbNode, maxAge);
988 cbNode->sequenceNumber = response.sequenceNumber;
990 // Ensure that a filter is actually applied.
991 if( resourceTypeName && cbNode->filterResourceType)
993 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1002 // This is the multicast case
1003 OCMulticastNode* mcNode = NULL;
1004 mcNode = GetMCPresenceNode(presenceUri);
1008 if(mcNode->nonce == response.sequenceNumber)
1010 OIC_LOG(INFO, TAG, "No presence change (Multicast)");
1013 mcNode->nonce = response.sequenceNumber;
1017 OIC_LOG(INFO, TAG, "Stopping presence");
1018 response.result = OC_STACK_PRESENCE_STOPPED;
1023 char* uri = OICStrdup(presenceUri);
1027 "No Memory for URI to store in the presence node");
1028 result = OC_STACK_NO_MEMORY;
1032 result = AddMCPresenceNode(&mcNode, uri, response.sequenceNumber);
1033 if(result == OC_STACK_NO_MEMORY)
1036 "No Memory for Multicast Presence Node");
1040 // presence node now owns uri
1043 // Ensure that a filter is actually applied.
1044 if(resourceTypeName && cbNode->filterResourceType)
1046 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1053 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
1055 if (cbResult == OC_STACK_DELETE_TRANSACTION)
1057 FindAndDeleteClientCB(cbNode);
1061 OCPayloadDestroy(response.payload);
1065 void OCHandleResponse(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1067 OIC_LOG(DEBUG, TAG, "Enter OCHandleResponse");
1069 if(responseInfo->info.resourceUri &&
1070 strcmp(responseInfo->info.resourceUri, OC_RSRVD_PRESENCE_URI) == 0)
1072 HandlePresenceResponse(endPoint, responseInfo);
1076 ClientCB *cbNode = GetClientCB(responseInfo->info.token,
1077 responseInfo->info.tokenLength, NULL, NULL);
1079 ResourceObserver * observer = GetObserverUsingToken (responseInfo->info.token,
1080 responseInfo->info.tokenLength);
1084 OIC_LOG(INFO, TAG, "There is a cbNode associated with the response token");
1085 if(responseInfo->result == CA_EMPTY)
1087 OIC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1088 // We do not have a case for the client to receive a RESET
1089 if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1091 //This is the case of receiving an ACK on a request to a slow resource!
1092 OIC_LOG(INFO, TAG, "This is a pure ACK");
1093 //TODO: should we inform the client
1094 // app that at least the request was received at the server?
1097 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1099 OIC_LOG(INFO, TAG, "Receiving A Timeout for this token");
1100 OIC_LOG(INFO, TAG, "Calling into application address space");
1102 OCClientResponse response =
1103 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1104 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1105 FixUpClientResponse(&response);
1106 response.resourceUri = responseInfo->info.resourceUri;
1107 memcpy(response.identity.id, responseInfo->info.identity.id,
1108 sizeof (response.identity.id));
1109 response.identity.id_length = responseInfo->info.identity.id_length;
1111 response.result = CAToOCStackResult(responseInfo->result);
1112 cbNode->callBack(cbNode->context,
1113 cbNode->handle, &response);
1114 FindAndDeleteClientCB(cbNode);
1118 OIC_LOG(INFO, TAG, "This is a regular response, A client call back is found");
1119 OIC_LOG(INFO, TAG, "Calling into application address space");
1121 OCClientResponse response =
1122 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1123 response.sequenceNumber = OC_OBSERVE_NO_OPTION;
1124 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1125 FixUpClientResponse(&response);
1126 response.resourceUri = responseInfo->info.resourceUri;
1127 memcpy(response.identity.id, responseInfo->info.identity.id,
1128 sizeof (response.identity.id));
1129 response.identity.id_length = responseInfo->info.identity.id_length;
1131 response.result = CAToOCStackResult(responseInfo->result);
1133 if(responseInfo->info.payload &&
1134 responseInfo->info.payloadSize)
1136 OCPayloadType type = PAYLOAD_TYPE_INVALID;
1137 // check the security resource
1138 if (SRMIsSecurityResourceURI(cbNode->requestUri))
1140 type = PAYLOAD_TYPE_SECURITY;
1142 else if (cbNode->method == OC_REST_DISCOVER)
1144 if (strncmp(OC_RSRVD_WELL_KNOWN_URI,cbNode->requestUri,
1145 sizeof(OC_RSRVD_WELL_KNOWN_URI) - 1) == 0)
1147 type = PAYLOAD_TYPE_DISCOVERY;
1149 else if (strcmp(cbNode->requestUri, OC_RSRVD_DEVICE_URI) == 0)
1151 type = PAYLOAD_TYPE_DEVICE;
1153 else if (strcmp(cbNode->requestUri, OC_RSRVD_PLATFORM_URI) == 0)
1155 type = PAYLOAD_TYPE_PLATFORM;
1157 #ifdef ROUTING_GATEWAY
1158 else if (strcmp(cbNode->requestUri, OC_RSRVD_GATEWAY_URI) == 0)
1160 type = PAYLOAD_TYPE_REPRESENTATION;
1163 else if (strcmp(cbNode->requestUri, OC_RSRVD_RD_URI) == 0)
1165 type = PAYLOAD_TYPE_RD;
1168 else if (strcmp(cbNode->requestUri, KEEPALIVE_RESOURCE_URI) == 0)
1170 type = PAYLOAD_TYPE_REPRESENTATION;
1175 OIC_LOG_V(ERROR, TAG, "Unknown Payload type in Discovery: %d %s",
1176 cbNode->method, cbNode->requestUri);
1180 else if (cbNode->method == OC_REST_GET ||
1181 cbNode->method == OC_REST_PUT ||
1182 cbNode->method == OC_REST_POST ||
1183 cbNode->method == OC_REST_OBSERVE ||
1184 cbNode->method == OC_REST_OBSERVE_ALL ||
1185 cbNode->method == OC_REST_DELETE)
1187 char targetUri[MAX_URI_LENGTH];
1188 snprintf(targetUri, MAX_URI_LENGTH, "%s?rt=%s",
1189 OC_RSRVD_RD_URI, OC_RSRVD_RESOURCE_TYPE_RDPUBLISH);
1190 if (strcmp(targetUri, cbNode->requestUri) == 0)
1192 type = PAYLOAD_TYPE_RD;
1194 else if (strcmp(OC_RSRVD_PLATFORM_URI, cbNode->requestUri) == 0)
1196 type = PAYLOAD_TYPE_PLATFORM;
1198 else if (strcmp(OC_RSRVD_DEVICE_URI, cbNode->requestUri) == 0)
1200 type = PAYLOAD_TYPE_DEVICE;
1202 if (type == PAYLOAD_TYPE_INVALID)
1204 OIC_LOG_V(INFO, TAG, "Assuming PAYLOAD_TYPE_REPRESENTATION: %d %s",
1205 cbNode->method, cbNode->requestUri);
1206 type = PAYLOAD_TYPE_REPRESENTATION;
1211 OIC_LOG_V(ERROR, TAG, "Unknown Payload type: %d %s",
1212 cbNode->method, cbNode->requestUri);
1216 if(OC_STACK_OK != OCParsePayload(&response.payload,
1218 responseInfo->info.payload,
1219 responseInfo->info.payloadSize))
1221 OIC_LOG(ERROR, TAG, "Error converting payload");
1222 OCPayloadDestroy(response.payload);
1227 response.numRcvdVendorSpecificHeaderOptions = 0;
1228 if(responseInfo->info.numOptions > 0)
1231 //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
1232 if(responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
1235 uint32_t observationOption;
1236 uint8_t* optionData = (uint8_t*)responseInfo->info.options[0].optionData;
1237 for (observationOption=0, i=0;
1238 i<sizeof(uint32_t) && i<responseInfo->info.options[0].optionLength;
1242 (observationOption << 8) | optionData[i];
1244 response.sequenceNumber = observationOption;
1246 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
1251 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
1254 if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
1256 OIC_LOG(ERROR, TAG, "#header options are more than MAX_HEADER_OPTIONS");
1257 OCPayloadDestroy(response.payload);
1261 for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
1263 memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
1264 &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
1268 if (cbNode->method == OC_REST_OBSERVE &&
1269 response.sequenceNumber > OC_OFFSET_SEQUENCE_NUMBER &&
1270 response.sequenceNumber <= cbNode->sequenceNumber)
1272 OIC_LOG_V(INFO, TAG, "Received stale notification. Number :%d",
1273 response.sequenceNumber);
1277 OCStackApplicationResult appFeedback = cbNode->callBack(cbNode->context,
1280 cbNode->sequenceNumber = response.sequenceNumber;
1282 if (appFeedback == OC_STACK_DELETE_TRANSACTION)
1284 FindAndDeleteClientCB(cbNode);
1288 // To keep discovery callbacks active.
1289 cbNode->TTL = GetTicks(MAX_CB_TIMEOUT_SECONDS *
1290 MILLISECONDS_PER_SECOND);
1294 //Need to send ACK when the response is CON
1295 if(responseInfo->info.type == CA_MSG_CONFIRM)
1297 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1298 CA_MSG_ACKNOWLEDGE, 0, NULL, NULL, 0, NULL);
1301 OCPayloadDestroy(response.payload);
1308 OIC_LOG(INFO, TAG, "There is an observer associated with the response token");
1309 if(responseInfo->result == CA_EMPTY)
1311 OIC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1312 if(responseInfo->info.type == CA_MSG_RESET)
1314 OIC_LOG(INFO, TAG, "This is a RESET");
1315 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1316 OC_OBSERVER_NOT_INTERESTED);
1318 else if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1320 OIC_LOG(INFO, TAG, "This is a pure ACK");
1321 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1322 OC_OBSERVER_STILL_INTERESTED);
1325 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1327 OIC_LOG(INFO, TAG, "Receiving Time Out for an observer");
1328 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1329 OC_OBSERVER_FAILED_COMM);
1334 if(!cbNode && !observer)
1336 if(myStackMode == OC_CLIENT || myStackMode == OC_CLIENT_SERVER
1337 || myStackMode == OC_GATEWAY)
1339 OIC_LOG(INFO, TAG, "This is a client, but no cbNode was found for token");
1340 if(responseInfo->result == CA_EMPTY)
1342 OIC_LOG(INFO, TAG, "Receiving CA_EMPTY in the ocstack");
1346 OIC_LOG(INFO, TAG, "Received a message without callbacks. Sending RESET");
1347 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1348 CA_MSG_RESET, 0, NULL, NULL, 0, NULL);
1352 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER
1353 || myStackMode == OC_GATEWAY)
1355 OIC_LOG(INFO, TAG, "This is a server, but no observer was found for token");
1356 if (responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1358 OIC_LOG_V(INFO, TAG, "Received ACK at server for messageId : %d",
1359 responseInfo->info.messageId);
1361 if (responseInfo->info.type == CA_MSG_RESET)
1363 OIC_LOG_V(INFO, TAG, "Received RESET at server for messageId : %d",
1364 responseInfo->info.messageId);
1371 OIC_LOG(INFO, TAG, "Exit HandleCAResponses");
1374 void HandleCAResponses(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1376 VERIFY_NON_NULL_NR(endPoint, FATAL);
1377 VERIFY_NON_NULL_NR(responseInfo, FATAL);
1379 OIC_LOG(INFO, TAG, "Enter HandleCAResponses");
1381 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1382 #ifdef ROUTING_GATEWAY
1383 bool needRIHandling = false;
1385 * Routing manager is going to update either of endpoint or response or both.
1386 * This typecasting is done to avoid unnecessary duplication of Endpoint and responseInfo
1387 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1390 OCStackResult ret = RMHandleResponse((CAResponseInfo_t *)responseInfo, (CAEndpoint_t *)endPoint,
1392 if(ret != OC_STACK_OK || !needRIHandling)
1394 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1400 * Put source in sender endpoint so that the next packet from application can be routed to
1401 * proper destination and remove "RM" coap header option before passing request / response to
1402 * RI as this option will make no sense to either RI or application.
1404 RMUpdateInfo((CAHeaderOption_t **) &(responseInfo->info.options),
1405 (uint8_t *) &(responseInfo->info.numOptions),
1406 (CAEndpoint_t *) endPoint);
1409 OCHandleResponse(endPoint, responseInfo);
1411 OIC_LOG(INFO, TAG, "Exit HandleCAResponses");
1415 * This function handles error response from CA
1416 * code shall be added to handle the errors
1418 void HandleCAErrorResponse(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errrorInfo)
1420 OIC_LOG(INFO, TAG, "Enter HandleCAErrorResponse");
1422 if(NULL == endPoint)
1424 OIC_LOG(ERROR, TAG, "endPoint is NULL");
1428 if(NULL == errrorInfo)
1430 OIC_LOG(ERROR, TAG, "errrorInfo is NULL");
1433 OIC_LOG(INFO, TAG, "Exit HandleCAErrorResponse");
1437 * This function sends out Direct Stack Responses. These are responses that are not coming
1438 * from the application entity handler. These responses have no payload and are usually ACKs,
1439 * RESETs or some error conditions that were caught by the stack.
1441 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
1442 const CAResponseResult_t responseResult, const CAMessageType_t type,
1443 const uint8_t numOptions, const CAHeaderOption_t *options,
1444 CAToken_t token, uint8_t tokenLength, const char *resourceUri)
1446 OIC_LOG(DEBUG, TAG, "Entering SendDirectStackResponse");
1447 CAResponseInfo_t respInfo = {
1448 .result = responseResult
1450 respInfo.info.messageId = coapID;
1451 respInfo.info.numOptions = numOptions;
1453 if (respInfo.info.numOptions)
1455 respInfo.info.options =
1456 (CAHeaderOption_t *)OICCalloc(respInfo.info.numOptions, sizeof(CAHeaderOption_t));
1457 memcpy (respInfo.info.options, options,
1458 sizeof(CAHeaderOption_t) * respInfo.info.numOptions);
1462 respInfo.info.payload = NULL;
1463 respInfo.info.token = token;
1464 respInfo.info.tokenLength = tokenLength;
1465 respInfo.info.type = type;
1466 respInfo.info.resourceUri = OICStrdup (resourceUri);
1467 respInfo.info.acceptFormat = CA_FORMAT_UNDEFINED;
1469 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1470 // Add the destination to route option from the endpoint->routeData.
1471 bool doPost = false;
1472 OCStackResult result = RMAddInfo(endPoint->routeData, &respInfo, false, &doPost);
1473 if(OC_STACK_OK != result)
1475 OIC_LOG_V(ERROR, TAG, "Add routing option failed [%d]", result);
1480 OIC_LOG(DEBUG, TAG, "Sending a POST message for EMPTY ACK in Client Mode");
1481 CARequestInfo_t reqInfo = {.method = CA_POST };
1482 /* The following initialization is not done in a single initializer block as in
1483 * arduino, .c file is compiled as .cpp and moves it from C99 to C++11. The latter
1484 * does not have designated initalizers. This is a work-around for now.
1486 reqInfo.info.type = CA_MSG_NONCONFIRM;
1487 reqInfo.info.messageId = coapID;
1488 reqInfo.info.tokenLength = tokenLength;
1489 reqInfo.info.token = token;
1490 reqInfo.info.numOptions = respInfo.info.numOptions;
1491 reqInfo.info.payload = NULL;
1492 reqInfo.info.resourceUri = OICStrdup (OC_RSRVD_GATEWAY_URI);
1493 if (reqInfo.info.numOptions)
1495 reqInfo.info.options =
1496 (CAHeaderOption_t *)OICCalloc(reqInfo.info.numOptions, sizeof(CAHeaderOption_t));
1497 if (NULL == reqInfo.info.options)
1499 OIC_LOG(ERROR, TAG, "Calloc failed");
1500 return OC_STACK_NO_MEMORY;
1502 memcpy (reqInfo.info.options, respInfo.info.options,
1503 sizeof(CAHeaderOption_t) * reqInfo.info.numOptions);
1506 CAResult_t caResult = CASendRequest(endPoint, &reqInfo);
1507 OICFree (reqInfo.info.resourceUri);
1508 OICFree (reqInfo.info.options);
1509 OICFree (respInfo.info.resourceUri);
1510 OICFree (respInfo.info.options);
1511 if (CA_STATUS_OK != caResult)
1513 OIC_LOG(ERROR, TAG, "CASendRequest error");
1514 return CAResultToOCResult(caResult);
1520 CAResult_t caResult = CASendResponse(endPoint, &respInfo);
1522 // resourceUri in the info field is cloned in the CA layer and
1523 // thus ownership is still here.
1524 OICFree (respInfo.info.resourceUri);
1525 OICFree (respInfo.info.options);
1526 if(CA_STATUS_OK != caResult)
1528 OIC_LOG(ERROR, TAG, "CASendResponse error");
1529 return CAResultToOCResult(caResult);
1532 OIC_LOG(DEBUG, TAG, "Exit SendDirectStackResponse");
1536 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
1538 OIC_LOG(INFO, TAG, "Entering HandleStackRequests (OCStack Layer)");
1539 OCStackResult result = OC_STACK_ERROR;
1540 if(!protocolRequest)
1542 OIC_LOG(ERROR, TAG, "protocolRequest is NULL");
1543 return OC_STACK_INVALID_PARAM;
1546 OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken,
1547 protocolRequest->tokenLength);
1550 OIC_LOG(INFO, TAG, "This is a new Server Request");
1551 result = AddServerRequest(&request, protocolRequest->coapID,
1552 protocolRequest->delayedResNeeded, 0, protocolRequest->method,
1553 protocolRequest->numRcvdVendorSpecificHeaderOptions,
1554 protocolRequest->observationOption, protocolRequest->qos,
1555 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
1556 protocolRequest->payload, protocolRequest->requestToken,
1557 protocolRequest->tokenLength, protocolRequest->resourceUrl,
1558 protocolRequest->reqTotalSize, protocolRequest->acceptFormat,
1559 &protocolRequest->devAddr);
1560 if (OC_STACK_OK != result)
1562 OIC_LOG(ERROR, TAG, "Error adding server request");
1568 OIC_LOG(ERROR, TAG, "Out of Memory");
1569 return OC_STACK_NO_MEMORY;
1572 if(!protocolRequest->reqMorePacket)
1574 request->requestComplete = 1;
1579 OIC_LOG(INFO, TAG, "This is either a repeated or blocked Server Request");
1582 if(request->requestComplete)
1584 OIC_LOG(INFO, TAG, "This Server Request is complete");
1585 ResourceHandling resHandling = OC_RESOURCE_VIRTUAL;
1586 OCResource *resource = NULL;
1587 result = DetermineResourceHandling (request, &resHandling, &resource);
1588 if (result == OC_STACK_OK)
1590 result = ProcessRequest(resHandling, resource, request);
1595 OIC_LOG(INFO, TAG, "This Server Request is incomplete");
1596 result = OC_STACK_CONTINUE;
1601 void OCHandleRequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1603 OIC_LOG(DEBUG, TAG, "Enter OCHandleRequests");
1606 if (requestInfo->info.resourceUri &&
1607 strcmp(requestInfo->info.resourceUri, KEEPALIVE_RESOURCE_URI) == 0)
1609 HandleKeepAliveRequest(endPoint, requestInfo);
1614 OCStackResult requestResult = OC_STACK_ERROR;
1616 if(myStackMode == OC_CLIENT)
1618 //TODO: should the client be responding to requests?
1622 OCServerProtocolRequest serverRequest = {0};
1624 OIC_LOG_V(INFO, TAG, "Endpoint URI : %s", requestInfo->info.resourceUri);
1626 char * uriWithoutQuery = NULL;
1627 char * query = NULL;
1629 requestResult = getQueryFromUri(requestInfo->info.resourceUri, &query, &uriWithoutQuery);
1631 if (requestResult != OC_STACK_OK || !uriWithoutQuery)
1633 OIC_LOG_V(ERROR, TAG, "getQueryFromUri() failed with OC error code %d\n", requestResult);
1636 OIC_LOG_V(INFO, TAG, "URI without query: %s", uriWithoutQuery);
1637 OIC_LOG_V(INFO, TAG, "Query : %s", query);
1639 if(strlen(uriWithoutQuery) < MAX_URI_LENGTH)
1641 OICStrcpy(serverRequest.resourceUrl, sizeof(serverRequest.resourceUrl), uriWithoutQuery);
1642 OICFree(uriWithoutQuery);
1646 OIC_LOG(ERROR, TAG, "URI length exceeds MAX_URI_LENGTH.");
1647 OICFree(uriWithoutQuery);
1654 if(strlen(query) < MAX_QUERY_LENGTH)
1656 OICStrcpy(serverRequest.query, sizeof(serverRequest.query), query);
1661 OIC_LOG(ERROR, TAG, "Query length exceeds MAX_QUERY_LENGTH.");
1667 if ((requestInfo->info.payload) && (0 < requestInfo->info.payloadSize))
1669 serverRequest.reqTotalSize = requestInfo->info.payloadSize;
1670 serverRequest.payload = (uint8_t *) OICMalloc(requestInfo->info.payloadSize);
1671 memcpy (serverRequest.payload, requestInfo->info.payload,
1672 requestInfo->info.payloadSize);
1676 serverRequest.reqTotalSize = 0;
1679 switch (requestInfo->method)
1682 serverRequest.method = OC_REST_GET;
1685 serverRequest.method = OC_REST_PUT;
1688 serverRequest.method = OC_REST_POST;
1691 serverRequest.method = OC_REST_DELETE;
1694 OIC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1695 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1696 requestInfo->info.type, requestInfo->info.numOptions,
1697 requestInfo->info.options, requestInfo->info.token,
1698 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1699 OICFree(serverRequest.payload);
1703 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1704 requestInfo->info.tokenLength);
1706 serverRequest.tokenLength = requestInfo->info.tokenLength;
1707 if (serverRequest.tokenLength) {
1709 serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1711 if (!serverRequest.requestToken)
1713 OIC_LOG(FATAL, TAG, "Allocation for token failed.");
1714 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1715 requestInfo->info.type, requestInfo->info.numOptions,
1716 requestInfo->info.options, requestInfo->info.token,
1717 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1718 OICFree(serverRequest.payload);
1721 memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1724 switch (requestInfo->info.acceptFormat)
1726 case CA_FORMAT_APPLICATION_CBOR:
1727 serverRequest.acceptFormat = OC_FORMAT_CBOR;
1729 case CA_FORMAT_UNDEFINED:
1730 serverRequest.acceptFormat = OC_FORMAT_UNDEFINED;
1733 serverRequest.acceptFormat = OC_FORMAT_UNSUPPORTED;
1736 if (requestInfo->info.type == CA_MSG_CONFIRM)
1738 serverRequest.qos = OC_HIGH_QOS;
1742 serverRequest.qos = OC_LOW_QOS;
1744 // CA does not need the following field
1745 // Are we sure CA does not need them? how is it responding to multicast
1746 serverRequest.delayedResNeeded = 0;
1748 serverRequest.coapID = requestInfo->info.messageId;
1750 CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1752 // copy vendor specific header options
1753 uint8_t tempNum = (requestInfo->info.numOptions);
1755 // Assume no observation requested and it is a pure GET.
1756 // If obs registration/de-registration requested it'll be fetched from the
1757 // options in GetObserveHeaderOption()
1758 serverRequest.observationOption = OC_OBSERVE_NO_OPTION;
1760 GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1761 if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1764 "The request info numOptions is greater than MAX_HEADER_OPTIONS");
1765 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1766 requestInfo->info.type, requestInfo->info.numOptions,
1767 requestInfo->info.options, requestInfo->info.token,
1768 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1769 OICFree(serverRequest.payload);
1770 OICFree(serverRequest.requestToken);
1773 serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1774 if (serverRequest.numRcvdVendorSpecificHeaderOptions)
1776 memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1777 sizeof(CAHeaderOption_t)*tempNum);
1780 requestResult = HandleStackRequests (&serverRequest);
1782 // Send ACK to client as precursor to slow response
1783 if(requestResult == OC_STACK_SLOW_RESOURCE)
1785 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1786 CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0, NULL);
1788 else if(requestResult != OC_STACK_OK)
1790 OIC_LOG_V(ERROR, TAG, "HandleStackRequests failed. error: %d", requestResult);
1792 CAResponseResult_t stackResponse =
1793 OCToCAStackResult(requestResult, serverRequest.method);
1795 SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1796 requestInfo->info.type, requestInfo->info.numOptions,
1797 requestInfo->info.options, requestInfo->info.token,
1798 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1800 // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1801 // The token is copied in there, and is thus still owned by this function.
1802 OICFree(serverRequest.payload);
1803 OICFree(serverRequest.requestToken);
1804 OIC_LOG(INFO, TAG, "Exit OCHandleRequests");
1807 //This function will be called back by CA layer when a request is received
1808 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1810 OIC_LOG(INFO, TAG, "Enter HandleCARequests");
1813 OIC_LOG(ERROR, TAG, "endPoint is NULL");
1819 OIC_LOG(ERROR, TAG, "requestInfo is NULL");
1823 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1824 #ifdef ROUTING_GATEWAY
1825 bool needRIHandling = false;
1826 bool isEmptyMsg = false;
1828 * Routing manager is going to update either of endpoint or request or both.
1829 * This typecasting is done to avoid unnecessary duplication of Endpoint and requestInfo
1830 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1831 * destination. It can also remove "RM" coap header option before passing request / response to
1832 * RI as this option will make no sense to either RI or application.
1834 OCStackResult ret = RMHandleRequest((CARequestInfo_t *)requestInfo, (CAEndpoint_t *)endPoint,
1835 &needRIHandling, &isEmptyMsg);
1836 if(OC_STACK_OK != ret || !needRIHandling)
1838 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1844 * Put source in sender endpoint so that the next packet from application can be routed to
1845 * proper destination and remove RM header option.
1847 RMUpdateInfo((CAHeaderOption_t **) &(requestInfo->info.options),
1848 (uint8_t *) &(requestInfo->info.numOptions),
1849 (CAEndpoint_t *) endPoint);
1851 #ifdef ROUTING_GATEWAY
1855 * In Gateways, the MSGType in route option is used to check if the actual
1856 * response is EMPTY message(4 bytes CoAP Header). In case of Client, the
1857 * EMPTY response is sent in the form of POST request which need to be changed
1858 * to a EMPTY response by RM. This translation is done in this part of the code.
1860 OIC_LOG(INFO, TAG, "This is a Empty response from the Client");
1861 CAResponseInfo_t respInfo = {.result = CA_EMPTY,
1862 .info.messageId = requestInfo->info.messageId,
1863 .info.type = CA_MSG_ACKNOWLEDGE};
1864 OCHandleResponse(endPoint, &respInfo);
1870 // Normal handling of the packet
1871 OCHandleRequests(endPoint, requestInfo);
1873 OIC_LOG(INFO, TAG, "Exit HandleCARequests");
1876 bool validatePlatformInfo(OCPlatformInfo info)
1879 if (!info.platformID)
1881 OIC_LOG(ERROR, TAG, "No platform ID found.");
1885 if (info.manufacturerName)
1887 size_t lenManufacturerName = strlen(info.manufacturerName);
1889 if(lenManufacturerName == 0 || lenManufacturerName > MAX_MANUFACTURER_NAME_LENGTH)
1891 OIC_LOG(ERROR, TAG, "Manufacturer name fails length requirements.");
1897 OIC_LOG(ERROR, TAG, "No manufacturer name present");
1901 if (info.manufacturerUrl)
1903 if(strlen(info.manufacturerUrl) > MAX_MANUFACTURER_URL_LENGTH)
1905 OIC_LOG(ERROR, TAG, "Manufacturer url fails length requirements.");
1912 //-----------------------------------------------------------------------------
1914 //-----------------------------------------------------------------------------
1916 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
1919 !raInfo->username ||
1920 !raInfo->hostname ||
1921 !raInfo->xmpp_domain)
1924 return OC_STACK_INVALID_PARAM;
1926 OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
1927 gRASetInfo = (result == OC_STACK_OK)? true : false;
1933 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1937 return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
1940 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
1942 if(stackState == OC_STACK_INITIALIZED)
1944 OIC_LOG(INFO, TAG, "Subsequent calls to OCInit() without calling \
1945 OCStop() between them are ignored.");
1949 #ifndef ROUTING_GATEWAY
1950 if (OC_GATEWAY == mode)
1952 OIC_LOG(ERROR, TAG, "Routing Manager not supported");
1953 return OC_STACK_INVALID_PARAM;
1960 OIC_LOG(ERROR, TAG, "Need to call OCSetRAInfo before calling OCInit");
1961 return OC_STACK_ERROR;
1965 OCStackResult result = OC_STACK_ERROR;
1966 OIC_LOG(INFO, TAG, "Entering OCInit");
1969 if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)
1970 || (mode == OC_GATEWAY)))
1972 OIC_LOG(ERROR, TAG, "Invalid mode");
1973 return OC_STACK_ERROR;
1977 if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1979 caglobals.client = true;
1981 if (mode == OC_SERVER || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1983 caglobals.server = true;
1986 caglobals.serverFlags = (CATransportFlags_t)serverFlags;
1987 if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
1989 caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4|CA_IPV6);
1991 caglobals.clientFlags = (CATransportFlags_t)clientFlags;
1992 if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
1994 caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4|CA_IPV6);
1997 defaultDeviceHandler = NULL;
1998 defaultDeviceHandlerCallbackParameter = NULL;
2000 result = CAResultToOCResult(CAInitialize());
2001 VERIFY_SUCCESS(result, OC_STACK_OK);
2003 result = CAResultToOCResult(OCSelectNetwork());
2004 VERIFY_SUCCESS(result, OC_STACK_OK);
2006 switch (myStackMode)
2009 CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2010 result = CAResultToOCResult(CAStartDiscoveryServer());
2011 OIC_LOG(INFO, TAG, "Client mode: CAStartDiscoveryServer");
2014 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2015 result = CAResultToOCResult(CAStartListeningServer());
2016 OIC_LOG(INFO, TAG, "Server mode: CAStartListeningServer");
2018 case OC_CLIENT_SERVER:
2020 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2021 result = CAResultToOCResult(CAStartListeningServer());
2022 if(result == OC_STACK_OK)
2024 result = CAResultToOCResult(CAStartDiscoveryServer());
2028 VERIFY_SUCCESS(result, OC_STACK_OK);
2031 CARegisterKeepAliveHandler(HandleKeepAliveConnCB, HandleKeepAliveDisconnCB);
2034 #ifdef WITH_PRESENCE
2035 PresenceTimeOutSize = sizeof (PresenceTimeOut) / sizeof (PresenceTimeOut[0]) - 1;
2036 #endif // WITH_PRESENCE
2038 //Update Stack state to initialized
2039 stackState = OC_STACK_INITIALIZED;
2041 // Initialize resource
2042 if(myStackMode != OC_CLIENT)
2044 result = initResources();
2047 // Initialize the SRM Policy Engine
2048 if(result == OC_STACK_OK)
2050 result = SRMInitPolicyEngine();
2051 // TODO after BeachHead delivery: consolidate into single SRMInit()
2053 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
2054 RMSetStackMode(mode);
2055 #ifdef ROUTING_GATEWAY
2056 if (OC_GATEWAY == myStackMode)
2058 result = RMInitialize();
2064 if(result == OC_STACK_OK)
2066 result = InitializeKeepAlive();
2071 if(result != OC_STACK_OK)
2073 OIC_LOG(ERROR, TAG, "Stack initialization error");
2074 deleteAllResources();
2076 stackState = OC_STACK_UNINITIALIZED;
2081 OCStackResult OCStop()
2083 OIC_LOG(INFO, TAG, "Entering OCStop");
2085 if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
2087 OIC_LOG(DEBUG, TAG, "Stack already stopping, exiting");
2090 else if (stackState != OC_STACK_INITIALIZED)
2092 OIC_LOG(ERROR, TAG, "Stack not initialized");
2093 return OC_STACK_ERROR;
2096 stackState = OC_STACK_UNINIT_IN_PROGRESS;
2098 #ifdef WITH_PRESENCE
2099 // Ensure that the TTL associated with ANY and ALL presence notifications originating from
2100 // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
2101 presenceResource.presenceTTL = 0;
2102 #endif // WITH_PRESENCE
2104 #ifdef ROUTING_GATEWAY
2105 if (OC_GATEWAY == myStackMode)
2112 TerminateKeepAlive();
2115 // Free memory dynamically allocated for resources
2116 deleteAllResources();
2118 DeletePlatformInfo();
2120 // Remove all observers
2121 DeleteObserverList();
2122 // Remove all the client callbacks
2123 DeleteClientCBList();
2125 // De-init the SRM Policy Engine
2126 // TODO after BeachHead delivery: consolidate into single SRMDeInit()
2127 SRMDeInitPolicyEngine();
2130 stackState = OC_STACK_UNINITIALIZED;
2134 OCStackResult OCStartMulticastServer()
2136 if(stackState != OC_STACK_INITIALIZED)
2138 OIC_LOG(ERROR, TAG, "OCStack is not initalized. Cannot start multicast server.");
2139 return OC_STACK_ERROR;
2141 CAResult_t ret = CAStartListeningServer();
2142 if (CA_STATUS_OK != ret)
2144 OIC_LOG_V(ERROR, TAG, "Failed starting listening server: %d", ret);
2145 return OC_STACK_ERROR;
2150 OCStackResult OCStopMulticastServer()
2152 CAResult_t ret = CAStopListeningServer();
2153 if (CA_STATUS_OK != ret)
2155 OIC_LOG_V(ERROR, TAG, "Failed stopping listening server: %d", ret);
2156 return OC_STACK_ERROR;
2161 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
2166 return CA_MSG_CONFIRM;
2171 return CA_MSG_NONCONFIRM;
2175 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
2179 query = strchr (inputUri, '?');
2183 if((query - inputUri) > MAX_URI_LENGTH)
2185 return OC_STACK_INVALID_URI;
2188 if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
2190 return OC_STACK_INVALID_QUERY;
2193 else if(uriLen > MAX_URI_LENGTH)
2195 return OC_STACK_INVALID_URI;
2201 * A request uri consists of the following components in order:
2204 * CoAP over UDP prefix "coap://"
2205 * CoAP over TCP prefix "coap+tcp://"
2207 * IPv6 address "[1234::5678]"
2208 * IPv4 address "192.168.1.1"
2209 * optional port ":5683"
2210 * resource uri "/oc/core..."
2212 * for PRESENCE requests, extract resource type.
2214 static OCStackResult ParseRequestUri(const char *fullUri,
2215 OCTransportAdapter adapter,
2216 OCTransportFlags flags,
2217 OCDevAddr **devAddr,
2219 char **resourceType)
2221 VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
2223 OCStackResult result = OC_STACK_OK;
2224 OCDevAddr *da = NULL;
2228 // provide defaults for all returned values
2235 *resourceUri = NULL;
2239 *resourceType = NULL;
2242 // delimit url prefix, if any
2243 const char *start = fullUri;
2244 char *slash2 = strstr(start, "//");
2249 char *slash = strchr(start, '/');
2252 return OC_STACK_INVALID_URI;
2255 // process url scheme
2256 size_t prefixLen = slash2 - fullUri;
2260 if ((prefixLen == sizeof(COAP_TCP) - 1) && (!strncmp(fullUri, COAP_TCP, prefixLen)))
2266 // TODO: this logic should come in with unit tests exercising the various strings
2267 // processs url prefix, if any
2268 size_t urlLen = slash - start;
2272 if (urlLen && devAddr)
2273 { // construct OCDevAddr
2274 if (start[0] == '[')
2276 char *close = strchr(++start, ']');
2277 if (!close || close > slash)
2279 return OC_STACK_INVALID_URI;
2282 if (close[1] == ':')
2286 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2287 flags = (OCTransportFlags)(flags | OC_IP_USE_V6);
2291 char *dot = strchr(start, '.');
2292 if (dot && dot < slash)
2294 colon = strchr(start, ':');
2295 end = (colon && colon < slash) ? colon : slash;
2299 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2303 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2304 flags = (OCTransportFlags)(flags | OC_IP_USE_V4);
2313 if (len >= sizeof(da->addr))
2315 return OC_STACK_INVALID_URI;
2317 // collect port, if any
2318 if (colon && colon < slash)
2320 for (colon++; colon < slash; colon++)
2323 if (c < '0' || c > '9')
2325 return OC_STACK_INVALID_URI;
2327 port = 10 * port + c - '0';
2332 if (len >= sizeof(da->addr))
2334 return OC_STACK_INVALID_URI;
2337 da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
2340 return OC_STACK_NO_MEMORY;
2342 OICStrcpyPartial(da->addr, sizeof(da->addr), start, len);
2344 da->adapter = adapter;
2346 if (!strncmp(fullUri, "coaps:", 6))
2348 da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
2353 // process resource uri, if any
2355 { // request uri and query
2356 size_t ulen = strlen(slash); // resource uri length
2357 size_t tlen = 0; // resource type length
2360 static const char strPresence[] = "/oic/ad?rt=";
2361 static const size_t lenPresence = sizeof(strPresence) - 1;
2362 if (!strncmp(slash, strPresence, lenPresence))
2364 type = slash + lenPresence;
2365 tlen = ulen - lenPresence;
2370 *resourceUri = (char *)OICMalloc(ulen + 1);
2373 result = OC_STACK_NO_MEMORY;
2376 strcpy(*resourceUri, slash);
2379 if (type && resourceType)
2381 *resourceType = (char *)OICMalloc(tlen + 1);
2384 result = OC_STACK_NO_MEMORY;
2388 OICStrcpy(*resourceType, (tlen+1), type);
2395 // free all returned values
2402 OICFree(*resourceUri);
2406 OICFree(*resourceType);
2411 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
2412 char *resourceUri, char **requestUri)
2414 char uri[CA_MAX_URI_LENGTH];
2416 FormCanonicalPresenceUri(endpoint, resourceUri, uri);
2418 *requestUri = OICStrdup(uri);
2421 return OC_STACK_NO_MEMORY;
2428 * Discover or Perform requests on a specified resource
2430 OCStackResult OCDoResource(OCDoHandle *handle,
2432 const char *requestUri,
2433 const OCDevAddr *destination,
2435 OCConnectivityType connectivityType,
2436 OCQualityOfService qos,
2437 OCCallbackData *cbData,
2438 OCHeaderOption *options,
2441 OIC_LOG(INFO, TAG, "Entering OCDoResource");
2443 // Validate input parameters
2444 VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
2445 VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
2446 VERIFY_NON_NULL(requestUri , FATAL, OC_STACK_INVALID_URI);
2448 OCStackResult result = OC_STACK_ERROR;
2449 CAResult_t caResult;
2450 CAToken_t token = NULL;
2451 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2452 ClientCB *clientCB = NULL;
2453 OCDoHandle resHandle = NULL;
2454 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2455 OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
2457 OCTransportAdapter adapter;
2458 OCTransportFlags flags;
2459 // the request contents are put here
2460 CARequestInfo_t requestInfo = {.method = CA_GET};
2461 // requestUri will be parsed into the following three variables
2462 OCDevAddr *devAddr = NULL;
2463 char *resourceUri = NULL;
2464 char *resourceType = NULL;
2466 // This validation is broken, but doesn't cause harm
2467 size_t uriLen = strlen(requestUri );
2468 if ((result = verifyUriQueryLength(requestUri , uriLen)) != OC_STACK_OK)
2474 * Support original behavior with address on resourceUri argument.
2476 adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2477 flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2479 result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2481 if (result != OC_STACK_OK)
2483 OIC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2490 case OC_REST_OBSERVE:
2491 case OC_REST_OBSERVE_ALL:
2492 case OC_REST_CANCEL_OBSERVE:
2493 requestInfo.method = CA_GET;
2496 requestInfo.method = CA_PUT;
2499 requestInfo.method = CA_POST;
2501 case OC_REST_DELETE:
2502 requestInfo.method = CA_DELETE;
2504 case OC_REST_DISCOVER:
2506 if (destination || devAddr)
2508 requestInfo.isMulticast = false;
2512 tmpDevAddr.adapter = adapter;
2513 tmpDevAddr.flags = flags;
2514 destination = &tmpDevAddr;
2515 requestInfo.isMulticast = true;
2517 // CA_DISCOVER will become GET and isMulticast
2518 requestInfo.method = CA_GET;
2520 #ifdef WITH_PRESENCE
2521 case OC_REST_PRESENCE:
2522 // Replacing method type with GET because "presence"
2523 // is a stack layer only implementation.
2524 requestInfo.method = CA_GET;
2528 result = OC_STACK_INVALID_METHOD;
2532 if (!devAddr && !destination)
2534 OIC_LOG(DEBUG, TAG, "no devAddr and no destination");
2535 result = OC_STACK_INVALID_PARAM;
2539 /* If not original behavior, use destination argument */
2540 if (destination && !devAddr)
2542 devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2545 result = OC_STACK_NO_MEMORY;
2548 *devAddr = *destination;
2551 resHandle = GenerateInvocationHandle();
2554 result = OC_STACK_NO_MEMORY;
2558 caResult = CAGenerateToken(&token, tokenLength);
2559 if (caResult != CA_STATUS_OK)
2561 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2562 result= OC_STACK_ERROR;
2566 // fill in request data
2567 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2568 requestInfo.info.token = token;
2569 requestInfo.info.tokenLength = tokenLength;
2570 requestInfo.info.resourceUri = resourceUri;
2572 if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2574 result = CreateObserveHeaderOption (&(requestInfo.info.options),
2575 options, numOptions, OC_OBSERVE_REGISTER);
2576 if (result != OC_STACK_OK)
2580 requestInfo.info.numOptions = numOptions + 1;
2584 requestInfo.info.numOptions = numOptions;
2585 requestInfo.info.options =
2586 (CAHeaderOption_t*) OICCalloc(numOptions, sizeof(CAHeaderOption_t));
2587 memcpy(requestInfo.info.options, (CAHeaderOption_t*)options,
2588 numOptions * sizeof(CAHeaderOption_t));
2591 CopyDevAddrToEndpoint(devAddr, &endpoint);
2596 OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2599 OIC_LOG(ERROR, TAG, "Failed to create CBOR Payload");
2602 requestInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
2606 requestInfo.info.payload = NULL;
2607 requestInfo.info.payloadSize = 0;
2608 requestInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
2611 if (result != OC_STACK_OK)
2613 OIC_LOG(ERROR, TAG, "CACreateEndpoint error");
2617 // prepare for response
2618 #ifdef WITH_PRESENCE
2619 if (method == OC_REST_PRESENCE)
2621 char *presenceUri = NULL;
2622 result = OCPreparePresence(&endpoint, resourceUri, &presenceUri);
2623 if (OC_STACK_OK != result)
2628 // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2629 // Presence notification will form a canonical uri to
2630 // look for callbacks into the application.
2631 resourceUri = presenceUri;
2635 ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2636 result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2637 method, devAddr, resourceUri, resourceType, ttl);
2638 if (OC_STACK_OK != result)
2643 devAddr = NULL; // Client CB list entry now owns it
2644 resourceUri = NULL; // Client CB list entry now owns it
2645 resourceType = NULL; // Client CB list entry now owns it
2648 result = OCSendRequest(&endpoint, &requestInfo);
2649 if (OC_STACK_OK != result)
2656 *handle = resHandle;
2660 if (result != OC_STACK_OK)
2662 OIC_LOG(ERROR, TAG, "OCDoResource error");
2663 FindAndDeleteClientCB(clientCB);
2664 CADestroyToken(token);
2672 // This is the owner of the payload object, so we free it
2673 OCPayloadDestroy(payload);
2674 OICFree(requestInfo.info.payload);
2676 OICFree(resourceUri);
2677 OICFree(resourceType);
2678 OICFree(requestInfo.info.options);
2682 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2686 * This ftn is implemented one of two ways in the case of observation:
2688 * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2689 * Remove the callback associated on client side.
2690 * When the next notification comes in from server,
2691 * reply with RESET message to server.
2692 * Keep in mind that the server will react to RESET only
2693 * if the last notification was sent as CON
2695 * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2696 * and it is associated with an observe request
2697 * (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2698 * Send CON Observe request to server with
2699 * observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2700 * Remove the callback associated on client side.
2702 OCStackResult ret = OC_STACK_OK;
2703 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2704 CARequestInfo_t requestInfo = {.method = CA_GET};
2708 return OC_STACK_INVALID_PARAM;
2711 ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2714 OIC_LOG(ERROR, TAG, "Callback not found. Called OCCancel on same resource twice?");
2715 return OC_STACK_ERROR;
2718 switch (clientCB->method)
2720 case OC_REST_OBSERVE:
2721 case OC_REST_OBSERVE_ALL:
2723 OIC_LOG_V(INFO, TAG, "Canceling observation for resource %s",
2724 clientCB->requestUri);
2725 if (qos != OC_HIGH_QOS)
2727 FindAndDeleteClientCB(clientCB);
2731 OIC_LOG(INFO, TAG, "Cancelling observation as CONFIRMABLE");
2733 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2734 requestInfo.info.token = clientCB->token;
2735 requestInfo.info.tokenLength = clientCB->tokenLength;
2737 if (CreateObserveHeaderOption (&(requestInfo.info.options),
2738 options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2740 return OC_STACK_ERROR;
2742 requestInfo.info.numOptions = numOptions + 1;
2743 requestInfo.info.resourceUri = OICStrdup (clientCB->requestUri);
2745 CopyDevAddrToEndpoint(clientCB->devAddr, &endpoint);
2747 ret = OCSendRequest(&endpoint, &requestInfo);
2749 if (requestInfo.info.options)
2751 OICFree (requestInfo.info.options);
2753 if (requestInfo.info.resourceUri)
2755 OICFree (requestInfo.info.resourceUri);
2760 case OC_REST_DISCOVER:
2761 OIC_LOG_V(INFO, TAG, "Cancelling discovery callback for resource %s",
2762 clientCB->requestUri);
2763 FindAndDeleteClientCB(clientCB);
2766 #ifdef WITH_PRESENCE
2767 case OC_REST_PRESENCE:
2768 FindAndDeleteClientCB(clientCB);
2773 ret = OC_STACK_INVALID_METHOD;
2781 * @brief Register Persistent storage callback.
2782 * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2784 * OC_STACK_OK - No errors; Success
2785 * OC_STACK_INVALID_PARAM - Invalid parameter
2787 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2789 OIC_LOG(INFO, TAG, "RegisterPersistentStorageHandler !!");
2790 if(!persistentStorageHandler)
2792 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2793 return OC_STACK_INVALID_PARAM;
2797 if( !persistentStorageHandler->open ||
2798 !persistentStorageHandler->close ||
2799 !persistentStorageHandler->read ||
2800 !persistentStorageHandler->unlink ||
2801 !persistentStorageHandler->write)
2803 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2804 return OC_STACK_INVALID_PARAM;
2807 return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2810 #ifdef WITH_PRESENCE
2812 OCStackResult OCProcessPresence()
2814 OCStackResult result = OC_STACK_OK;
2816 // the following line floods the log with messages that are irrelevant
2817 // to most purposes. Uncomment as needed.
2818 //OIC_LOG(INFO, TAG, "Entering RequestPresence");
2819 ClientCB* cbNode = NULL;
2820 OCClientResponse clientResponse;
2821 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2823 LL_FOREACH(cbList, cbNode)
2825 if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
2830 uint32_t now = GetTicks(0);
2831 OIC_LOG_V(DEBUG, TAG, "this TTL level %d",
2832 cbNode->presence->TTLlevel);
2833 OIC_LOG_V(DEBUG, TAG, "current ticks %d", now);
2835 if (cbNode->presence->TTLlevel > PresenceTimeOutSize)
2840 if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
2842 OIC_LOG_V(DEBUG, TAG, "timeout ticks %d",
2843 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2845 if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2847 OIC_LOG(DEBUG, TAG, "No more timeout ticks");
2849 clientResponse.sequenceNumber = 0;
2850 clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
2851 clientResponse.devAddr = *cbNode->devAddr;
2852 FixUpClientResponse(&clientResponse);
2853 clientResponse.payload = NULL;
2855 // Increment the TTLLevel (going to a next state), so we don't keep
2856 // sending presence notification to client.
2857 cbNode->presence->TTLlevel++;
2858 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
2859 cbNode->presence->TTLlevel);
2861 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
2862 if (cbResult == OC_STACK_DELETE_TRANSACTION)
2864 FindAndDeleteClientCB(cbNode);
2868 if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2873 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2874 CAInfo_t requestData = {.type = CA_MSG_CONFIRM};
2875 CARequestInfo_t requestInfo = {.method = CA_GET};
2877 OIC_LOG(DEBUG, TAG, "time to test server presence");
2879 CopyDevAddrToEndpoint(cbNode->devAddr, &endpoint);
2881 requestData.type = CA_MSG_NONCONFIRM;
2882 requestData.token = cbNode->token;
2883 requestData.tokenLength = cbNode->tokenLength;
2884 requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
2885 requestInfo.method = CA_GET;
2886 requestInfo.info = requestData;
2888 result = OCSendRequest(&endpoint, &requestInfo);
2889 if (OC_STACK_OK != result)
2894 cbNode->presence->TTLlevel++;
2895 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
2898 if (result != OC_STACK_OK)
2900 OIC_LOG(ERROR, TAG, "OCProcessPresence error");
2905 #endif // WITH_PRESENCE
2907 OCStackResult OCProcess()
2909 #ifdef WITH_PRESENCE
2910 OCProcessPresence();
2912 CAHandleRequestResponse();
2914 #ifdef ROUTING_GATEWAY
2924 #ifdef WITH_PRESENCE
2925 OCStackResult OCStartPresence(const uint32_t ttl)
2927 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2928 OCChangeResourceProperty(
2929 &(((OCResource *)presenceResource.handle)->resourceProperties),
2932 if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
2934 presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
2935 OIC_LOG(INFO, TAG, "Setting Presence TTL to max value");
2939 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
2940 OIC_LOG(INFO, TAG, "Setting Presence TTL to default value");
2944 presenceResource.presenceTTL = ttl;
2946 OIC_LOG_V(DEBUG, TAG, "Presence TTL is %" PRIu32 " seconds", presenceResource.presenceTTL);
2948 if (OC_PRESENCE_UNINITIALIZED == presenceState)
2950 presenceState = OC_PRESENCE_INITIALIZED;
2952 OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
2954 CAToken_t caToken = NULL;
2955 CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
2956 if (caResult != CA_STATUS_OK)
2958 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2959 CADestroyToken(caToken);
2960 return OC_STACK_ERROR;
2963 AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
2964 (OCResource *)presenceResource.handle, OC_LOW_QOS, OC_FORMAT_UNDEFINED, &devAddr);
2965 CADestroyToken(caToken);
2968 // Each time OCStartPresence is called
2969 // a different random 32-bit integer number is used
2970 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2972 return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
2973 OC_PRESENCE_TRIGGER_CREATE);
2976 OCStackResult OCStopPresence()
2978 OCStackResult result = OC_STACK_ERROR;
2980 if(presenceResource.handle)
2982 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2984 // make resource inactive
2985 result = OCChangeResourceProperty(
2986 &(((OCResource *) presenceResource.handle)->resourceProperties),
2990 if(result != OC_STACK_OK)
2993 "Changing the presence resource properties to ACTIVE not successful");
2997 return SendStopNotification();
3001 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
3002 void* callbackParameter)
3004 defaultDeviceHandler = entityHandler;
3005 defaultDeviceHandlerCallbackParameter = callbackParameter;
3010 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo)
3012 OIC_LOG(INFO, TAG, "Entering OCSetPlatformInfo");
3014 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER || myStackMode == OC_GATEWAY)
3016 if (validatePlatformInfo(platformInfo))
3018 return SavePlatformInfo(platformInfo);
3022 return OC_STACK_INVALID_PARAM;
3027 return OC_STACK_ERROR;
3031 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
3033 OIC_LOG(INFO, TAG, "Entering OCSetDeviceInfo");
3035 if (!deviceInfo.deviceName || deviceInfo.deviceName[0] == '\0')
3037 OIC_LOG(ERROR, TAG, "Null or empty device name.");
3038 return OC_STACK_INVALID_PARAM;
3041 return SaveDeviceInfo(deviceInfo);
3044 OCStackResult OCCreateResource(OCResourceHandle *handle,
3045 const char *resourceTypeName,
3046 const char *resourceInterfaceName,
3047 const char *uri, OCEntityHandler entityHandler,
3048 void* callbackParam,
3049 uint8_t resourceProperties)
3052 OCResource *pointer = NULL;
3053 OCStackResult result = OC_STACK_ERROR;
3055 OIC_LOG(INFO, TAG, "Entering OCCreateResource");
3057 if(myStackMode == OC_CLIENT)
3059 return OC_STACK_INVALID_PARAM;
3061 // Validate parameters
3062 if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
3064 OIC_LOG(ERROR, TAG, "URI is empty or too long");
3065 return OC_STACK_INVALID_URI;
3067 // Is it presented during resource discovery?
3068 if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
3070 OIC_LOG(ERROR, TAG, "Input parameter is NULL");
3071 return OC_STACK_INVALID_PARAM;
3074 if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
3076 resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
3079 // Make sure resourceProperties bitmask has allowed properties specified
3080 if (resourceProperties
3081 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
3082 OC_EXPLICIT_DISCOVERABLE))
3084 OIC_LOG(ERROR, TAG, "Invalid property");
3085 return OC_STACK_INVALID_PARAM;
3088 // If the headResource is NULL, then no resources have been created...
3089 pointer = headResource;
3092 // At least one resources is in the resource list, so we need to search for
3093 // repeated URLs, which are not allowed. If a repeat is found, exit with an error
3096 if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
3098 OIC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
3099 return OC_STACK_INVALID_PARAM;
3101 pointer = pointer->next;
3104 // Create the pointer and insert it into the resource list
3105 pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
3108 result = OC_STACK_NO_MEMORY;
3111 pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
3113 insertResource(pointer);
3116 pointer->uri = OICStrdup(uri);
3119 result = OC_STACK_NO_MEMORY;
3123 // Set properties. Set OC_ACTIVE
3124 pointer->resourceProperties = (OCResourceProperty) (resourceProperties
3127 // Add the resourcetype to the resource
3128 result = BindResourceTypeToResource(pointer, resourceTypeName);
3129 if (result != OC_STACK_OK)
3131 OIC_LOG(ERROR, TAG, "Error adding resourcetype");
3135 // Add the resourceinterface to the resource
3136 result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
3137 if (result != OC_STACK_OK)
3139 OIC_LOG(ERROR, TAG, "Error adding resourceinterface");
3143 // If an entity handler has been passed, attach it to the newly created
3144 // resource. Otherwise, set the default entity handler.
3147 pointer->entityHandler = entityHandler;
3148 pointer->entityHandlerCallbackParam = callbackParam;
3152 pointer->entityHandler = defaultResourceEHandler;
3153 pointer->entityHandlerCallbackParam = NULL;
3156 // Initialize a pointer indicating child resources in case of collection
3157 pointer->rsrcChildResourcesHead = NULL;
3160 result = OC_STACK_OK;
3162 #ifdef WITH_PRESENCE
3163 if (presenceResource.handle)
3165 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3166 SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
3170 if (result != OC_STACK_OK)
3172 // Deep delete of resource and other dynamic elements that it contains
3173 deleteResource(pointer);
3178 OCStackResult OCBindResource(
3179 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3181 OCResource *resource = NULL;
3182 OCChildResource *tempChildResource = NULL;
3183 OCChildResource *newChildResource = NULL;
3185 OIC_LOG(INFO, TAG, "Entering OCBindResource");
3187 // Validate parameters
3188 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3189 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3190 // Container cannot contain itself
3191 if (collectionHandle == resourceHandle)
3193 OIC_LOG(ERROR, TAG, "Added handle equals collection handle");
3194 return OC_STACK_INVALID_PARAM;
3197 // Use the handle to find the resource in the resource linked list
3198 resource = findResource((OCResource *) collectionHandle);
3201 OIC_LOG(ERROR, TAG, "Collection handle not found");
3202 return OC_STACK_INVALID_PARAM;
3205 // Look for an open slot to add add the child resource.
3206 // If found, add it and return success
3208 tempChildResource = resource->rsrcChildResourcesHead;
3210 while(resource->rsrcChildResourcesHead && tempChildResource->next)
3212 // TODO: what if one of child resource was deregistered without unbinding?
3213 tempChildResource = tempChildResource->next;
3216 // Do memory allocation for child resource
3217 newChildResource = (OCChildResource *) OICCalloc(1, sizeof(OCChildResource));
3218 if(!newChildResource)
3220 OIC_LOG(ERROR, TAG, "Adding new child resource is failed due to memory allocation failure");
3221 return OC_STACK_ERROR;
3224 newChildResource->rsrcResource = (OCResource *) resourceHandle;
3225 newChildResource->next = NULL;
3227 if(!resource->rsrcChildResourcesHead)
3229 resource->rsrcChildResourcesHead = newChildResource;
3232 tempChildResource->next = newChildResource;
3235 OIC_LOG(INFO, TAG, "resource bound");
3237 #ifdef WITH_PRESENCE
3238 if (presenceResource.handle)
3240 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3241 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3242 OC_PRESENCE_TRIGGER_CHANGE);
3249 OCStackResult OCUnBindResource(
3250 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3252 OCResource *resource = NULL;
3253 OCChildResource *tempChildResource = NULL;
3254 OCChildResource *tempLastChildResource = NULL;
3256 OIC_LOG(INFO, TAG, "Entering OCUnBindResource");
3258 // Validate parameters
3259 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3260 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3261 // Container cannot contain itself
3262 if (collectionHandle == resourceHandle)
3264 OIC_LOG(ERROR, TAG, "removing handle equals collection handle");
3265 return OC_STACK_INVALID_PARAM;
3268 // Use the handle to find the resource in the resource linked list
3269 resource = findResource((OCResource *) collectionHandle);
3272 OIC_LOG(ERROR, TAG, "Collection handle not found");
3273 return OC_STACK_INVALID_PARAM;
3276 // Look for an open slot to add add the child resource.
3277 // If found, add it and return success
3278 if(!resource->rsrcChildResourcesHead)
3280 OIC_LOG(INFO, TAG, "resource not found in collection");
3282 // Unable to add resourceHandle, so return error
3283 return OC_STACK_ERROR;
3287 tempChildResource = resource->rsrcChildResourcesHead;
3289 while (tempChildResource)
3291 if(tempChildResource->rsrcResource == resourceHandle)
3293 // if resource going to be unbinded is the head one.
3294 if( tempChildResource == resource->rsrcChildResourcesHead )
3296 OCChildResource *temp = resource->rsrcChildResourcesHead->next;
3297 OICFree(resource->rsrcChildResourcesHead);
3298 resource->rsrcChildResourcesHead = temp;
3303 OCChildResource *temp = tempChildResource->next;
3304 OICFree(tempChildResource);
3305 tempLastChildResource->next = temp;
3309 OIC_LOG(INFO, TAG, "resource unbound");
3311 // Send notification when resource is unbounded successfully.
3312 #ifdef WITH_PRESENCE
3313 if (presenceResource.handle)
3315 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3316 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3317 OC_PRESENCE_TRIGGER_CHANGE);
3320 tempChildResource = NULL;
3321 tempLastChildResource = NULL;
3327 tempLastChildResource = tempChildResource;
3328 tempChildResource = tempChildResource->next;
3331 OIC_LOG(INFO, TAG, "resource not found in collection");
3333 tempChildResource = NULL;
3334 tempLastChildResource = NULL;
3336 // Unable to add resourceHandle, so return error
3337 return OC_STACK_ERROR;
3340 // Precondition is that the parameter has been checked to not equal NULL.
3341 static bool ValidateResourceTypeInterface(const char *resourceItemName)
3343 if (resourceItemName[0] < 'a' || resourceItemName[0] > 'z')
3349 while (resourceItemName[index] != '\0')
3351 if (resourceItemName[index] != '.' &&
3352 resourceItemName[index] != '-' &&
3353 (resourceItemName[index] < 'a' || resourceItemName[index] > 'z') &&
3354 (resourceItemName[index] < '0' || resourceItemName[index] > '9'))
3363 OCStackResult BindResourceTypeToResource(OCResource* resource,
3364 const char *resourceTypeName)
3366 OCResourceType *pointer = NULL;
3368 OCStackResult result = OC_STACK_ERROR;
3370 VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
3372 if (!ValidateResourceTypeInterface(resourceTypeName))
3374 OIC_LOG(ERROR, TAG, "resource type illegal (see RFC 6690)");
3375 return OC_STACK_INVALID_PARAM;
3378 pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
3381 result = OC_STACK_NO_MEMORY;
3385 str = OICStrdup(resourceTypeName);
3388 result = OC_STACK_NO_MEMORY;
3391 pointer->resourcetypename = str;
3393 insertResourceType(resource, pointer);
3394 result = OC_STACK_OK;
3397 if (result != OC_STACK_OK)
3406 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
3407 const char *resourceInterfaceName)
3409 OCResourceInterface *pointer = NULL;
3411 OCStackResult result = OC_STACK_ERROR;
3413 VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
3415 if (!ValidateResourceTypeInterface(resourceInterfaceName))
3417 OIC_LOG(ERROR, TAG, "resource /interface illegal (see RFC 6690)");
3418 return OC_STACK_INVALID_PARAM;
3421 OIC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
3423 pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
3426 result = OC_STACK_NO_MEMORY;
3430 str = OICStrdup(resourceInterfaceName);
3433 result = OC_STACK_NO_MEMORY;
3436 pointer->name = str;
3438 // Bind the resourceinterface to the resource
3439 insertResourceInterface(resource, pointer);
3441 result = OC_STACK_OK;
3444 if (result != OC_STACK_OK)
3453 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
3454 const char *resourceTypeName)
3457 OCStackResult result = OC_STACK_ERROR;
3458 OCResource *resource = NULL;
3460 resource = findResource((OCResource *) handle);
3463 OIC_LOG(ERROR, TAG, "Resource not found");
3464 return OC_STACK_ERROR;
3467 result = BindResourceTypeToResource(resource, resourceTypeName);
3469 #ifdef WITH_PRESENCE
3470 if(presenceResource.handle)
3472 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3473 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3480 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
3481 const char *resourceInterfaceName)
3484 OCStackResult result = OC_STACK_ERROR;
3485 OCResource *resource = NULL;
3487 resource = findResource((OCResource *) handle);
3490 OIC_LOG(ERROR, TAG, "Resource not found");
3491 return OC_STACK_ERROR;
3494 result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
3496 #ifdef WITH_PRESENCE
3497 if (presenceResource.handle)
3499 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3500 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3507 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
3509 OCResource *pointer = headResource;
3511 VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
3515 *numResources = *numResources + 1;
3516 pointer = pointer->next;
3521 OCResourceHandle OCGetResourceHandle(uint8_t index)
3523 OCResource *pointer = headResource;
3525 for( uint8_t i = 0; i < index && pointer; ++i)
3527 pointer = pointer->next;
3529 return (OCResourceHandle) pointer;
3532 OCStackResult OCDeleteResource(OCResourceHandle handle)
3536 OIC_LOG(ERROR, TAG, "Invalid handle for deletion");
3537 return OC_STACK_INVALID_PARAM;
3540 OCResource *resource = findResource((OCResource *) handle);
3541 if (resource == NULL)
3543 OIC_LOG(ERROR, TAG, "Resource not found");
3544 return OC_STACK_NO_RESOURCE;
3547 if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3549 OIC_LOG(ERROR, TAG, "Error deleting resource");
3550 return OC_STACK_ERROR;
3556 const char *OCGetResourceUri(OCResourceHandle handle)
3558 OCResource *resource = NULL;
3560 resource = findResource((OCResource *) handle);
3563 return resource->uri;
3565 return (const char *) NULL;
3568 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3570 OCResource *resource = NULL;
3572 resource = findResource((OCResource *) handle);
3575 return resource->resourceProperties;
3577 return (OCResourceProperty)-1;
3580 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3581 uint8_t *numResourceTypes)
3583 OCResource *resource = NULL;
3584 OCResourceType *pointer = NULL;
3586 VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3587 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3589 *numResourceTypes = 0;
3591 resource = findResource((OCResource *) handle);
3594 pointer = resource->rsrcType;
3597 *numResourceTypes = *numResourceTypes + 1;
3598 pointer = pointer->next;
3604 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3606 OCResourceType *resourceType = NULL;
3608 resourceType = findResourceTypeAtIndex(handle, index);
3611 return resourceType->resourcetypename;
3613 return (const char *) NULL;
3616 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3617 uint8_t *numResourceInterfaces)
3619 OCResourceInterface *pointer = NULL;
3620 OCResource *resource = NULL;
3622 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3623 VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3625 *numResourceInterfaces = 0;
3626 resource = findResource((OCResource *) handle);
3629 pointer = resource->rsrcInterface;
3632 *numResourceInterfaces = *numResourceInterfaces + 1;
3633 pointer = pointer->next;
3639 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3641 OCResourceInterface *resourceInterface = NULL;
3643 resourceInterface = findResourceInterfaceAtIndex(handle, index);
3644 if (resourceInterface)
3646 return resourceInterface->name;
3648 return (const char *) NULL;
3651 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3654 OCResource *resource = NULL;
3655 OCChildResource *tempChildResource = NULL;
3658 resource = findResource((OCResource *) collectionHandle);
3664 tempChildResource = resource->rsrcChildResourcesHead;
3666 while(tempChildResource)
3670 return tempChildResource->rsrcResource;
3673 tempChildResource = tempChildResource->next;
3676 // In this case, the number of resource handles in the collection exceeds the index
3677 tempChildResource = NULL;
3681 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3682 OCEntityHandler entityHandler,
3683 void* callbackParam)
3685 OCResource *resource = NULL;
3687 // Validate parameters
3688 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3690 // Use the handle to find the resource in the resource linked list
3691 resource = findResource((OCResource *)handle);
3694 OIC_LOG(ERROR, TAG, "Resource not found");
3695 return OC_STACK_ERROR;
3699 resource->entityHandler = entityHandler;
3700 resource->entityHandlerCallbackParam = callbackParam;
3702 #ifdef WITH_PRESENCE
3703 if (presenceResource.handle)
3705 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3706 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3713 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3715 OCResource *resource = NULL;
3717 resource = findResource((OCResource *)handle);
3720 OIC_LOG(ERROR, TAG, "Resource not found");
3725 return resource->entityHandler;
3728 void incrementSequenceNumber(OCResource * resPtr)
3730 // Increment the sequence number
3731 resPtr->sequenceNum += 1;
3732 if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3734 resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3739 #ifdef WITH_PRESENCE
3740 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3741 OCPresenceTrigger trigger)
3743 OCResource *resPtr = NULL;
3744 OCStackResult result = OC_STACK_ERROR;
3745 OCMethod method = OC_REST_PRESENCE;
3746 uint32_t maxAge = 0;
3747 resPtr = findResource((OCResource *) presenceResource.handle);
3750 return OC_STACK_NO_RESOURCE;
3753 if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3755 maxAge = presenceResource.presenceTTL;
3757 result = SendAllObserverNotification(method, resPtr, maxAge,
3758 trigger, resourceType, OC_LOW_QOS);
3764 OCStackResult SendStopNotification()
3766 OCResource *resPtr = NULL;
3767 OCStackResult result = OC_STACK_ERROR;
3768 OCMethod method = OC_REST_PRESENCE;
3769 resPtr = findResource((OCResource *) presenceResource.handle);
3772 return OC_STACK_NO_RESOURCE;
3775 // maxAge is 0. ResourceType is NULL.
3776 result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3782 #endif // WITH_PRESENCE
3783 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3785 OCResource *resPtr = NULL;
3786 OCStackResult result = OC_STACK_ERROR;
3787 OCMethod method = OC_REST_NOMETHOD;
3788 uint32_t maxAge = 0;
3790 OIC_LOG(INFO, TAG, "Notifying all observers");
3791 #ifdef WITH_PRESENCE
3792 if(handle == presenceResource.handle)
3796 #endif // WITH_PRESENCE
3797 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3799 // Verify that the resource exists
3800 resPtr = findResource ((OCResource *) handle);
3803 return OC_STACK_NO_RESOURCE;
3807 //only increment in the case of regular observing (not presence)
3808 incrementSequenceNumber(resPtr);
3809 method = OC_REST_OBSERVE;
3810 maxAge = MAX_OBSERVE_AGE;
3811 #ifdef WITH_PRESENCE
3812 result = SendAllObserverNotification (method, resPtr, maxAge,
3813 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3815 result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3822 OCNotifyListOfObservers (OCResourceHandle handle,
3823 OCObservationId *obsIdList,
3824 uint8_t numberOfIds,
3825 const OCRepPayload *payload,
3826 OCQualityOfService qos)
3828 OIC_LOG(INFO, TAG, "Entering OCNotifyListOfObservers");
3830 OCResource *resPtr = NULL;
3831 //TODO: we should allow the server to define this
3832 uint32_t maxAge = MAX_OBSERVE_AGE;
3834 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3835 VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3836 VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
3838 resPtr = findResource ((OCResource *) handle);
3839 if (NULL == resPtr || myStackMode == OC_CLIENT)
3841 return OC_STACK_NO_RESOURCE;
3845 incrementSequenceNumber(resPtr);
3847 return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3848 payload, maxAge, qos));
3851 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3853 OCStackResult result = OC_STACK_ERROR;
3854 OCServerRequest *serverRequest = NULL;
3856 OIC_LOG(INFO, TAG, "Entering OCDoResponse");
3858 // Validate input parameters
3859 VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3860 VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3863 // Get pointer to request info
3864 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3867 // response handler in ocserverrequest.c. Usually HandleSingleResponse.
3868 result = serverRequest->ehResponseHandler(ehResponse);
3874 //-----------------------------------------------------------------------------
3875 // Private internal function definitions
3876 //-----------------------------------------------------------------------------
3877 static OCDoHandle GenerateInvocationHandle()
3879 OCDoHandle handle = NULL;
3880 // Generate token here, it will be deleted when the transaction is deleted
3881 handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3884 OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3890 #ifdef WITH_PRESENCE
3891 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3892 OCResourceProperty resourceProperties, uint8_t enable)
3896 return OC_STACK_INVALID_PARAM;
3898 if (resourceProperties
3899 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
3901 OIC_LOG(ERROR, TAG, "Invalid property");
3902 return OC_STACK_INVALID_PARAM;
3906 *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3910 *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3916 OCStackResult initResources()
3918 OCStackResult result = OC_STACK_OK;
3920 headResource = NULL;
3921 tailResource = NULL;
3922 // Init Virtual Resources
3923 #ifdef WITH_PRESENCE
3924 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
3926 result = OCCreateResource(&presenceResource.handle,
3927 OC_RSRVD_RESOURCE_TYPE_PRESENCE,
3929 OC_RSRVD_PRESENCE_URI,
3933 //make resource inactive
3934 result = OCChangeResourceProperty(
3935 &(((OCResource *) presenceResource.handle)->resourceProperties),
3938 #ifndef WITH_ARDUINO
3939 if (result == OC_STACK_OK)
3941 result = SRMInitSecureResources();
3945 if(result == OC_STACK_OK)
3947 result = OCCreateResource(&deviceResource,
3948 OC_RSRVD_RESOURCE_TYPE_DEVICE,
3949 OC_RSRVD_INTERFACE_DEFAULT,
3950 OC_RSRVD_DEVICE_URI,
3954 if(result == OC_STACK_OK)
3956 result = BindResourceInterfaceToResource((OCResource *)deviceResource,
3957 OC_RSRVD_INTERFACE_READ);
3961 if(result == OC_STACK_OK)
3963 result = OCCreateResource(&platformResource,
3964 OC_RSRVD_RESOURCE_TYPE_PLATFORM,
3965 OC_RSRVD_INTERFACE_DEFAULT,
3966 OC_RSRVD_PLATFORM_URI,
3970 if(result == OC_STACK_OK)
3972 result = BindResourceInterfaceToResource((OCResource *)platformResource,
3973 OC_RSRVD_INTERFACE_READ);
3980 void insertResource(OCResource *resource)
3984 headResource = resource;
3985 tailResource = resource;
3989 tailResource->next = resource;
3990 tailResource = resource;
3992 resource->next = NULL;
3995 OCResource *findResource(OCResource *resource)
3997 OCResource *pointer = headResource;
4001 if (pointer == resource)
4005 pointer = pointer->next;
4010 void deleteAllResources()
4012 OCResource *pointer = headResource;
4013 OCResource *temp = NULL;
4017 temp = pointer->next;
4018 #ifdef WITH_PRESENCE
4019 if (pointer != (OCResource *) presenceResource.handle)
4021 #endif // WITH_PRESENCE
4022 deleteResource(pointer);
4023 #ifdef WITH_PRESENCE
4025 #endif // WITH_PRESENCE
4029 SRMDeInitSecureResources();
4031 #ifdef WITH_PRESENCE
4032 // Ensure that the last resource to be deleted is the presence resource. This allows for all
4033 // presence notification attributed to their deletion to be processed.
4034 deleteResource((OCResource *) presenceResource.handle);
4035 #endif // WITH_PRESENCE
4038 OCStackResult deleteResource(OCResource *resource)
4040 OCResource *prev = NULL;
4041 OCResource *temp = NULL;
4044 OIC_LOG(DEBUG,TAG,"resource is NULL");
4045 return OC_STACK_INVALID_PARAM;
4048 OIC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
4050 temp = headResource;
4053 if (temp == resource)
4055 // Invalidate all Resource Properties.
4056 resource->resourceProperties = (OCResourceProperty) 0;
4057 #ifdef WITH_PRESENCE
4058 if(resource != (OCResource *) presenceResource.handle)
4060 #endif // WITH_PRESENCE
4061 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
4062 #ifdef WITH_PRESENCE
4065 if(presenceResource.handle)
4067 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
4068 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
4071 // Only resource in list.
4072 if (temp == headResource && temp == tailResource)
4074 headResource = NULL;
4075 tailResource = NULL;
4078 else if (temp == headResource)
4080 headResource = temp->next;
4083 else if (temp == tailResource)
4085 tailResource = prev;
4086 tailResource->next = NULL;
4090 prev->next = temp->next;
4093 deleteResourceElements(temp);
4104 return OC_STACK_ERROR;
4107 void deleteResourceElements(OCResource *resource)
4114 OICFree(resource->uri);
4115 deleteResourceType(resource->rsrcType);
4116 deleteResourceInterface(resource->rsrcInterface);
4119 void deleteResourceType(OCResourceType *resourceType)
4121 OCResourceType *pointer = resourceType;
4122 OCResourceType *next = NULL;
4126 next = pointer->next;
4127 OICFree(pointer->resourcetypename);
4133 void deleteResourceInterface(OCResourceInterface *resourceInterface)
4135 OCResourceInterface *pointer = resourceInterface;
4136 OCResourceInterface *next = NULL;
4140 next = pointer->next;
4141 OICFree(pointer->name);
4147 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
4149 OCResourceType *pointer = NULL;
4150 OCResourceType *previous = NULL;
4151 if (!resource || !resourceType)
4155 // resource type list is empty.
4156 else if (!resource->rsrcType)
4158 resource->rsrcType = resourceType;
4162 pointer = resource->rsrcType;
4166 if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
4168 OIC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
4169 OICFree(resourceType->resourcetypename);
4170 OICFree(resourceType);
4174 pointer = pointer->next;
4176 previous->next = resourceType;
4178 resourceType->next = NULL;
4180 OIC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
4183 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
4185 OCResource *resource = NULL;
4186 OCResourceType *pointer = NULL;
4188 // Find the specified resource
4189 resource = findResource((OCResource *) handle);
4195 // Make sure a resource has a resourcetype
4196 if (!resource->rsrcType)
4201 // Iterate through the list
4202 pointer = resource->rsrcType;
4203 for(uint8_t i = 0; i< index && pointer; ++i)
4205 pointer = pointer->next;
4210 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
4212 if(resourceTypeList && resourceTypeName)
4214 OCResourceType * rtPointer = resourceTypeList;
4215 while(resourceTypeName && rtPointer)
4217 if(rtPointer->resourcetypename &&
4218 strcmp(resourceTypeName, (const char *)
4219 (rtPointer->resourcetypename)) == 0)
4223 rtPointer = rtPointer->next;
4231 * Insert a new interface into interface linked list only if not already present.
4232 * If alredy present, 2nd arg is free'd.
4233 * Default interface will always be first if present.
4235 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
4237 OCResourceInterface *pointer = NULL;
4238 OCResourceInterface *previous = NULL;
4240 newInterface->next = NULL;
4242 OCResourceInterface **firstInterface = &(resource->rsrcInterface);
4244 if (!*firstInterface)
4246 *firstInterface = newInterface;
4248 else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4250 if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4252 OICFree(newInterface->name);
4253 OICFree(newInterface);
4258 newInterface->next = *firstInterface;
4259 *firstInterface = newInterface;
4264 pointer = *firstInterface;
4267 if (strcmp(newInterface->name, pointer->name) == 0)
4269 OICFree(newInterface->name);
4270 OICFree(newInterface);
4274 pointer = pointer->next;
4276 previous->next = newInterface;
4280 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
4283 OCResource *resource = NULL;
4284 OCResourceInterface *pointer = NULL;
4286 // Find the specified resource
4287 resource = findResource((OCResource *) handle);
4293 // Make sure a resource has a resourceinterface
4294 if (!resource->rsrcInterface)
4299 // Iterate through the list
4300 pointer = resource->rsrcInterface;
4302 for (uint8_t i = 0; i < index && pointer; ++i)
4304 pointer = pointer->next;
4310 * This function splits the uri using the '?' delimiter.
4311 * "uriWithoutQuery" is the block of characters between the beginning
4312 * till the delimiter or '\0' which ever comes first.
4313 * "query" is whatever is to the right of the delimiter if present.
4314 * No delimiter sets the query to NULL.
4315 * If either are present, they will be malloc'ed into the params 2, 3.
4316 * The first param, *uri is left untouched.
4318 * NOTE: This function does not account for whitespace at the end of the uri NOR
4319 * malformed uri's with '??'. Whitespace at the end will be assumed to be
4320 * part of the query.
4322 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
4326 return OC_STACK_INVALID_URI;
4328 if(!query || !uriWithoutQuery)
4330 return OC_STACK_INVALID_PARAM;
4334 *uriWithoutQuery = NULL;
4336 size_t uriWithoutQueryLen = 0;
4337 size_t queryLen = 0;
4338 size_t uriLen = strlen(uri);
4340 char *pointerToDelimiter = strstr(uri, "?");
4342 uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : (size_t)(pointerToDelimiter - uri);
4343 queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
4345 if (uriWithoutQueryLen)
4347 *uriWithoutQuery = (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
4348 if (!*uriWithoutQuery)
4352 OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
4356 *query = (char *) OICCalloc(queryLen + 1, 1);
4359 OICFree(*uriWithoutQuery);
4360 *uriWithoutQuery = NULL;
4363 OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
4369 return OC_STACK_NO_MEMORY;
4372 const OicUuid_t* OCGetServerInstanceID(void)
4374 static bool generated = false;
4375 static OicUuid_t sid;
4381 if (GetDoxmDeviceID(&sid) != OC_STACK_OK)
4383 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
4390 const char* OCGetServerInstanceIDString(void)
4392 static bool generated = false;
4393 static char sidStr[UUID_STRING_SIZE];
4400 const OicUuid_t* sid = OCGetServerInstanceID();
4402 if(OCConvertUuidToString(sid->id, sidStr) != RAND_UUID_OK)
4404 OIC_LOG(FATAL, TAG, "Generate UUID String for Server Instance failed!");
4412 CAResult_t OCSelectNetwork()
4414 CAResult_t retResult = CA_STATUS_FAILED;
4415 CAResult_t caResult = CA_STATUS_OK;
4417 CATransportAdapter_t connTypes[] = {
4419 CA_ADAPTER_RFCOMM_BTEDR,
4420 CA_ADAPTER_GATT_BTLE,
4423 ,CA_ADAPTER_REMOTE_ACCESS
4430 int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
4432 for(int i = 0; i<numConnTypes; i++)
4434 // Ignore CA_NOT_SUPPORTED error. The CA Layer may have not compiled in the interface.
4435 if(caResult == CA_STATUS_OK || caResult == CA_NOT_SUPPORTED)
4437 caResult = CASelectNetwork(connTypes[i]);
4438 if(caResult == CA_STATUS_OK)
4440 retResult = CA_STATUS_OK;
4445 if(retResult != CA_STATUS_OK)
4447 return caResult; // Returns error of appropriate transport that failed fatally.
4453 OCStackResult CAResultToOCResult(CAResult_t caResult)
4459 case CA_STATUS_INVALID_PARAM:
4460 return OC_STACK_INVALID_PARAM;
4461 case CA_ADAPTER_NOT_ENABLED:
4462 return OC_STACK_ADAPTER_NOT_ENABLED;
4463 case CA_SERVER_STARTED_ALREADY:
4465 case CA_SERVER_NOT_STARTED:
4466 return OC_STACK_ERROR;
4467 case CA_DESTINATION_NOT_REACHABLE:
4468 return OC_STACK_COMM_ERROR;
4469 case CA_SOCKET_OPERATION_FAILED:
4470 return OC_STACK_COMM_ERROR;
4471 case CA_SEND_FAILED:
4472 return OC_STACK_COMM_ERROR;
4473 case CA_RECEIVE_FAILED:
4474 return OC_STACK_COMM_ERROR;
4475 case CA_MEMORY_ALLOC_FAILED:
4476 return OC_STACK_NO_MEMORY;
4477 case CA_REQUEST_TIMEOUT:
4478 return OC_STACK_TIMEOUT;
4479 case CA_DESTINATION_DISCONNECTED:
4480 return OC_STACK_COMM_ERROR;
4481 case CA_STATUS_FAILED:
4482 return OC_STACK_ERROR;
4483 case CA_NOT_SUPPORTED:
4484 return OC_STACK_NOTIMPL;
4486 return OC_STACK_ERROR;