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"
71 //#ifdef DIRECT_PAIRING
72 #include "directpairing.h"
80 #include "coap_time.h"
85 #include <arpa/inet.h>
89 #define UINT32_MAX (0xFFFFFFFFUL)
92 //-----------------------------------------------------------------------------
94 //-----------------------------------------------------------------------------
97 OC_STACK_UNINITIALIZED = 0,
99 OC_STACK_UNINIT_IN_PROGRESS
105 OC_PRESENCE_UNINITIALIZED = 0,
106 OC_PRESENCE_INITIALIZED
110 //-----------------------------------------------------------------------------
112 //-----------------------------------------------------------------------------
113 static OCStackState stackState = OC_STACK_UNINITIALIZED;
115 OCResource *headResource = NULL;
116 static OCResource *tailResource = NULL;
117 static OCResourceHandle platformResource = {0};
118 static OCResourceHandle deviceResource = {0};
120 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
121 static PresenceResource presenceResource;
122 static uint8_t PresenceTimeOutSize = 0;
123 static uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
126 static OCMode myStackMode;
128 //TODO: revisit this design
129 static bool gRASetInfo = false;
131 OCDeviceEntityHandler defaultDeviceHandler;
132 void* defaultDeviceHandlerCallbackParameter = NULL;
133 static const char COAP_TCP[] = "coap+tcp:";
135 //#ifdef DIRECT_PAIRING
136 OCDirectPairingCB gDirectpairingCallback = NULL;
139 //-----------------------------------------------------------------------------
141 //-----------------------------------------------------------------------------
142 #define TAG "OIC_RI_STACK"
143 #define VERIFY_SUCCESS(op, successCode) { if ((op) != (successCode)) \
144 {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
145 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
146 TAG, #arg " is NULL"); return (retVal); } }
147 #define VERIFY_NON_NULL_NR(arg, logLevel) { if (!(arg)) { OIC_LOG((logLevel), \
148 TAG, #arg " is NULL"); return; } }
149 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL");\
152 //TODO: we should allow the server to define this
153 #define MAX_OBSERVE_AGE (0x2FFFFUL)
155 #define MILLISECONDS_PER_SECOND (1000)
157 //-----------------------------------------------------------------------------
158 // Private internal function prototypes
159 //-----------------------------------------------------------------------------
162 * Generate handle of OCDoResource invocation for callback management.
164 * @return Generated OCDoResource handle.
166 static OCDoHandle GenerateInvocationHandle();
169 * Initialize resource data structures, variables, etc.
171 * @return ::OC_STACK_OK on success, some other value upon failure.
173 static OCStackResult initResources();
176 * Add a resource to the end of the linked list of resources.
178 * @param resource Resource to be added
180 static void insertResource(OCResource *resource);
183 * Find a resource in the linked list of resources.
185 * @param resource Resource to be found.
186 * @return Pointer to resource that was found in the linked list or NULL if the resource was not
189 static OCResource *findResource(OCResource *resource);
192 * Insert a resource type into a resource's resource type linked list.
193 * If resource type already exists, it will not be inserted and the
194 * resourceType will be free'd.
195 * resourceType->next should be null to avoid memory leaks.
196 * Function returns silently for null args.
198 * @param resource Resource where resource type is to be inserted.
199 * @param resourceType Resource type to be inserted.
201 static void insertResourceType(OCResource *resource,
202 OCResourceType *resourceType);
205 * Get a resource type at the specified index within a resource.
207 * @param handle Handle of resource.
208 * @param index Index of resource type.
210 * @return Pointer to resource type if found, NULL otherwise.
212 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
216 * Insert a resource interface into a resource's resource interface linked list.
217 * If resource interface already exists, it will not be inserted and the
218 * resourceInterface will be free'd.
219 * resourceInterface->next should be null to avoid memory leaks.
221 * @param resource Resource where resource interface is to be inserted.
222 * @param resourceInterface Resource interface to be inserted.
224 static void insertResourceInterface(OCResource *resource,
225 OCResourceInterface *resourceInterface);
228 * Get a resource interface at the specified index within a resource.
230 * @param handle Handle of resource.
231 * @param index Index of resource interface.
233 * @return Pointer to resource interface if found, NULL otherwise.
235 static OCResourceInterface *findResourceInterfaceAtIndex(
236 OCResourceHandle handle, uint8_t index);
239 * Delete all of the dynamically allocated elements that were created for the resource type.
241 * @param resourceType Specified resource type.
243 static void deleteResourceType(OCResourceType *resourceType);
246 * Delete all of the dynamically allocated elements that were created for the resource interface.
248 * @param resourceInterface Specified resource interface.
250 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
253 * Delete all of the dynamically allocated elements that were created for the resource.
255 * @param resource Specified resource.
257 static void deleteResourceElements(OCResource *resource);
260 * Delete resource specified by handle. Deletes resource and all resourcetype and resourceinterface
263 * @param handle Handle of resource to be deleted.
265 * @return ::OC_STACK_OK on success, some other value upon failure.
267 static OCStackResult deleteResource(OCResource *resource);
270 * Delete all of the resources in the resource list.
272 static void deleteAllResources();
275 * Increment resource sequence number. Handles rollover.
277 * @param resPtr Pointer to resource.
279 static void incrementSequenceNumber(OCResource * resPtr);
282 * Verify the lengths of the URI and the query separately.
284 * @param inputUri Input URI and query.
285 * @param uriLen The length of the initial URI with query.
286 * @return ::OC_STACK_OK on success, some other value upon failure.
288 static OCStackResult verifyUriQueryLength(const char * inputUri,
292 * Attempts to initialize every network interface that the CA Layer might have compiled in.
294 * Note: At least one interface must succeed to initialize. If all calls to @ref CASelectNetwork
295 * return something other than @ref CA_STATUS_OK, then this function fails.
297 * @return ::CA_STATUS_OK on success, some other value upon failure.
299 static CAResult_t OCSelectNetwork();
302 * Get the CoAP ticks after the specified number of milli-seconds.
304 * @param afterMilliSeconds Milli-seconds.
308 static uint32_t GetTicks(uint32_t afterMilliSeconds);
311 * Convert CAResponseResult_t to OCStackResult.
313 * @param caCode CAResponseResult_t code.
314 * @return ::OC_STACK_OK on success, some other value upon failure.
316 static OCStackResult CAToOCStackResult(CAResponseResult_t caCode);
319 * Convert OCStackResult to CAResponseResult_t.
321 * @param caCode OCStackResult code.
322 * @param method OCMethod method the return code replies to.
323 * @return ::CA_CONTENT on OK, some other value upon failure.
325 static CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method);
328 * Convert OCTransportFlags_t to CATransportModifiers_t.
330 * @param ocConType OCTransportFlags_t input.
331 * @return CATransportFlags
333 static CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocConType);
336 * Convert CATransportFlags_t to OCTransportModifiers_t.
338 * @param caConType CATransportFlags_t input.
339 * @return OCTransportFlags
341 static OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caConType);
344 * Handle response from presence request.
346 * @param endPoint CA remote endpoint.
347 * @param responseInfo CA response info.
348 * @return ::OC_STACK_OK on success, some other value upon failure.
350 static OCStackResult HandlePresenceResponse(const CAEndpoint_t *endPoint,
351 const CAResponseInfo_t *responseInfo);
354 * This function will be called back by CA layer when a response is received.
356 * @param endPoint CA remote endpoint.
357 * @param responseInfo CA response info.
359 static void HandleCAResponses(const CAEndpoint_t* endPoint,
360 const CAResponseInfo_t* responseInfo);
363 * This function will be called back by CA layer when a request is received.
365 * @param endPoint CA remote endpoint.
366 * @param requestInfo CA request info.
368 static void HandleCARequests(const CAEndpoint_t* endPoint,
369 const CARequestInfo_t* requestInfo);
372 * Extract query from a URI.
374 * @param uri Full URI with query.
375 * @param query Pointer to string that will contain query.
376 * @param newURI Pointer to string that will contain URI.
377 * @return ::OC_STACK_OK on success, some other value upon failure.
379 static OCStackResult getQueryFromUri(const char * uri, char** resourceType, char ** newURI);
382 * Finds a resource type in an OCResourceType link-list.
384 * @param resourceTypeList The link-list to be searched through.
385 * @param resourceTypeName The key to search for.
387 * @return Resource type that matches the key (ie. resourceTypeName) or
388 * NULL if there is either an invalid parameter or this function was unable to find the key.
390 static OCResourceType *findResourceType(OCResourceType * resourceTypeList,
391 const char * resourceTypeName);
394 * Reset presence TTL for a ClientCB struct. ttlLevel will be set to 0.
395 * TTL will be set to maxAge.
397 * @param cbNode Callback Node for which presence ttl is to be reset.
398 * @param maxAge New value of ttl in seconds.
400 * @return ::OC_STACK_OK on success, some other value upon failure.
402 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds);
405 * Ensure the accept header option is set appropriatly before sending the requests and routing
406 * header option is updated with destination.
408 * @param object CA remote endpoint.
409 * @param requestInfo CA request info.
411 * @return ::OC_STACK_OK on success, some other value upon failure.
413 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo);
415 //-----------------------------------------------------------------------------
416 // Internal functions
417 //-----------------------------------------------------------------------------
419 uint32_t GetTicks(uint32_t afterMilliSeconds)
424 // Guard against overflow of uint32_t
425 if (afterMilliSeconds <= ((UINT32_MAX - (uint32_t)now) * MILLISECONDS_PER_SECOND) /
426 COAP_TICKS_PER_SECOND)
428 return now + (afterMilliSeconds * COAP_TICKS_PER_SECOND)/MILLISECONDS_PER_SECOND;
436 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out)
438 VERIFY_NON_NULL_NR(in, FATAL);
439 VERIFY_NON_NULL_NR(out, FATAL);
441 out->adapter = (OCTransportAdapter)in->adapter;
442 out->flags = CAToOCTransportFlags(in->flags);
443 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
444 out->port = in->port;
445 out->interface = in->interface;
446 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
447 memcpy(out->routeData, in->routeData, sizeof(out->routeData));
451 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out)
453 VERIFY_NON_NULL_NR(in, FATAL);
454 VERIFY_NON_NULL_NR(out, FATAL);
456 out->adapter = (CATransportAdapter_t)in->adapter;
457 out->flags = OCToCATransportFlags(in->flags);
458 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
459 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
460 memcpy(out->routeData, in->routeData, sizeof(out->routeData));
462 out->port = in->port;
463 out->interface = in->interface;
466 void FixUpClientResponse(OCClientResponse *cr)
468 VERIFY_NON_NULL_NR(cr, FATAL);
470 cr->addr = &cr->devAddr;
471 cr->connType = (OCConnectivityType)
472 ((cr->devAddr.adapter << CT_ADAPTER_SHIFT) | (cr->devAddr.flags & CT_MASK_FLAGS));
475 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo)
477 VERIFY_NON_NULL(object, FATAL, OC_STACK_INVALID_PARAM);
478 VERIFY_NON_NULL(requestInfo, FATAL, OC_STACK_INVALID_PARAM);
480 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
481 OCStackResult rmResult = RMAddInfo(object->routeData, requestInfo, true, NULL);
482 if (OC_STACK_OK != rmResult)
484 OIC_LOG(ERROR, TAG, "Add destination option failed");
489 // OC stack prefer CBOR encoded payloads.
490 requestInfo->info.acceptFormat = CA_FORMAT_APPLICATION_CBOR;
491 CAResult_t result = CASendRequest(object, requestInfo);
492 if(CA_STATUS_OK != result)
494 OIC_LOG_V(ERROR, TAG, "CASendRequest failed with CA error %u", result);
495 return CAResultToOCResult(result);
499 //-----------------------------------------------------------------------------
500 // Internal API function
501 //-----------------------------------------------------------------------------
503 // This internal function is called to update the stack with the status of
504 // observers and communication failures
505 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status)
507 OCStackResult result = OC_STACK_ERROR;
508 ResourceObserver * observer = NULL;
509 OCEntityHandlerRequest ehRequest = {0};
513 case OC_OBSERVER_NOT_INTERESTED:
514 OIC_LOG(DEBUG, TAG, "observer not interested in our notifications");
515 observer = GetObserverUsingToken (token, tokenLength);
518 result = FormOCEntityHandlerRequest(&ehRequest,
519 (OCRequestHandle)NULL,
522 (OCResourceHandle)NULL,
523 NULL, PAYLOAD_TYPE_REPRESENTATION,
525 OC_OBSERVE_DEREGISTER,
526 observer->observeId);
527 if(result != OC_STACK_OK)
531 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
532 observer->resource->entityHandlerCallbackParam);
535 result = DeleteObserverUsingToken (token, tokenLength);
536 if(result == OC_STACK_OK)
538 OIC_LOG(DEBUG, TAG, "Removed observer successfully");
542 result = OC_STACK_OK;
543 OIC_LOG(DEBUG, TAG, "Observer Removal failed");
547 case OC_OBSERVER_STILL_INTERESTED:
548 OIC_LOG(DEBUG, TAG, "observer still interested, reset the failedCount");
549 observer = GetObserverUsingToken (token, tokenLength);
552 observer->forceHighQos = 0;
553 observer->failedCommCount = 0;
554 result = OC_STACK_OK;
558 result = OC_STACK_OBSERVER_NOT_FOUND;
562 case OC_OBSERVER_FAILED_COMM:
563 OIC_LOG(DEBUG, TAG, "observer is unreachable");
564 observer = GetObserverUsingToken (token, tokenLength);
567 if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
569 result = FormOCEntityHandlerRequest(&ehRequest,
570 (OCRequestHandle)NULL,
573 (OCResourceHandle)NULL,
574 NULL, PAYLOAD_TYPE_REPRESENTATION,
576 OC_OBSERVE_DEREGISTER,
577 observer->observeId);
578 if(result != OC_STACK_OK)
580 return OC_STACK_ERROR;
582 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
583 observer->resource->entityHandlerCallbackParam);
585 result = DeleteObserverUsingToken (token, tokenLength);
586 if(result == OC_STACK_OK)
588 OIC_LOG(DEBUG, TAG, "Removed observer successfully");
592 result = OC_STACK_OK;
593 OIC_LOG(DEBUG, TAG, "Observer Removal failed");
598 observer->failedCommCount++;
599 result = OC_STACK_CONTINUE;
601 observer->forceHighQos = 1;
602 OIC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",observer->failedCommCount);
606 OIC_LOG(ERROR, TAG, "Unknown status");
607 result = OC_STACK_ERROR;
612 OCStackResult CAToOCStackResult(CAResponseResult_t caCode)
614 OCStackResult ret = OC_STACK_ERROR;
619 ret = OC_STACK_RESOURCE_CREATED;
622 ret = OC_STACK_RESOURCE_DELETED;
630 ret = OC_STACK_INVALID_QUERY;
632 case CA_UNAUTHORIZED_REQ:
633 ret = OC_STACK_UNAUTHORIZED_REQ;
636 ret = OC_STACK_INVALID_OPTION;
639 ret = OC_STACK_NO_RESOURCE;
641 case CA_RETRANSMIT_TIMEOUT:
642 ret = OC_STACK_COMM_ERROR;
650 CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method)
652 CAResponseResult_t ret = CA_INTERNAL_SERVER_ERROR;
661 // This Response Code is like HTTP 204 "No Content" but only used in
662 // response to POST and PUT requests.
666 // This Response Code is like HTTP 200 "OK" but only used in response to
671 // This should not happen but,
672 // give it a value just in case but output an error
674 OIC_LOG_V(ERROR, TAG, "Unexpected OC_STACK_OK return code for method [%d].", method);
677 case OC_STACK_RESOURCE_CREATED:
680 case OC_STACK_RESOURCE_DELETED:
683 case OC_STACK_INVALID_QUERY:
686 case OC_STACK_INVALID_OPTION:
689 case OC_STACK_NO_RESOURCE:
692 case OC_STACK_COMM_ERROR:
693 ret = CA_RETRANSMIT_TIMEOUT;
695 case OC_STACK_UNAUTHORIZED_REQ:
696 ret = CA_UNAUTHORIZED_REQ;
704 CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocFlags)
706 CATransportFlags_t caFlags = (CATransportFlags_t)ocFlags;
708 // supply default behavior.
709 if ((caFlags & (CA_IPV6|CA_IPV4)) == 0)
711 caFlags = (CATransportFlags_t)(caFlags|CA_IPV6|CA_IPV4);
713 if ((caFlags & OC_MASK_SCOPE) == 0)
715 caFlags = (CATransportFlags_t)(caFlags|OC_SCOPE_LINK);
720 OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caFlags)
722 return (OCTransportFlags)caFlags;
725 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds)
727 uint32_t lowerBound = 0;
728 uint32_t higherBound = 0;
730 if (!cbNode || !cbNode->presence || !cbNode->presence->timeOut)
732 return OC_STACK_INVALID_PARAM;
735 OIC_LOG_V(INFO, TAG, "Update presence TTL, time is %u", GetTicks(0));
737 cbNode->presence->TTL = maxAgeSeconds;
739 for (int index = 0; index < PresenceTimeOutSize; index++)
741 // Guard against overflow
742 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index]))
745 lowerBound = GetTicks((PresenceTimeOut[index] *
746 cbNode->presence->TTL *
747 MILLISECONDS_PER_SECOND)/100);
751 lowerBound = GetTicks(UINT32_MAX);
754 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index+1]))
757 higherBound = GetTicks((PresenceTimeOut[index + 1] *
758 cbNode->presence->TTL *
759 MILLISECONDS_PER_SECOND)/100);
763 higherBound = GetTicks(UINT32_MAX);
766 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
768 OIC_LOG_V(DEBUG, TAG, "lowerBound timeout %d", lowerBound);
769 OIC_LOG_V(DEBUG, TAG, "higherBound timeout %d", higherBound);
770 OIC_LOG_V(DEBUG, TAG, "timeOut entry %d", cbNode->presence->timeOut[index]);
773 cbNode->presence->TTLlevel = 0;
775 OIC_LOG_V(DEBUG, TAG, "this TTL level %d", cbNode->presence->TTLlevel);
779 const char *convertTriggerEnumToString(OCPresenceTrigger trigger)
781 if (trigger == OC_PRESENCE_TRIGGER_CREATE)
783 return OC_RSRVD_TRIGGER_CREATE;
785 else if (trigger == OC_PRESENCE_TRIGGER_CHANGE)
787 return OC_RSRVD_TRIGGER_CHANGE;
791 return OC_RSRVD_TRIGGER_DELETE;
795 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr)
799 return OC_PRESENCE_TRIGGER_CREATE;
801 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CREATE) == 0)
803 return OC_PRESENCE_TRIGGER_CREATE;
805 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CHANGE) == 0)
807 return OC_PRESENCE_TRIGGER_CHANGE;
811 return OC_PRESENCE_TRIGGER_DELETE;
816 * The cononical presence allows constructed URIs to be string compared.
818 * requestUri must be a char array of size CA_MAX_URI_LENGTH
820 static int FormCanonicalPresenceUri(const CAEndpoint_t *endpoint, char *resourceUri,
823 VERIFY_NON_NULL(endpoint , FATAL, OC_STACK_INVALID_PARAM);
824 VERIFY_NON_NULL(resourceUri, FATAL, OC_STACK_INVALID_PARAM);
825 VERIFY_NON_NULL(presenceUri, FATAL, OC_STACK_INVALID_PARAM);
827 CAEndpoint_t *ep = (CAEndpoint_t *)endpoint;
829 if (ep->adapter == CA_ADAPTER_IP)
831 if ((ep->flags & CA_IPV6) && !(ep->flags & CA_IPV4))
833 if ('\0' == ep->addr[0]) // multicast
835 return snprintf(presenceUri, CA_MAX_URI_LENGTH, OC_RSRVD_PRESENCE_URI);
839 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://[%s]:%u%s",
840 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
845 if ('\0' == ep->addr[0]) // multicast
847 OICStrcpy(ep->addr, sizeof(ep->addr), OC_MULTICAST_IP);
848 ep->port = OC_MULTICAST_PORT;
850 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s:%u%s",
851 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
855 // might work for other adapters (untested, but better than nothing)
856 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s%s", ep->addr,
857 OC_RSRVD_PRESENCE_URI);
861 OCStackResult HandlePresenceResponse(const CAEndpoint_t *endpoint,
862 const CAResponseInfo_t *responseInfo)
864 VERIFY_NON_NULL(endpoint, FATAL, OC_STACK_INVALID_PARAM);
865 VERIFY_NON_NULL(responseInfo, FATAL, OC_STACK_INVALID_PARAM);
867 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
868 ClientCB * cbNode = NULL;
869 char *resourceTypeName = NULL;
870 OCClientResponse response = {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
871 OCStackResult result = OC_STACK_ERROR;
874 char presenceUri[CA_MAX_URI_LENGTH];
876 int presenceSubscribe = 0;
877 int multicastPresenceSubscribe = 0;
879 if (responseInfo->result != CA_CONTENT)
881 OIC_LOG_V(ERROR, TAG, "HandlePresenceResponse failed %d", responseInfo->result);
882 return OC_STACK_ERROR;
885 // check for unicast presence
886 uriLen = FormCanonicalPresenceUri(endpoint, OC_RSRVD_PRESENCE_URI, presenceUri);
887 if (uriLen < 0 || (size_t)uriLen >= sizeof (presenceUri))
889 return OC_STACK_INVALID_URI;
892 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
895 presenceSubscribe = 1;
899 // check for multiicast presence
900 CAEndpoint_t ep = { .adapter = endpoint->adapter,
901 .flags = endpoint->flags };
903 uriLen = FormCanonicalPresenceUri(&ep, OC_RSRVD_PRESENCE_URI, presenceUri);
905 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
908 multicastPresenceSubscribe = 1;
912 if (!presenceSubscribe && !multicastPresenceSubscribe)
914 OIC_LOG(ERROR, TAG, "Received a presence notification, but no callback, ignoring");
918 response.payload = NULL;
919 response.result = OC_STACK_OK;
921 CopyEndpointToDevAddr(endpoint, &response.devAddr);
922 FixUpClientResponse(&response);
924 if (responseInfo->info.payload)
926 result = OCParsePayload(&response.payload,
927 PAYLOAD_TYPE_PRESENCE,
928 responseInfo->info.payload,
929 responseInfo->info.payloadSize);
931 if(result != OC_STACK_OK)
933 OIC_LOG(ERROR, TAG, "Presence parse failed");
936 if(!response.payload || response.payload->type != PAYLOAD_TYPE_PRESENCE)
938 OIC_LOG(ERROR, TAG, "Presence payload was wrong type");
939 result = OC_STACK_ERROR;
942 response.sequenceNumber = ((OCPresencePayload*)response.payload)->sequenceNumber;
943 resourceTypeName = ((OCPresencePayload*)response.payload)->resourceType;
944 maxAge = ((OCPresencePayload*)response.payload)->maxAge;
947 if (presenceSubscribe)
949 if(cbNode->sequenceNumber == response.sequenceNumber)
951 OIC_LOG(INFO, TAG, "No presence change");
952 ResetPresenceTTL(cbNode, maxAge);
953 OIC_LOG_V(INFO, TAG, "ResetPresenceTTL - TTLlevel:%d\n", cbNode->presence->TTLlevel);
959 OIC_LOG(INFO, TAG, "Stopping presence");
960 response.result = OC_STACK_PRESENCE_STOPPED;
963 OICFree(cbNode->presence->timeOut);
964 OICFree(cbNode->presence);
965 cbNode->presence = NULL;
970 if(!cbNode->presence)
972 cbNode->presence = (OCPresence *)OICMalloc(sizeof (OCPresence));
974 if(!(cbNode->presence))
976 OIC_LOG(ERROR, TAG, "Could not allocate memory for cbNode->presence");
977 result = OC_STACK_NO_MEMORY;
981 VERIFY_NON_NULL_V(cbNode->presence);
982 cbNode->presence->timeOut = NULL;
983 cbNode->presence->timeOut = (uint32_t *)
984 OICMalloc(PresenceTimeOutSize * sizeof(uint32_t));
985 if(!(cbNode->presence->timeOut)){
987 "Could not allocate memory for cbNode->presence->timeOut");
988 OICFree(cbNode->presence);
989 result = OC_STACK_NO_MEMORY;
994 ResetPresenceTTL(cbNode, maxAge);
996 cbNode->sequenceNumber = response.sequenceNumber;
998 // Ensure that a filter is actually applied.
999 if( resourceTypeName && cbNode->filterResourceType)
1001 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1010 // This is the multicast case
1011 OCMulticastNode* mcNode = NULL;
1012 mcNode = GetMCPresenceNode(presenceUri);
1016 if(mcNode->nonce == response.sequenceNumber)
1018 OIC_LOG(INFO, TAG, "No presence change (Multicast)");
1021 mcNode->nonce = response.sequenceNumber;
1025 OIC_LOG(INFO, TAG, "Stopping presence");
1026 response.result = OC_STACK_PRESENCE_STOPPED;
1031 char* uri = OICStrdup(presenceUri);
1035 "No Memory for URI to store in the presence node");
1036 result = OC_STACK_NO_MEMORY;
1040 result = AddMCPresenceNode(&mcNode, uri, response.sequenceNumber);
1041 if(result == OC_STACK_NO_MEMORY)
1044 "No Memory for Multicast Presence Node");
1048 // presence node now owns uri
1051 // Ensure that a filter is actually applied.
1052 if(resourceTypeName && cbNode->filterResourceType)
1054 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1061 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
1063 if (cbResult == OC_STACK_DELETE_TRANSACTION)
1065 FindAndDeleteClientCB(cbNode);
1069 OCPayloadDestroy(response.payload);
1073 void OCHandleResponse(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1075 OIC_LOG(DEBUG, TAG, "Enter OCHandleResponse");
1077 if(responseInfo->info.resourceUri &&
1078 strcmp(responseInfo->info.resourceUri, OC_RSRVD_PRESENCE_URI) == 0)
1080 HandlePresenceResponse(endPoint, responseInfo);
1084 ClientCB *cbNode = GetClientCB(responseInfo->info.token,
1085 responseInfo->info.tokenLength, NULL, NULL);
1087 ResourceObserver * observer = GetObserverUsingToken (responseInfo->info.token,
1088 responseInfo->info.tokenLength);
1092 OIC_LOG(INFO, TAG, "There is a cbNode associated with the response token");
1093 if(responseInfo->result == CA_EMPTY)
1095 OIC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1096 // We do not have a case for the client to receive a RESET
1097 if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1099 //This is the case of receiving an ACK on a request to a slow resource!
1100 OIC_LOG(INFO, TAG, "This is a pure ACK");
1101 //TODO: should we inform the client
1102 // app that at least the request was received at the server?
1105 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1107 OIC_LOG(INFO, TAG, "Receiving A Timeout for this token");
1108 OIC_LOG(INFO, TAG, "Calling into application address space");
1110 OCClientResponse response =
1111 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1112 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1113 FixUpClientResponse(&response);
1114 response.resourceUri = responseInfo->info.resourceUri;
1115 memcpy(response.identity.id, responseInfo->info.identity.id,
1116 sizeof (response.identity.id));
1117 response.identity.id_length = responseInfo->info.identity.id_length;
1119 response.result = CAToOCStackResult(responseInfo->result);
1120 cbNode->callBack(cbNode->context,
1121 cbNode->handle, &response);
1122 FindAndDeleteClientCB(cbNode);
1126 OIC_LOG(INFO, TAG, "This is a regular response, A client call back is found");
1127 OIC_LOG(INFO, TAG, "Calling into application address space");
1129 OCClientResponse response =
1130 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1131 response.sequenceNumber = OC_OBSERVE_NO_OPTION;
1132 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1133 FixUpClientResponse(&response);
1134 response.resourceUri = responseInfo->info.resourceUri;
1135 memcpy(response.identity.id, responseInfo->info.identity.id,
1136 sizeof (response.identity.id));
1137 response.identity.id_length = responseInfo->info.identity.id_length;
1139 response.result = CAToOCStackResult(responseInfo->result);
1141 if(responseInfo->info.payload &&
1142 responseInfo->info.payloadSize)
1144 OCPayloadType type = PAYLOAD_TYPE_INVALID;
1145 // check the security resource
1146 if (SRMIsSecurityResourceURI(cbNode->requestUri))
1148 type = PAYLOAD_TYPE_SECURITY;
1150 else if (cbNode->method == OC_REST_DISCOVER)
1152 if (strncmp(OC_RSRVD_WELL_KNOWN_URI,cbNode->requestUri,
1153 sizeof(OC_RSRVD_WELL_KNOWN_URI) - 1) == 0)
1155 type = PAYLOAD_TYPE_DISCOVERY;
1157 else if (strcmp(cbNode->requestUri, OC_RSRVD_DEVICE_URI) == 0)
1159 type = PAYLOAD_TYPE_DEVICE;
1161 else if (strcmp(cbNode->requestUri, OC_RSRVD_PLATFORM_URI) == 0)
1163 type = PAYLOAD_TYPE_PLATFORM;
1165 #ifdef ROUTING_GATEWAY
1166 else if (strcmp(cbNode->requestUri, OC_RSRVD_GATEWAY_URI) == 0)
1168 type = PAYLOAD_TYPE_REPRESENTATION;
1171 else if (strcmp(cbNode->requestUri, OC_RSRVD_RD_URI) == 0)
1173 type = PAYLOAD_TYPE_RD;
1176 else if (strcmp(cbNode->requestUri, KEEPALIVE_RESOURCE_URI) == 0)
1178 type = PAYLOAD_TYPE_REPRESENTATION;
1183 OIC_LOG_V(ERROR, TAG, "Unknown Payload type in Discovery: %d %s",
1184 cbNode->method, cbNode->requestUri);
1188 else if (cbNode->method == OC_REST_GET ||
1189 cbNode->method == OC_REST_PUT ||
1190 cbNode->method == OC_REST_POST ||
1191 cbNode->method == OC_REST_OBSERVE ||
1192 cbNode->method == OC_REST_OBSERVE_ALL ||
1193 cbNode->method == OC_REST_DELETE)
1195 char targetUri[MAX_URI_LENGTH];
1196 snprintf(targetUri, MAX_URI_LENGTH, "%s?rt=%s", OC_RSRVD_RD_URI,
1197 OC_RSRVD_RESOURCE_TYPE_RDPUBLISH);
1198 if (strcmp(targetUri, cbNode->requestUri) == 0)
1200 type = PAYLOAD_TYPE_RD;
1202 else if (strcmp(OC_RSRVD_PLATFORM_URI, cbNode->requestUri) == 0)
1204 type = PAYLOAD_TYPE_PLATFORM;
1206 else if (strcmp(OC_RSRVD_DEVICE_URI, cbNode->requestUri) == 0)
1208 type = PAYLOAD_TYPE_DEVICE;
1210 if (type == PAYLOAD_TYPE_INVALID)
1212 OIC_LOG_V(INFO, TAG, "Assuming PAYLOAD_TYPE_REPRESENTATION: %d %s",
1213 cbNode->method, cbNode->requestUri);
1214 type = PAYLOAD_TYPE_REPRESENTATION;
1219 OIC_LOG_V(ERROR, TAG, "Unknown Payload type: %d %s",
1220 cbNode->method, cbNode->requestUri);
1224 if(OC_STACK_OK != OCParsePayload(&response.payload,
1226 responseInfo->info.payload,
1227 responseInfo->info.payloadSize))
1229 OIC_LOG(ERROR, TAG, "Error converting payload");
1230 OCPayloadDestroy(response.payload);
1235 response.numRcvdVendorSpecificHeaderOptions = 0;
1236 if(responseInfo->info.numOptions > 0)
1239 //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
1240 if(responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
1243 uint32_t observationOption;
1244 uint8_t* optionData = (uint8_t*)responseInfo->info.options[0].optionData;
1245 for (observationOption=0, i=0;
1246 i<sizeof(uint32_t) && i<responseInfo->info.options[0].optionLength;
1250 (observationOption << 8) | optionData[i];
1252 response.sequenceNumber = observationOption;
1254 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
1259 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
1262 if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
1264 OIC_LOG(ERROR, TAG, "#header options are more than MAX_HEADER_OPTIONS");
1265 OCPayloadDestroy(response.payload);
1269 for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
1271 memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
1272 &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
1276 if (cbNode->method == OC_REST_OBSERVE &&
1277 response.sequenceNumber > OC_OFFSET_SEQUENCE_NUMBER &&
1278 response.sequenceNumber <= cbNode->sequenceNumber)
1280 OIC_LOG_V(INFO, TAG, "Received stale notification. Number :%d",
1281 response.sequenceNumber);
1285 OCStackApplicationResult appFeedback = cbNode->callBack(cbNode->context,
1288 cbNode->sequenceNumber = response.sequenceNumber;
1290 if (appFeedback == OC_STACK_DELETE_TRANSACTION)
1292 FindAndDeleteClientCB(cbNode);
1296 // To keep discovery callbacks active.
1297 cbNode->TTL = GetTicks(MAX_CB_TIMEOUT_SECONDS *
1298 MILLISECONDS_PER_SECOND);
1302 //Need to send ACK when the response is CON
1303 if(responseInfo->info.type == CA_MSG_CONFIRM)
1305 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1306 CA_MSG_ACKNOWLEDGE, 0, NULL, NULL, 0, NULL);
1309 OCPayloadDestroy(response.payload);
1316 OIC_LOG(INFO, TAG, "There is an observer associated with the response token");
1317 if(responseInfo->result == CA_EMPTY)
1319 OIC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1320 if(responseInfo->info.type == CA_MSG_RESET)
1322 OIC_LOG(INFO, TAG, "This is a RESET");
1323 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1324 OC_OBSERVER_NOT_INTERESTED);
1326 else if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1328 OIC_LOG(INFO, TAG, "This is a pure ACK");
1329 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1330 OC_OBSERVER_STILL_INTERESTED);
1333 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1335 OIC_LOG(INFO, TAG, "Receiving Time Out for an observer");
1336 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1337 OC_OBSERVER_FAILED_COMM);
1342 if(!cbNode && !observer)
1344 if(myStackMode == OC_CLIENT || myStackMode == OC_CLIENT_SERVER
1345 || myStackMode == OC_GATEWAY)
1347 OIC_LOG(INFO, TAG, "This is a client, but no cbNode was found for token");
1348 if(responseInfo->result == CA_EMPTY)
1350 OIC_LOG(INFO, TAG, "Receiving CA_EMPTY in the ocstack");
1354 OIC_LOG(INFO, TAG, "Received a message without callbacks. Sending RESET");
1355 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1356 CA_MSG_RESET, 0, NULL, NULL, 0, NULL);
1360 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER
1361 || myStackMode == OC_GATEWAY)
1363 OIC_LOG(INFO, TAG, "This is a server, but no observer was found for token");
1364 if (responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1366 OIC_LOG_V(INFO, TAG, "Received ACK at server for messageId : %d",
1367 responseInfo->info.messageId);
1369 if (responseInfo->info.type == CA_MSG_RESET)
1371 OIC_LOG_V(INFO, TAG, "Received RESET at server for messageId : %d",
1372 responseInfo->info.messageId);
1379 OIC_LOG(INFO, TAG, "Exit HandleCAResponses");
1382 void HandleCAResponses(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1384 VERIFY_NON_NULL_NR(endPoint, FATAL);
1385 VERIFY_NON_NULL_NR(responseInfo, FATAL);
1387 OIC_LOG(INFO, TAG, "Enter HandleCAResponses");
1389 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1390 #ifdef ROUTING_GATEWAY
1391 bool needRIHandling = false;
1393 * Routing manager is going to update either of endpoint or response or both.
1394 * This typecasting is done to avoid unnecessary duplication of Endpoint and responseInfo
1395 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1398 OCStackResult ret = RMHandleResponse((CAResponseInfo_t *)responseInfo, (CAEndpoint_t *)endPoint,
1400 if(ret != OC_STACK_OK || !needRIHandling)
1402 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1408 * Put source in sender endpoint so that the next packet from application can be routed to
1409 * proper destination and remove "RM" coap header option before passing request / response to
1410 * RI as this option will make no sense to either RI or application.
1412 RMUpdateInfo((CAHeaderOption_t **) &(responseInfo->info.options),
1413 (uint8_t *) &(responseInfo->info.numOptions),
1414 (CAEndpoint_t *) endPoint);
1417 OCHandleResponse(endPoint, responseInfo);
1419 OIC_LOG(INFO, TAG, "Exit HandleCAResponses");
1423 * This function handles error response from CA
1424 * code shall be added to handle the errors
1426 void HandleCAErrorResponse(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errrorInfo)
1428 OIC_LOG(INFO, TAG, "Enter HandleCAErrorResponse");
1430 if(NULL == endPoint)
1432 OIC_LOG(ERROR, TAG, "endPoint is NULL");
1436 if(NULL == errrorInfo)
1438 OIC_LOG(ERROR, TAG, "errrorInfo is NULL");
1441 OIC_LOG(INFO, TAG, "Exit HandleCAErrorResponse");
1445 * This function sends out Direct Stack Responses. These are responses that are not coming
1446 * from the application entity handler. These responses have no payload and are usually ACKs,
1447 * RESETs or some error conditions that were caught by the stack.
1449 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
1450 const CAResponseResult_t responseResult, const CAMessageType_t type,
1451 const uint8_t numOptions, const CAHeaderOption_t *options,
1452 CAToken_t token, uint8_t tokenLength, const char *resourceUri)
1454 OIC_LOG(DEBUG, TAG, "Entering SendDirectStackResponse");
1455 CAResponseInfo_t respInfo = {
1456 .result = responseResult
1458 respInfo.info.messageId = coapID;
1459 respInfo.info.numOptions = numOptions;
1461 if (respInfo.info.numOptions)
1463 respInfo.info.options =
1464 (CAHeaderOption_t *)OICCalloc(respInfo.info.numOptions, sizeof(CAHeaderOption_t));
1465 memcpy (respInfo.info.options, options,
1466 sizeof(CAHeaderOption_t) * respInfo.info.numOptions);
1470 respInfo.info.payload = NULL;
1471 respInfo.info.token = token;
1472 respInfo.info.tokenLength = tokenLength;
1473 respInfo.info.type = type;
1474 respInfo.info.resourceUri = OICStrdup (resourceUri);
1475 respInfo.info.acceptFormat = CA_FORMAT_UNDEFINED;
1477 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1478 // Add the destination to route option from the endpoint->routeData.
1479 bool doPost = false;
1480 OCStackResult result = RMAddInfo(endPoint->routeData, &respInfo, false, &doPost);
1481 if(OC_STACK_OK != result)
1483 OIC_LOG_V(ERROR, TAG, "Add routing option failed [%d]", result);
1488 OIC_LOG(DEBUG, TAG, "Sending a POST message for EMPTY ACK in Client Mode");
1489 CARequestInfo_t reqInfo = {.method = CA_POST };
1490 /* The following initialization is not done in a single initializer block as in
1491 * arduino, .c file is compiled as .cpp and moves it from C99 to C++11. The latter
1492 * does not have designated initalizers. This is a work-around for now.
1494 reqInfo.info.type = CA_MSG_NONCONFIRM;
1495 reqInfo.info.messageId = coapID;
1496 reqInfo.info.tokenLength = tokenLength;
1497 reqInfo.info.token = token;
1498 reqInfo.info.numOptions = respInfo.info.numOptions;
1499 reqInfo.info.payload = NULL;
1500 reqInfo.info.resourceUri = OICStrdup (OC_RSRVD_GATEWAY_URI);
1501 if (reqInfo.info.numOptions)
1503 reqInfo.info.options =
1504 (CAHeaderOption_t *)OICCalloc(reqInfo.info.numOptions, sizeof(CAHeaderOption_t));
1505 if (NULL == reqInfo.info.options)
1507 OIC_LOG(ERROR, TAG, "Calloc failed");
1508 return OC_STACK_NO_MEMORY;
1510 memcpy (reqInfo.info.options, respInfo.info.options,
1511 sizeof(CAHeaderOption_t) * reqInfo.info.numOptions);
1514 CAResult_t caResult = CASendRequest(endPoint, &reqInfo);
1515 OICFree (reqInfo.info.resourceUri);
1516 OICFree (reqInfo.info.options);
1517 OICFree (respInfo.info.resourceUri);
1518 OICFree (respInfo.info.options);
1519 if (CA_STATUS_OK != caResult)
1521 OIC_LOG(ERROR, TAG, "CASendRequest error");
1522 return CAResultToOCResult(caResult);
1528 CAResult_t caResult = CASendResponse(endPoint, &respInfo);
1530 // resourceUri in the info field is cloned in the CA layer and
1531 // thus ownership is still here.
1532 OICFree (respInfo.info.resourceUri);
1533 OICFree (respInfo.info.options);
1534 if(CA_STATUS_OK != caResult)
1536 OIC_LOG(ERROR, TAG, "CASendResponse error");
1537 return CAResultToOCResult(caResult);
1540 OIC_LOG(DEBUG, TAG, "Exit SendDirectStackResponse");
1544 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
1546 OIC_LOG(INFO, TAG, "Entering HandleStackRequests (OCStack Layer)");
1547 OCStackResult result = OC_STACK_ERROR;
1548 if(!protocolRequest)
1550 OIC_LOG(ERROR, TAG, "protocolRequest is NULL");
1551 return OC_STACK_INVALID_PARAM;
1554 OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken,
1555 protocolRequest->tokenLength);
1558 OIC_LOG(INFO, TAG, "This is a new Server Request");
1559 result = AddServerRequest(&request, protocolRequest->coapID,
1560 protocolRequest->delayedResNeeded, 0, protocolRequest->method,
1561 protocolRequest->numRcvdVendorSpecificHeaderOptions,
1562 protocolRequest->observationOption, protocolRequest->qos,
1563 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
1564 protocolRequest->payload, protocolRequest->requestToken,
1565 protocolRequest->tokenLength, protocolRequest->resourceUrl,
1566 protocolRequest->reqTotalSize, protocolRequest->acceptFormat,
1567 &protocolRequest->devAddr);
1568 if (OC_STACK_OK != result)
1570 OIC_LOG(ERROR, TAG, "Error adding server request");
1576 OIC_LOG(ERROR, TAG, "Out of Memory");
1577 return OC_STACK_NO_MEMORY;
1580 if(!protocolRequest->reqMorePacket)
1582 request->requestComplete = 1;
1587 OIC_LOG(INFO, TAG, "This is either a repeated or blocked Server Request");
1590 if(request->requestComplete)
1592 OIC_LOG(INFO, TAG, "This Server Request is complete");
1593 ResourceHandling resHandling = OC_RESOURCE_VIRTUAL;
1594 OCResource *resource = NULL;
1595 result = DetermineResourceHandling (request, &resHandling, &resource);
1596 if (result == OC_STACK_OK)
1598 result = ProcessRequest(resHandling, resource, request);
1603 OIC_LOG(INFO, TAG, "This Server Request is incomplete");
1604 result = OC_STACK_CONTINUE;
1609 void OCHandleRequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1611 OIC_LOG(DEBUG, TAG, "Enter OCHandleRequests");
1614 if (requestInfo->info.resourceUri &&
1615 strcmp(requestInfo->info.resourceUri, KEEPALIVE_RESOURCE_URI) == 0)
1617 HandleKeepAliveRequest(endPoint, requestInfo);
1622 OCStackResult requestResult = OC_STACK_ERROR;
1624 if(myStackMode == OC_CLIENT)
1626 //TODO: should the client be responding to requests?
1630 OCServerProtocolRequest serverRequest = {0};
1632 OIC_LOG_V(INFO, TAG, "Endpoint URI : %s", requestInfo->info.resourceUri);
1634 char * uriWithoutQuery = NULL;
1635 char * query = NULL;
1637 requestResult = getQueryFromUri(requestInfo->info.resourceUri, &query, &uriWithoutQuery);
1639 if (requestResult != OC_STACK_OK || !uriWithoutQuery)
1641 OIC_LOG_V(ERROR, TAG, "getQueryFromUri() failed with OC error code %d\n", requestResult);
1644 OIC_LOG_V(INFO, TAG, "URI without query: %s", uriWithoutQuery);
1645 OIC_LOG_V(INFO, TAG, "Query : %s", query);
1647 if(strlen(uriWithoutQuery) < MAX_URI_LENGTH)
1649 OICStrcpy(serverRequest.resourceUrl, sizeof(serverRequest.resourceUrl), uriWithoutQuery);
1650 OICFree(uriWithoutQuery);
1654 OIC_LOG(ERROR, TAG, "URI length exceeds MAX_URI_LENGTH.");
1655 OICFree(uriWithoutQuery);
1662 if(strlen(query) < MAX_QUERY_LENGTH)
1664 OICStrcpy(serverRequest.query, sizeof(serverRequest.query), query);
1669 OIC_LOG(ERROR, TAG, "Query length exceeds MAX_QUERY_LENGTH.");
1675 if ((requestInfo->info.payload) && (0 < requestInfo->info.payloadSize))
1677 serverRequest.reqTotalSize = requestInfo->info.payloadSize;
1678 serverRequest.payload = (uint8_t *) OICMalloc(requestInfo->info.payloadSize);
1679 memcpy (serverRequest.payload, requestInfo->info.payload,
1680 requestInfo->info.payloadSize);
1684 serverRequest.reqTotalSize = 0;
1687 switch (requestInfo->method)
1690 serverRequest.method = OC_REST_GET;
1693 serverRequest.method = OC_REST_PUT;
1696 serverRequest.method = OC_REST_POST;
1699 serverRequest.method = OC_REST_DELETE;
1702 OIC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1703 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1704 requestInfo->info.type, requestInfo->info.numOptions,
1705 requestInfo->info.options, requestInfo->info.token,
1706 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1707 OICFree(serverRequest.payload);
1711 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1712 requestInfo->info.tokenLength);
1714 serverRequest.tokenLength = requestInfo->info.tokenLength;
1715 if (serverRequest.tokenLength) {
1717 serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1719 if (!serverRequest.requestToken)
1721 OIC_LOG(FATAL, TAG, "Allocation for token failed.");
1722 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1723 requestInfo->info.type, requestInfo->info.numOptions,
1724 requestInfo->info.options, requestInfo->info.token,
1725 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1726 OICFree(serverRequest.payload);
1729 memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1732 switch (requestInfo->info.acceptFormat)
1734 case CA_FORMAT_APPLICATION_CBOR:
1735 serverRequest.acceptFormat = OC_FORMAT_CBOR;
1737 case CA_FORMAT_UNDEFINED:
1738 serverRequest.acceptFormat = OC_FORMAT_UNDEFINED;
1741 serverRequest.acceptFormat = OC_FORMAT_UNSUPPORTED;
1744 if (requestInfo->info.type == CA_MSG_CONFIRM)
1746 serverRequest.qos = OC_HIGH_QOS;
1750 serverRequest.qos = OC_LOW_QOS;
1752 // CA does not need the following field
1753 // Are we sure CA does not need them? how is it responding to multicast
1754 serverRequest.delayedResNeeded = 0;
1756 serverRequest.coapID = requestInfo->info.messageId;
1758 CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1760 // copy vendor specific header options
1761 uint8_t tempNum = (requestInfo->info.numOptions);
1763 // Assume no observation requested and it is a pure GET.
1764 // If obs registration/de-registration requested it'll be fetched from the
1765 // options in GetObserveHeaderOption()
1766 serverRequest.observationOption = OC_OBSERVE_NO_OPTION;
1768 GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1769 if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1772 "The request info numOptions is greater than MAX_HEADER_OPTIONS");
1773 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1774 requestInfo->info.type, requestInfo->info.numOptions,
1775 requestInfo->info.options, requestInfo->info.token,
1776 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1777 OICFree(serverRequest.payload);
1778 OICFree(serverRequest.requestToken);
1781 serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1782 if (serverRequest.numRcvdVendorSpecificHeaderOptions)
1784 memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1785 sizeof(CAHeaderOption_t)*tempNum);
1788 requestResult = HandleStackRequests (&serverRequest);
1790 // Send ACK to client as precursor to slow response
1791 if (requestResult == OC_STACK_SLOW_RESOURCE)
1793 if (requestInfo->info.type == CA_MSG_CONFIRM)
1795 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1796 CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0, NULL);
1799 else if(requestResult != OC_STACK_OK)
1801 OIC_LOG_V(ERROR, TAG, "HandleStackRequests failed. error: %d", requestResult);
1803 CAResponseResult_t stackResponse =
1804 OCToCAStackResult(requestResult, serverRequest.method);
1806 SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1807 requestInfo->info.type, requestInfo->info.numOptions,
1808 requestInfo->info.options, requestInfo->info.token,
1809 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1811 // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1812 // The token is copied in there, and is thus still owned by this function.
1813 OICFree(serverRequest.payload);
1814 OICFree(serverRequest.requestToken);
1815 OIC_LOG(INFO, TAG, "Exit OCHandleRequests");
1818 //This function will be called back by CA layer when a request is received
1819 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1821 OIC_LOG(INFO, TAG, "Enter HandleCARequests");
1824 OIC_LOG(ERROR, TAG, "endPoint is NULL");
1830 OIC_LOG(ERROR, TAG, "requestInfo is NULL");
1834 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1835 #ifdef ROUTING_GATEWAY
1836 bool needRIHandling = false;
1837 bool isEmptyMsg = false;
1839 * Routing manager is going to update either of endpoint or request or both.
1840 * This typecasting is done to avoid unnecessary duplication of Endpoint and requestInfo
1841 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1842 * destination. It can also remove "RM" coap header option before passing request / response to
1843 * RI as this option will make no sense to either RI or application.
1845 OCStackResult ret = RMHandleRequest((CARequestInfo_t *)requestInfo, (CAEndpoint_t *)endPoint,
1846 &needRIHandling, &isEmptyMsg);
1847 if(OC_STACK_OK != ret || !needRIHandling)
1849 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1855 * Put source in sender endpoint so that the next packet from application can be routed to
1856 * proper destination and remove RM header option.
1858 RMUpdateInfo((CAHeaderOption_t **) &(requestInfo->info.options),
1859 (uint8_t *) &(requestInfo->info.numOptions),
1860 (CAEndpoint_t *) endPoint);
1862 #ifdef ROUTING_GATEWAY
1866 * In Gateways, the MSGType in route option is used to check if the actual
1867 * response is EMPTY message(4 bytes CoAP Header). In case of Client, the
1868 * EMPTY response is sent in the form of POST request which need to be changed
1869 * to a EMPTY response by RM. This translation is done in this part of the code.
1871 OIC_LOG(INFO, TAG, "This is a Empty response from the Client");
1872 CAResponseInfo_t respInfo = {.result = CA_EMPTY,
1873 .info.messageId = requestInfo->info.messageId,
1874 .info.type = CA_MSG_ACKNOWLEDGE};
1875 OCHandleResponse(endPoint, &respInfo);
1881 // Normal handling of the packet
1882 OCHandleRequests(endPoint, requestInfo);
1884 OIC_LOG(INFO, TAG, "Exit HandleCARequests");
1887 bool validatePlatformInfo(OCPlatformInfo info)
1890 if (!info.platformID)
1892 OIC_LOG(ERROR, TAG, "No platform ID found.");
1896 if (info.manufacturerName)
1898 size_t lenManufacturerName = strlen(info.manufacturerName);
1900 if(lenManufacturerName == 0 || lenManufacturerName > MAX_MANUFACTURER_NAME_LENGTH)
1902 OIC_LOG(ERROR, TAG, "Manufacturer name fails length requirements.");
1908 OIC_LOG(ERROR, TAG, "No manufacturer name present");
1912 if (info.manufacturerUrl)
1914 if(strlen(info.manufacturerUrl) > MAX_MANUFACTURER_URL_LENGTH)
1916 OIC_LOG(ERROR, TAG, "Manufacturer url fails length requirements.");
1923 //-----------------------------------------------------------------------------
1925 //-----------------------------------------------------------------------------
1927 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
1930 !raInfo->username ||
1931 !raInfo->hostname ||
1932 !raInfo->xmpp_domain)
1935 return OC_STACK_INVALID_PARAM;
1937 OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
1938 gRASetInfo = (result == OC_STACK_OK)? true : false;
1944 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1948 return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
1951 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
1953 if(stackState == OC_STACK_INITIALIZED)
1955 OIC_LOG(INFO, TAG, "Subsequent calls to OCInit() without calling \
1956 OCStop() between them are ignored.");
1960 #ifndef ROUTING_GATEWAY
1961 if (OC_GATEWAY == mode)
1963 OIC_LOG(ERROR, TAG, "Routing Manager not supported");
1964 return OC_STACK_INVALID_PARAM;
1971 OIC_LOG(ERROR, TAG, "Need to call OCSetRAInfo before calling OCInit");
1972 return OC_STACK_ERROR;
1976 OCStackResult result = OC_STACK_ERROR;
1977 OIC_LOG(INFO, TAG, "Entering OCInit");
1980 if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)
1981 || (mode == OC_GATEWAY)))
1983 OIC_LOG(ERROR, TAG, "Invalid mode");
1984 return OC_STACK_ERROR;
1988 if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1990 caglobals.client = true;
1992 if (mode == OC_SERVER || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1994 caglobals.server = true;
1997 caglobals.serverFlags = (CATransportFlags_t)serverFlags;
1998 if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
2000 caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4|CA_IPV6);
2002 caglobals.clientFlags = (CATransportFlags_t)clientFlags;
2003 if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
2005 caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4|CA_IPV6);
2008 defaultDeviceHandler = NULL;
2009 defaultDeviceHandlerCallbackParameter = NULL;
2011 result = CAResultToOCResult(CAInitialize());
2012 VERIFY_SUCCESS(result, OC_STACK_OK);
2014 result = CAResultToOCResult(OCSelectNetwork());
2015 VERIFY_SUCCESS(result, OC_STACK_OK);
2017 switch (myStackMode)
2020 CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2021 result = CAResultToOCResult(CAStartDiscoveryServer());
2022 OIC_LOG(INFO, TAG, "Client mode: CAStartDiscoveryServer");
2025 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2026 result = CAResultToOCResult(CAStartListeningServer());
2027 OIC_LOG(INFO, TAG, "Server mode: CAStartListeningServer");
2029 case OC_CLIENT_SERVER:
2031 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2032 result = CAResultToOCResult(CAStartListeningServer());
2033 if(result == OC_STACK_OK)
2035 result = CAResultToOCResult(CAStartDiscoveryServer());
2039 VERIFY_SUCCESS(result, OC_STACK_OK);
2042 CARegisterKeepAliveHandler(HandleKeepAliveConnCB, HandleKeepAliveDisconnCB);
2045 #ifdef WITH_PRESENCE
2046 PresenceTimeOutSize = sizeof (PresenceTimeOut) / sizeof (PresenceTimeOut[0]) - 1;
2047 #endif // WITH_PRESENCE
2049 //Update Stack state to initialized
2050 stackState = OC_STACK_INITIALIZED;
2052 // Initialize resource
2053 if(myStackMode != OC_CLIENT)
2055 result = initResources();
2058 // Initialize the SRM Policy Engine
2059 if(result == OC_STACK_OK)
2061 result = SRMInitPolicyEngine();
2062 // TODO after BeachHead delivery: consolidate into single SRMInit()
2064 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
2065 RMSetStackMode(mode);
2066 #ifdef ROUTING_GATEWAY
2067 if (OC_GATEWAY == myStackMode)
2069 result = RMInitialize();
2075 if(result == OC_STACK_OK)
2077 result = InitializeKeepAlive(myStackMode);
2082 if(result != OC_STACK_OK)
2084 OIC_LOG(ERROR, TAG, "Stack initialization error");
2085 deleteAllResources();
2087 stackState = OC_STACK_UNINITIALIZED;
2092 OCStackResult OCStop()
2094 OIC_LOG(INFO, TAG, "Entering OCStop");
2096 if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
2098 OIC_LOG(DEBUG, TAG, "Stack already stopping, exiting");
2101 else if (stackState != OC_STACK_INITIALIZED)
2103 OIC_LOG(ERROR, TAG, "Stack not initialized");
2104 return OC_STACK_ERROR;
2107 stackState = OC_STACK_UNINIT_IN_PROGRESS;
2109 #ifdef WITH_PRESENCE
2110 // Ensure that the TTL associated with ANY and ALL presence notifications originating from
2111 // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
2112 presenceResource.presenceTTL = 0;
2113 #endif // WITH_PRESENCE
2115 #ifdef ROUTING_GATEWAY
2116 if (OC_GATEWAY == myStackMode)
2123 TerminateKeepAlive(myStackMode);
2126 // Free memory dynamically allocated for resources
2127 deleteAllResources();
2129 DeletePlatformInfo();
2131 // Remove all observers
2132 DeleteObserverList();
2133 // Remove all the client callbacks
2134 DeleteClientCBList();
2136 // De-init the SRM Policy Engine
2137 // TODO after BeachHead delivery: consolidate into single SRMDeInit()
2138 SRMDeInitPolicyEngine();
2141 stackState = OC_STACK_UNINITIALIZED;
2145 OCStackResult OCStartMulticastServer()
2147 if(stackState != OC_STACK_INITIALIZED)
2149 OIC_LOG(ERROR, TAG, "OCStack is not initalized. Cannot start multicast server.");
2150 return OC_STACK_ERROR;
2152 CAResult_t ret = CAStartListeningServer();
2153 if (CA_STATUS_OK != ret)
2155 OIC_LOG_V(ERROR, TAG, "Failed starting listening server: %d", ret);
2156 return OC_STACK_ERROR;
2161 OCStackResult OCStopMulticastServer()
2163 CAResult_t ret = CAStopListeningServer();
2164 if (CA_STATUS_OK != ret)
2166 OIC_LOG_V(ERROR, TAG, "Failed stopping listening server: %d", ret);
2167 return OC_STACK_ERROR;
2172 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
2177 return CA_MSG_CONFIRM;
2182 return CA_MSG_NONCONFIRM;
2186 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
2190 query = strchr (inputUri, '?');
2194 if((query - inputUri) > MAX_URI_LENGTH)
2196 return OC_STACK_INVALID_URI;
2199 if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
2201 return OC_STACK_INVALID_QUERY;
2204 else if(uriLen > MAX_URI_LENGTH)
2206 return OC_STACK_INVALID_URI;
2212 * A request uri consists of the following components in order:
2215 * CoAP over UDP prefix "coap://"
2216 * CoAP over TCP prefix "coap+tcp://"
2218 * IPv6 address "[1234::5678]"
2219 * IPv4 address "192.168.1.1"
2220 * optional port ":5683"
2221 * resource uri "/oc/core..."
2223 * for PRESENCE requests, extract resource type.
2225 static OCStackResult ParseRequestUri(const char *fullUri,
2226 OCTransportAdapter adapter,
2227 OCTransportFlags flags,
2228 OCDevAddr **devAddr,
2230 char **resourceType)
2232 VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
2234 OCStackResult result = OC_STACK_OK;
2235 OCDevAddr *da = NULL;
2239 // provide defaults for all returned values
2246 *resourceUri = NULL;
2250 *resourceType = NULL;
2253 // delimit url prefix, if any
2254 const char *start = fullUri;
2255 char *slash2 = strstr(start, "//");
2260 char *slash = strchr(start, '/');
2263 return OC_STACK_INVALID_URI;
2266 // process url scheme
2267 size_t prefixLen = slash2 - fullUri;
2271 if ((prefixLen == sizeof(COAP_TCP) - 1) && (!strncmp(fullUri, COAP_TCP, prefixLen)))
2277 // TODO: this logic should come in with unit tests exercising the various strings
2278 // processs url prefix, if any
2279 size_t urlLen = slash - start;
2283 if (urlLen && devAddr)
2284 { // construct OCDevAddr
2285 if (start[0] == '[')
2287 char *close = strchr(++start, ']');
2288 if (!close || close > slash)
2290 return OC_STACK_INVALID_URI;
2293 if (close[1] == ':')
2297 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2298 flags = (OCTransportFlags)(flags | OC_IP_USE_V6);
2302 char *dot = strchr(start, '.');
2303 if (dot && dot < slash)
2305 colon = strchr(start, ':');
2306 end = (colon && colon < slash) ? colon : slash;
2310 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2314 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2315 flags = (OCTransportFlags)(flags | OC_IP_USE_V4);
2324 if (len >= sizeof(da->addr))
2326 return OC_STACK_INVALID_URI;
2328 // collect port, if any
2329 if (colon && colon < slash)
2331 for (colon++; colon < slash; colon++)
2334 if (c < '0' || c > '9')
2336 return OC_STACK_INVALID_URI;
2338 port = 10 * port + c - '0';
2343 if (len >= sizeof(da->addr))
2345 return OC_STACK_INVALID_URI;
2348 da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
2351 return OC_STACK_NO_MEMORY;
2353 OICStrcpyPartial(da->addr, sizeof(da->addr), start, len);
2355 da->adapter = adapter;
2357 if (!strncmp(fullUri, "coaps:", 6))
2359 da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
2364 // process resource uri, if any
2366 { // request uri and query
2367 size_t ulen = strlen(slash); // resource uri length
2368 size_t tlen = 0; // resource type length
2371 static const char strPresence[] = "/oic/ad?rt=";
2372 static const size_t lenPresence = sizeof(strPresence) - 1;
2373 if (!strncmp(slash, strPresence, lenPresence))
2375 type = slash + lenPresence;
2376 tlen = ulen - lenPresence;
2381 *resourceUri = (char *)OICMalloc(ulen + 1);
2384 result = OC_STACK_NO_MEMORY;
2387 strcpy(*resourceUri, slash);
2390 if (type && resourceType)
2392 *resourceType = (char *)OICMalloc(tlen + 1);
2395 result = OC_STACK_NO_MEMORY;
2399 OICStrcpy(*resourceType, (tlen+1), type);
2406 // free all returned values
2413 OICFree(*resourceUri);
2417 OICFree(*resourceType);
2422 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
2423 char *resourceUri, char **requestUri)
2425 char uri[CA_MAX_URI_LENGTH];
2427 FormCanonicalPresenceUri(endpoint, resourceUri, uri);
2429 *requestUri = OICStrdup(uri);
2432 return OC_STACK_NO_MEMORY;
2439 * Discover or Perform requests on a specified resource
2441 OCStackResult OCDoResource(OCDoHandle *handle,
2443 const char *requestUri,
2444 const OCDevAddr *destination,
2446 OCConnectivityType connectivityType,
2447 OCQualityOfService qos,
2448 OCCallbackData *cbData,
2449 OCHeaderOption *options,
2452 OIC_LOG(INFO, TAG, "Entering OCDoResource");
2454 // Validate input parameters
2455 VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
2456 VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
2457 VERIFY_NON_NULL(requestUri , FATAL, OC_STACK_INVALID_URI);
2459 OCStackResult result = OC_STACK_ERROR;
2460 CAResult_t caResult;
2461 CAToken_t token = NULL;
2462 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2463 ClientCB *clientCB = NULL;
2464 OCDoHandle resHandle = NULL;
2465 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2466 OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
2468 OCTransportAdapter adapter;
2469 OCTransportFlags flags;
2470 // the request contents are put here
2471 CARequestInfo_t requestInfo = {.method = CA_GET};
2472 // requestUri will be parsed into the following three variables
2473 OCDevAddr *devAddr = NULL;
2474 char *resourceUri = NULL;
2475 char *resourceType = NULL;
2478 * Support original behavior with address on resourceUri argument.
2480 adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2481 flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2483 result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2485 if (result != OC_STACK_OK)
2487 OIC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2494 case OC_REST_OBSERVE:
2495 case OC_REST_OBSERVE_ALL:
2496 case OC_REST_CANCEL_OBSERVE:
2497 requestInfo.method = CA_GET;
2500 requestInfo.method = CA_PUT;
2503 requestInfo.method = CA_POST;
2505 case OC_REST_DELETE:
2506 requestInfo.method = CA_DELETE;
2508 case OC_REST_DISCOVER:
2510 if (destination || devAddr)
2512 requestInfo.isMulticast = false;
2516 tmpDevAddr.adapter = adapter;
2517 tmpDevAddr.flags = flags;
2518 destination = &tmpDevAddr;
2519 requestInfo.isMulticast = true;
2521 // CA_DISCOVER will become GET and isMulticast
2522 requestInfo.method = CA_GET;
2524 #ifdef WITH_PRESENCE
2525 case OC_REST_PRESENCE:
2526 // Replacing method type with GET because "presence"
2527 // is a stack layer only implementation.
2528 requestInfo.method = CA_GET;
2532 result = OC_STACK_INVALID_METHOD;
2536 if (!devAddr && !destination)
2538 OIC_LOG(DEBUG, TAG, "no devAddr and no destination");
2539 result = OC_STACK_INVALID_PARAM;
2543 /* If not original behavior, use destination argument */
2544 if (destination && !devAddr)
2546 devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2549 result = OC_STACK_NO_MEMORY;
2552 *devAddr = *destination;
2555 resHandle = GenerateInvocationHandle();
2558 result = OC_STACK_NO_MEMORY;
2562 caResult = CAGenerateToken(&token, tokenLength);
2563 if (caResult != CA_STATUS_OK)
2565 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2566 result= OC_STACK_ERROR;
2570 // fill in request data
2571 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2572 requestInfo.info.token = token;
2573 requestInfo.info.tokenLength = tokenLength;
2574 requestInfo.info.resourceUri = resourceUri;
2576 if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2578 result = CreateObserveHeaderOption (&(requestInfo.info.options),
2579 options, numOptions, OC_OBSERVE_REGISTER);
2580 if (result != OC_STACK_OK)
2584 requestInfo.info.numOptions = numOptions + 1;
2588 requestInfo.info.numOptions = numOptions;
2589 requestInfo.info.options =
2590 (CAHeaderOption_t*) OICCalloc(numOptions, sizeof(CAHeaderOption_t));
2591 memcpy(requestInfo.info.options, (CAHeaderOption_t*)options,
2592 numOptions * sizeof(CAHeaderOption_t));
2595 CopyDevAddrToEndpoint(devAddr, &endpoint);
2600 OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2603 OIC_LOG(ERROR, TAG, "Failed to create CBOR Payload");
2606 requestInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
2610 requestInfo.info.payload = NULL;
2611 requestInfo.info.payloadSize = 0;
2612 requestInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
2615 if (result != OC_STACK_OK)
2617 OIC_LOG(ERROR, TAG, "CACreateEndpoint error");
2621 // prepare for response
2622 #ifdef WITH_PRESENCE
2623 if (method == OC_REST_PRESENCE)
2625 char *presenceUri = NULL;
2626 result = OCPreparePresence(&endpoint, resourceUri, &presenceUri);
2627 if (OC_STACK_OK != result)
2632 // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2633 // Presence notification will form a canonical uri to
2634 // look for callbacks into the application.
2635 resourceUri = presenceUri;
2639 ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2640 result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2641 method, devAddr, resourceUri, resourceType, ttl);
2642 if (OC_STACK_OK != result)
2647 devAddr = NULL; // Client CB list entry now owns it
2648 resourceUri = NULL; // Client CB list entry now owns it
2649 resourceType = NULL; // Client CB list entry now owns it
2652 result = OCSendRequest(&endpoint, &requestInfo);
2653 if (OC_STACK_OK != result)
2660 *handle = resHandle;
2664 if (result != OC_STACK_OK)
2666 OIC_LOG(ERROR, TAG, "OCDoResource error");
2667 FindAndDeleteClientCB(clientCB);
2668 CADestroyToken(token);
2676 // This is the owner of the payload object, so we free it
2677 OCPayloadDestroy(payload);
2678 OICFree(requestInfo.info.payload);
2680 OICFree(resourceUri);
2681 OICFree(resourceType);
2682 OICFree(requestInfo.info.options);
2686 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2690 * This ftn is implemented one of two ways in the case of observation:
2692 * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2693 * Remove the callback associated on client side.
2694 * When the next notification comes in from server,
2695 * reply with RESET message to server.
2696 * Keep in mind that the server will react to RESET only
2697 * if the last notification was sent as CON
2699 * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2700 * and it is associated with an observe request
2701 * (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2702 * Send CON Observe request to server with
2703 * observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2704 * Remove the callback associated on client side.
2706 OCStackResult ret = OC_STACK_OK;
2707 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2708 CARequestInfo_t requestInfo = {.method = CA_GET};
2712 return OC_STACK_INVALID_PARAM;
2715 ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2718 OIC_LOG(ERROR, TAG, "Callback not found. Called OCCancel on same resource twice?");
2719 return OC_STACK_ERROR;
2722 switch (clientCB->method)
2724 case OC_REST_OBSERVE:
2725 case OC_REST_OBSERVE_ALL:
2727 OIC_LOG_V(INFO, TAG, "Canceling observation for resource %s",
2728 clientCB->requestUri);
2729 if (qos != OC_HIGH_QOS)
2731 FindAndDeleteClientCB(clientCB);
2735 OIC_LOG(INFO, TAG, "Cancelling observation as CONFIRMABLE");
2737 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2738 requestInfo.info.token = clientCB->token;
2739 requestInfo.info.tokenLength = clientCB->tokenLength;
2741 if (CreateObserveHeaderOption (&(requestInfo.info.options),
2742 options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2744 return OC_STACK_ERROR;
2746 requestInfo.info.numOptions = numOptions + 1;
2747 requestInfo.info.resourceUri = OICStrdup (clientCB->requestUri);
2749 CopyDevAddrToEndpoint(clientCB->devAddr, &endpoint);
2751 ret = OCSendRequest(&endpoint, &requestInfo);
2753 if (requestInfo.info.options)
2755 OICFree (requestInfo.info.options);
2757 if (requestInfo.info.resourceUri)
2759 OICFree (requestInfo.info.resourceUri);
2764 case OC_REST_DISCOVER:
2765 OIC_LOG_V(INFO, TAG, "Cancelling discovery callback for resource %s",
2766 clientCB->requestUri);
2767 FindAndDeleteClientCB(clientCB);
2770 #ifdef WITH_PRESENCE
2771 case OC_REST_PRESENCE:
2772 FindAndDeleteClientCB(clientCB);
2777 ret = OC_STACK_INVALID_METHOD;
2785 * @brief Register Persistent storage callback.
2786 * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2788 * OC_STACK_OK - No errors; Success
2789 * OC_STACK_INVALID_PARAM - Invalid parameter
2791 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2793 OIC_LOG(INFO, TAG, "RegisterPersistentStorageHandler !!");
2794 if(!persistentStorageHandler)
2796 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2797 return OC_STACK_INVALID_PARAM;
2801 if( !persistentStorageHandler->open ||
2802 !persistentStorageHandler->close ||
2803 !persistentStorageHandler->read ||
2804 !persistentStorageHandler->unlink ||
2805 !persistentStorageHandler->write)
2807 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2808 return OC_STACK_INVALID_PARAM;
2811 return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2814 #ifdef WITH_PRESENCE
2816 OCStackResult OCProcessPresence()
2818 OCStackResult result = OC_STACK_OK;
2820 // the following line floods the log with messages that are irrelevant
2821 // to most purposes. Uncomment as needed.
2822 //OIC_LOG(INFO, TAG, "Entering RequestPresence");
2823 ClientCB* cbNode = NULL;
2824 OCClientResponse clientResponse;
2825 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2827 LL_FOREACH(cbList, cbNode)
2829 if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
2834 uint32_t now = GetTicks(0);
2835 OIC_LOG_V(DEBUG, TAG, "this TTL level %d",
2836 cbNode->presence->TTLlevel);
2837 OIC_LOG_V(DEBUG, TAG, "current ticks %d", now);
2839 if (cbNode->presence->TTLlevel > PresenceTimeOutSize)
2844 if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
2846 OIC_LOG_V(DEBUG, TAG, "timeout ticks %d",
2847 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2849 if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2851 OIC_LOG(DEBUG, TAG, "No more timeout ticks");
2853 clientResponse.sequenceNumber = 0;
2854 clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
2855 clientResponse.devAddr = *cbNode->devAddr;
2856 FixUpClientResponse(&clientResponse);
2857 clientResponse.payload = NULL;
2859 // Increment the TTLLevel (going to a next state), so we don't keep
2860 // sending presence notification to client.
2861 cbNode->presence->TTLlevel++;
2862 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
2863 cbNode->presence->TTLlevel);
2865 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
2866 if (cbResult == OC_STACK_DELETE_TRANSACTION)
2868 FindAndDeleteClientCB(cbNode);
2872 if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2877 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2878 CAInfo_t requestData = {.type = CA_MSG_CONFIRM};
2879 CARequestInfo_t requestInfo = {.method = CA_GET};
2881 OIC_LOG(DEBUG, TAG, "time to test server presence");
2883 CopyDevAddrToEndpoint(cbNode->devAddr, &endpoint);
2885 requestData.type = CA_MSG_NONCONFIRM;
2886 requestData.token = cbNode->token;
2887 requestData.tokenLength = cbNode->tokenLength;
2888 requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
2889 requestInfo.method = CA_GET;
2890 requestInfo.info = requestData;
2892 result = OCSendRequest(&endpoint, &requestInfo);
2893 if (OC_STACK_OK != result)
2898 cbNode->presence->TTLlevel++;
2899 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
2902 if (result != OC_STACK_OK)
2904 OIC_LOG(ERROR, TAG, "OCProcessPresence error");
2909 #endif // WITH_PRESENCE
2911 OCStackResult OCProcess()
2913 #ifdef WITH_PRESENCE
2914 OCProcessPresence();
2916 CAHandleRequestResponse();
2918 #ifdef ROUTING_GATEWAY
2928 #ifdef WITH_PRESENCE
2929 OCStackResult OCStartPresence(const uint32_t ttl)
2931 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2932 OCChangeResourceProperty(
2933 &(((OCResource *)presenceResource.handle)->resourceProperties),
2936 if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
2938 presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
2939 OIC_LOG(INFO, TAG, "Setting Presence TTL to max value");
2943 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
2944 OIC_LOG(INFO, TAG, "Setting Presence TTL to default value");
2948 presenceResource.presenceTTL = ttl;
2950 OIC_LOG_V(DEBUG, TAG, "Presence TTL is %" PRIu32 " seconds", presenceResource.presenceTTL);
2952 if (OC_PRESENCE_UNINITIALIZED == presenceState)
2954 presenceState = OC_PRESENCE_INITIALIZED;
2956 OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
2958 CAToken_t caToken = NULL;
2959 CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
2960 if (caResult != CA_STATUS_OK)
2962 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2963 CADestroyToken(caToken);
2964 return OC_STACK_ERROR;
2967 AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
2968 (OCResource *)presenceResource.handle, OC_LOW_QOS, OC_FORMAT_UNDEFINED, &devAddr);
2969 CADestroyToken(caToken);
2972 // Each time OCStartPresence is called
2973 // a different random 32-bit integer number is used
2974 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2976 return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
2977 OC_PRESENCE_TRIGGER_CREATE);
2980 OCStackResult OCStopPresence()
2982 OCStackResult result = OC_STACK_ERROR;
2984 if(presenceResource.handle)
2986 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2988 // make resource inactive
2989 result = OCChangeResourceProperty(
2990 &(((OCResource *) presenceResource.handle)->resourceProperties),
2994 if(result != OC_STACK_OK)
2997 "Changing the presence resource properties to ACTIVE not successful");
3001 return SendStopNotification();
3005 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
3006 void* callbackParameter)
3008 defaultDeviceHandler = entityHandler;
3009 defaultDeviceHandlerCallbackParameter = callbackParameter;
3014 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo)
3016 OIC_LOG(INFO, TAG, "Entering OCSetPlatformInfo");
3018 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER || myStackMode == OC_GATEWAY)
3020 if (validatePlatformInfo(platformInfo))
3022 return SavePlatformInfo(platformInfo);
3026 return OC_STACK_INVALID_PARAM;
3031 return OC_STACK_ERROR;
3035 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
3037 OIC_LOG(INFO, TAG, "Entering OCSetDeviceInfo");
3039 if (!deviceInfo.deviceName || deviceInfo.deviceName[0] == '\0')
3041 OIC_LOG(ERROR, TAG, "Null or empty device name.");
3042 return OC_STACK_INVALID_PARAM;
3045 if (deviceInfo.types)
3047 OCStringLL *type = deviceInfo.types;
3048 OCResource *resource = findResource((OCResource *) deviceResource);
3051 return OC_STACK_INVALID_PARAM;
3053 deleteResourceType(resource->rsrcType);
3054 resource->rsrcType = NULL;
3058 OCBindResourceTypeToResource(deviceResource, type->value);
3062 return SaveDeviceInfo(deviceInfo);
3065 OCStackResult OCCreateResource(OCResourceHandle *handle,
3066 const char *resourceTypeName,
3067 const char *resourceInterfaceName,
3068 const char *uri, OCEntityHandler entityHandler,
3069 void* callbackParam,
3070 uint8_t resourceProperties)
3073 OCResource *pointer = NULL;
3074 OCStackResult result = OC_STACK_ERROR;
3076 OIC_LOG(INFO, TAG, "Entering OCCreateResource");
3078 if(myStackMode == OC_CLIENT)
3080 return OC_STACK_INVALID_PARAM;
3082 // Validate parameters
3083 if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
3085 OIC_LOG(ERROR, TAG, "URI is empty or too long");
3086 return OC_STACK_INVALID_URI;
3088 // Is it presented during resource discovery?
3089 if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
3091 OIC_LOG(ERROR, TAG, "Input parameter is NULL");
3092 return OC_STACK_INVALID_PARAM;
3095 if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
3097 resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
3100 // Make sure resourceProperties bitmask has allowed properties specified
3101 if (resourceProperties
3102 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
3103 OC_EXPLICIT_DISCOVERABLE))
3105 OIC_LOG(ERROR, TAG, "Invalid property");
3106 return OC_STACK_INVALID_PARAM;
3109 // If the headResource is NULL, then no resources have been created...
3110 pointer = headResource;
3113 // At least one resources is in the resource list, so we need to search for
3114 // repeated URLs, which are not allowed. If a repeat is found, exit with an error
3117 if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
3119 OIC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
3120 return OC_STACK_INVALID_PARAM;
3122 pointer = pointer->next;
3125 // Create the pointer and insert it into the resource list
3126 pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
3129 result = OC_STACK_NO_MEMORY;
3132 pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
3134 insertResource(pointer);
3137 pointer->uri = OICStrdup(uri);
3140 result = OC_STACK_NO_MEMORY;
3144 // Set properties. Set OC_ACTIVE
3145 pointer->resourceProperties = (OCResourceProperty) (resourceProperties
3148 // Add the resourcetype to the resource
3149 result = BindResourceTypeToResource(pointer, resourceTypeName);
3150 if (result != OC_STACK_OK)
3152 OIC_LOG(ERROR, TAG, "Error adding resourcetype");
3156 // Add the resourceinterface to the resource
3157 result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
3158 if (result != OC_STACK_OK)
3160 OIC_LOG(ERROR, TAG, "Error adding resourceinterface");
3164 // If an entity handler has been passed, attach it to the newly created
3165 // resource. Otherwise, set the default entity handler.
3168 pointer->entityHandler = entityHandler;
3169 pointer->entityHandlerCallbackParam = callbackParam;
3173 pointer->entityHandler = defaultResourceEHandler;
3174 pointer->entityHandlerCallbackParam = NULL;
3177 // Initialize a pointer indicating child resources in case of collection
3178 pointer->rsrcChildResourcesHead = NULL;
3181 result = OC_STACK_OK;
3183 #ifdef WITH_PRESENCE
3184 if (presenceResource.handle)
3186 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3187 SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
3191 if (result != OC_STACK_OK)
3193 // Deep delete of resource and other dynamic elements that it contains
3194 deleteResource(pointer);
3199 OCStackResult OCBindResource(
3200 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3202 OCResource *resource = NULL;
3203 OCChildResource *tempChildResource = NULL;
3204 OCChildResource *newChildResource = NULL;
3206 OIC_LOG(INFO, TAG, "Entering OCBindResource");
3208 // Validate parameters
3209 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3210 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3211 // Container cannot contain itself
3212 if (collectionHandle == resourceHandle)
3214 OIC_LOG(ERROR, TAG, "Added handle equals collection handle");
3215 return OC_STACK_INVALID_PARAM;
3218 // Use the handle to find the resource in the resource linked list
3219 resource = findResource((OCResource *) collectionHandle);
3222 OIC_LOG(ERROR, TAG, "Collection handle not found");
3223 return OC_STACK_INVALID_PARAM;
3226 // Look for an open slot to add add the child resource.
3227 // If found, add it and return success
3229 tempChildResource = resource->rsrcChildResourcesHead;
3231 while(resource->rsrcChildResourcesHead && tempChildResource->next)
3233 // TODO: what if one of child resource was deregistered without unbinding?
3234 tempChildResource = tempChildResource->next;
3237 // Do memory allocation for child resource
3238 newChildResource = (OCChildResource *) OICCalloc(1, sizeof(OCChildResource));
3239 if(!newChildResource)
3241 OIC_LOG(ERROR, TAG, "Adding new child resource is failed due to memory allocation failure");
3242 return OC_STACK_ERROR;
3245 newChildResource->rsrcResource = (OCResource *) resourceHandle;
3246 newChildResource->next = NULL;
3248 if(!resource->rsrcChildResourcesHead)
3250 resource->rsrcChildResourcesHead = newChildResource;
3253 tempChildResource->next = newChildResource;
3256 OIC_LOG(INFO, TAG, "resource bound");
3258 #ifdef WITH_PRESENCE
3259 if (presenceResource.handle)
3261 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3262 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3263 OC_PRESENCE_TRIGGER_CHANGE);
3270 OCStackResult OCUnBindResource(
3271 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3273 OCResource *resource = NULL;
3274 OCChildResource *tempChildResource = NULL;
3275 OCChildResource *tempLastChildResource = NULL;
3277 OIC_LOG(INFO, TAG, "Entering OCUnBindResource");
3279 // Validate parameters
3280 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3281 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3282 // Container cannot contain itself
3283 if (collectionHandle == resourceHandle)
3285 OIC_LOG(ERROR, TAG, "removing handle equals collection handle");
3286 return OC_STACK_INVALID_PARAM;
3289 // Use the handle to find the resource in the resource linked list
3290 resource = findResource((OCResource *) collectionHandle);
3293 OIC_LOG(ERROR, TAG, "Collection handle not found");
3294 return OC_STACK_INVALID_PARAM;
3297 // Look for an open slot to add add the child resource.
3298 // If found, add it and return success
3299 if(!resource->rsrcChildResourcesHead)
3301 OIC_LOG(INFO, TAG, "resource not found in collection");
3303 // Unable to add resourceHandle, so return error
3304 return OC_STACK_ERROR;
3308 tempChildResource = resource->rsrcChildResourcesHead;
3310 while (tempChildResource)
3312 if(tempChildResource->rsrcResource == resourceHandle)
3314 // if resource going to be unbinded is the head one.
3315 if( tempChildResource == resource->rsrcChildResourcesHead )
3317 OCChildResource *temp = resource->rsrcChildResourcesHead->next;
3318 OICFree(resource->rsrcChildResourcesHead);
3319 resource->rsrcChildResourcesHead = temp;
3324 OCChildResource *temp = tempChildResource->next;
3325 OICFree(tempChildResource);
3326 tempLastChildResource->next = temp;
3330 OIC_LOG(INFO, TAG, "resource unbound");
3332 // Send notification when resource is unbounded successfully.
3333 #ifdef WITH_PRESENCE
3334 if (presenceResource.handle)
3336 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3337 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3338 OC_PRESENCE_TRIGGER_CHANGE);
3341 tempChildResource = NULL;
3342 tempLastChildResource = NULL;
3348 tempLastChildResource = tempChildResource;
3349 tempChildResource = tempChildResource->next;
3352 OIC_LOG(INFO, TAG, "resource not found in collection");
3354 tempChildResource = NULL;
3355 tempLastChildResource = NULL;
3357 // Unable to add resourceHandle, so return error
3358 return OC_STACK_ERROR;
3361 // Precondition is that the parameter has been checked to not equal NULL.
3362 static bool ValidateResourceTypeInterface(const char *resourceItemName)
3364 if (resourceItemName[0] < 'a' || resourceItemName[0] > 'z')
3370 while (resourceItemName[index] != '\0')
3372 if (resourceItemName[index] != '.' &&
3373 resourceItemName[index] != '-' &&
3374 (resourceItemName[index] < 'a' || resourceItemName[index] > 'z') &&
3375 (resourceItemName[index] < '0' || resourceItemName[index] > '9'))
3384 OCStackResult BindResourceTypeToResource(OCResource* resource,
3385 const char *resourceTypeName)
3387 OCResourceType *pointer = NULL;
3389 OCStackResult result = OC_STACK_ERROR;
3391 VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
3393 if (!ValidateResourceTypeInterface(resourceTypeName))
3395 OIC_LOG(ERROR, TAG, "resource type illegal (see RFC 6690)");
3396 return OC_STACK_INVALID_PARAM;
3399 pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
3402 result = OC_STACK_NO_MEMORY;
3406 str = OICStrdup(resourceTypeName);
3409 result = OC_STACK_NO_MEMORY;
3412 pointer->resourcetypename = str;
3413 pointer->next = NULL;
3415 insertResourceType(resource, pointer);
3416 result = OC_STACK_OK;
3419 if (result != OC_STACK_OK)
3428 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
3429 const char *resourceInterfaceName)
3431 OCResourceInterface *pointer = NULL;
3433 OCStackResult result = OC_STACK_ERROR;
3435 VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
3437 if (!ValidateResourceTypeInterface(resourceInterfaceName))
3439 OIC_LOG(ERROR, TAG, "resource /interface illegal (see RFC 6690)");
3440 return OC_STACK_INVALID_PARAM;
3443 OIC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
3445 pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
3448 result = OC_STACK_NO_MEMORY;
3452 str = OICStrdup(resourceInterfaceName);
3455 result = OC_STACK_NO_MEMORY;
3458 pointer->name = str;
3460 // Bind the resourceinterface to the resource
3461 insertResourceInterface(resource, pointer);
3463 result = OC_STACK_OK;
3466 if (result != OC_STACK_OK)
3475 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
3476 const char *resourceTypeName)
3479 OCStackResult result = OC_STACK_ERROR;
3480 OCResource *resource = NULL;
3482 resource = findResource((OCResource *) handle);
3485 OIC_LOG(ERROR, TAG, "Resource not found");
3486 return OC_STACK_ERROR;
3489 result = BindResourceTypeToResource(resource, resourceTypeName);
3491 #ifdef WITH_PRESENCE
3492 if(presenceResource.handle)
3494 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3495 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3502 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
3503 const char *resourceInterfaceName)
3506 OCStackResult result = OC_STACK_ERROR;
3507 OCResource *resource = NULL;
3509 resource = findResource((OCResource *) handle);
3512 OIC_LOG(ERROR, TAG, "Resource not found");
3513 return OC_STACK_ERROR;
3516 result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
3518 #ifdef WITH_PRESENCE
3519 if (presenceResource.handle)
3521 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3522 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3529 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
3531 OCResource *pointer = headResource;
3533 VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
3537 *numResources = *numResources + 1;
3538 pointer = pointer->next;
3543 OCResourceHandle OCGetResourceHandle(uint8_t index)
3545 OCResource *pointer = headResource;
3547 for( uint8_t i = 0; i < index && pointer; ++i)
3549 pointer = pointer->next;
3551 return (OCResourceHandle) pointer;
3554 OCStackResult OCDeleteResource(OCResourceHandle handle)
3558 OIC_LOG(ERROR, TAG, "Invalid handle for deletion");
3559 return OC_STACK_INVALID_PARAM;
3562 OCResource *resource = findResource((OCResource *) handle);
3563 if (resource == NULL)
3565 OIC_LOG(ERROR, TAG, "Resource not found");
3566 return OC_STACK_NO_RESOURCE;
3569 if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3571 OIC_LOG(ERROR, TAG, "Error deleting resource");
3572 return OC_STACK_ERROR;
3578 const char *OCGetResourceUri(OCResourceHandle handle)
3580 OCResource *resource = NULL;
3582 resource = findResource((OCResource *) handle);
3585 return resource->uri;
3587 return (const char *) NULL;
3590 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3592 OCResource *resource = NULL;
3594 resource = findResource((OCResource *) handle);
3597 return resource->resourceProperties;
3599 return (OCResourceProperty)-1;
3602 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3603 uint8_t *numResourceTypes)
3605 OCResource *resource = NULL;
3606 OCResourceType *pointer = NULL;
3608 VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3609 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3611 *numResourceTypes = 0;
3613 resource = findResource((OCResource *) handle);
3616 pointer = resource->rsrcType;
3619 *numResourceTypes = *numResourceTypes + 1;
3620 pointer = pointer->next;
3626 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3628 OCResourceType *resourceType = NULL;
3630 resourceType = findResourceTypeAtIndex(handle, index);
3633 return resourceType->resourcetypename;
3635 return (const char *) NULL;
3638 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3639 uint8_t *numResourceInterfaces)
3641 OCResourceInterface *pointer = NULL;
3642 OCResource *resource = NULL;
3644 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3645 VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3647 *numResourceInterfaces = 0;
3648 resource = findResource((OCResource *) handle);
3651 pointer = resource->rsrcInterface;
3654 *numResourceInterfaces = *numResourceInterfaces + 1;
3655 pointer = pointer->next;
3661 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3663 OCResourceInterface *resourceInterface = NULL;
3665 resourceInterface = findResourceInterfaceAtIndex(handle, index);
3666 if (resourceInterface)
3668 return resourceInterface->name;
3670 return (const char *) NULL;
3673 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3676 OCResource *resource = NULL;
3677 OCChildResource *tempChildResource = NULL;
3680 resource = findResource((OCResource *) collectionHandle);
3686 tempChildResource = resource->rsrcChildResourcesHead;
3688 while(tempChildResource)
3692 return tempChildResource->rsrcResource;
3695 tempChildResource = tempChildResource->next;
3698 // In this case, the number of resource handles in the collection exceeds the index
3699 tempChildResource = NULL;
3703 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3704 OCEntityHandler entityHandler,
3705 void* callbackParam)
3707 OCResource *resource = NULL;
3709 // Validate parameters
3710 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3712 // Use the handle to find the resource in the resource linked list
3713 resource = findResource((OCResource *)handle);
3716 OIC_LOG(ERROR, TAG, "Resource not found");
3717 return OC_STACK_ERROR;
3721 resource->entityHandler = entityHandler;
3722 resource->entityHandlerCallbackParam = callbackParam;
3724 #ifdef WITH_PRESENCE
3725 if (presenceResource.handle)
3727 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3728 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3735 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3737 OCResource *resource = NULL;
3739 resource = findResource((OCResource *)handle);
3742 OIC_LOG(ERROR, TAG, "Resource not found");
3747 return resource->entityHandler;
3750 void incrementSequenceNumber(OCResource * resPtr)
3752 // Increment the sequence number
3753 resPtr->sequenceNum += 1;
3754 if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3756 resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3761 #ifdef WITH_PRESENCE
3762 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3763 OCPresenceTrigger trigger)
3765 OCResource *resPtr = NULL;
3766 OCStackResult result = OC_STACK_ERROR;
3767 OCMethod method = OC_REST_PRESENCE;
3768 uint32_t maxAge = 0;
3769 resPtr = findResource((OCResource *) presenceResource.handle);
3772 return OC_STACK_NO_RESOURCE;
3775 if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3777 maxAge = presenceResource.presenceTTL;
3779 result = SendAllObserverNotification(method, resPtr, maxAge,
3780 trigger, resourceType, OC_LOW_QOS);
3786 OCStackResult SendStopNotification()
3788 OCResource *resPtr = NULL;
3789 OCStackResult result = OC_STACK_ERROR;
3790 OCMethod method = OC_REST_PRESENCE;
3791 resPtr = findResource((OCResource *) presenceResource.handle);
3794 return OC_STACK_NO_RESOURCE;
3797 // maxAge is 0. ResourceType is NULL.
3798 result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3804 #endif // WITH_PRESENCE
3805 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3807 OCResource *resPtr = NULL;
3808 OCStackResult result = OC_STACK_ERROR;
3809 OCMethod method = OC_REST_NOMETHOD;
3810 uint32_t maxAge = 0;
3812 OIC_LOG(INFO, TAG, "Notifying all observers");
3813 #ifdef WITH_PRESENCE
3814 if(handle == presenceResource.handle)
3818 #endif // WITH_PRESENCE
3819 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3821 // Verify that the resource exists
3822 resPtr = findResource ((OCResource *) handle);
3825 return OC_STACK_NO_RESOURCE;
3829 //only increment in the case of regular observing (not presence)
3830 incrementSequenceNumber(resPtr);
3831 method = OC_REST_OBSERVE;
3832 maxAge = MAX_OBSERVE_AGE;
3833 #ifdef WITH_PRESENCE
3834 result = SendAllObserverNotification (method, resPtr, maxAge,
3835 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3837 result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3844 OCNotifyListOfObservers (OCResourceHandle handle,
3845 OCObservationId *obsIdList,
3846 uint8_t numberOfIds,
3847 const OCRepPayload *payload,
3848 OCQualityOfService qos)
3850 OIC_LOG(INFO, TAG, "Entering OCNotifyListOfObservers");
3852 OCResource *resPtr = NULL;
3853 //TODO: we should allow the server to define this
3854 uint32_t maxAge = MAX_OBSERVE_AGE;
3856 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3857 VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3858 VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
3860 resPtr = findResource ((OCResource *) handle);
3861 if (NULL == resPtr || myStackMode == OC_CLIENT)
3863 return OC_STACK_NO_RESOURCE;
3867 incrementSequenceNumber(resPtr);
3869 return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3870 payload, maxAge, qos));
3873 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3875 OCStackResult result = OC_STACK_ERROR;
3876 OCServerRequest *serverRequest = NULL;
3878 OIC_LOG(INFO, TAG, "Entering OCDoResponse");
3880 // Validate input parameters
3881 VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3882 VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3885 // Get pointer to request info
3886 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3889 // response handler in ocserverrequest.c. Usually HandleSingleResponse.
3890 result = serverRequest->ehResponseHandler(ehResponse);
3896 //#ifdef DIRECT_PAIRING
3897 const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime)
3899 OIC_LOG(INFO, TAG, "Start OCDiscoverDirectPairingDevices");
3900 if(OC_STACK_OK != DPDeviceDiscovery(waittime))
3902 OIC_LOG(ERROR, TAG, "Fail to discover Direct-Pairing device");
3906 return (const OCDPDev_t*)DPGetDiscoveredDevices();
3909 const OCDPDev_t* OCGetDirectPairedDevices()
3911 return (const OCDPDev_t*)DPGetPairedDevices();
3914 void DirectPairingCB (OCDirectPairingDev_t * peer, OCStackResult result)
3916 if (gDirectpairingCallback)
3918 gDirectpairingCallback((OCDPDev_t*)peer, result);
3919 gDirectpairingCallback = NULL;
3923 OCStackResult OCDoDirectPairing(OCDPDev_t* peer, OCPrm_t pmSel, char *pinNumber,
3924 OCDirectPairingCB resultCallback)
3926 OIC_LOG(INFO, TAG, "Start OCDoDirectPairing");
3927 if(NULL == peer || NULL == pinNumber)
3929 OIC_LOG(ERROR, TAG, "Invalid parameters");
3930 return OC_STACK_INVALID_PARAM;
3932 if(NULL == resultCallback)
3934 OIC_LOG(ERROR, TAG, "Invalid callback");
3935 return OC_STACK_INVALID_CALLBACK;
3938 gDirectpairingCallback = resultCallback;
3939 return DPDirectPairing((OCDirectPairingDev_t*)peer, (OicSecPrm_t)pmSel,
3940 pinNumber, DirectPairingCB);
3942 //#endif // DIRECT_PAIRING
3944 //-----------------------------------------------------------------------------
3945 // Private internal function definitions
3946 //-----------------------------------------------------------------------------
3947 static OCDoHandle GenerateInvocationHandle()
3949 OCDoHandle handle = NULL;
3950 // Generate token here, it will be deleted when the transaction is deleted
3951 handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3954 OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3960 #ifdef WITH_PRESENCE
3961 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3962 OCResourceProperty resourceProperties, uint8_t enable)
3966 return OC_STACK_INVALID_PARAM;
3968 if (resourceProperties
3969 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
3971 OIC_LOG(ERROR, TAG, "Invalid property");
3972 return OC_STACK_INVALID_PARAM;
3976 *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3980 *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3986 OCStackResult initResources()
3988 OCStackResult result = OC_STACK_OK;
3990 headResource = NULL;
3991 tailResource = NULL;
3992 // Init Virtual Resources
3993 #ifdef WITH_PRESENCE
3994 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
3996 result = OCCreateResource(&presenceResource.handle,
3997 OC_RSRVD_RESOURCE_TYPE_PRESENCE,
3999 OC_RSRVD_PRESENCE_URI,
4003 //make resource inactive
4004 result = OCChangeResourceProperty(
4005 &(((OCResource *) presenceResource.handle)->resourceProperties),
4008 #ifndef WITH_ARDUINO
4009 if (result == OC_STACK_OK)
4011 result = SRMInitSecureResources();
4015 if(result == OC_STACK_OK)
4017 result = OCCreateResource(&deviceResource,
4018 OC_RSRVD_RESOURCE_TYPE_DEVICE,
4019 OC_RSRVD_INTERFACE_DEFAULT,
4020 OC_RSRVD_DEVICE_URI,
4024 if(result == OC_STACK_OK)
4026 result = BindResourceInterfaceToResource((OCResource *)deviceResource,
4027 OC_RSRVD_INTERFACE_READ);
4031 if(result == OC_STACK_OK)
4033 result = OCCreateResource(&platformResource,
4034 OC_RSRVD_RESOURCE_TYPE_PLATFORM,
4035 OC_RSRVD_INTERFACE_DEFAULT,
4036 OC_RSRVD_PLATFORM_URI,
4040 if(result == OC_STACK_OK)
4042 result = BindResourceInterfaceToResource((OCResource *)platformResource,
4043 OC_RSRVD_INTERFACE_READ);
4050 void insertResource(OCResource *resource)
4054 headResource = resource;
4055 tailResource = resource;
4059 tailResource->next = resource;
4060 tailResource = resource;
4062 resource->next = NULL;
4065 OCResource *findResource(OCResource *resource)
4067 OCResource *pointer = headResource;
4071 if (pointer == resource)
4075 pointer = pointer->next;
4080 void deleteAllResources()
4082 OCResource *pointer = headResource;
4083 OCResource *temp = NULL;
4087 temp = pointer->next;
4088 #ifdef WITH_PRESENCE
4089 if (pointer != (OCResource *) presenceResource.handle)
4091 #endif // WITH_PRESENCE
4092 deleteResource(pointer);
4093 #ifdef WITH_PRESENCE
4095 #endif // WITH_PRESENCE
4099 SRMDeInitSecureResources();
4101 #ifdef WITH_PRESENCE
4102 // Ensure that the last resource to be deleted is the presence resource. This allows for all
4103 // presence notification attributed to their deletion to be processed.
4104 deleteResource((OCResource *) presenceResource.handle);
4105 #endif // WITH_PRESENCE
4108 OCStackResult deleteResource(OCResource *resource)
4110 OCResource *prev = NULL;
4111 OCResource *temp = NULL;
4114 OIC_LOG(DEBUG,TAG,"resource is NULL");
4115 return OC_STACK_INVALID_PARAM;
4118 OIC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
4120 temp = headResource;
4123 if (temp == resource)
4125 // Invalidate all Resource Properties.
4126 resource->resourceProperties = (OCResourceProperty) 0;
4127 #ifdef WITH_PRESENCE
4128 if(resource != (OCResource *) presenceResource.handle)
4130 #endif // WITH_PRESENCE
4131 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
4132 #ifdef WITH_PRESENCE
4135 if(presenceResource.handle)
4137 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
4138 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
4141 // Only resource in list.
4142 if (temp == headResource && temp == tailResource)
4144 headResource = NULL;
4145 tailResource = NULL;
4148 else if (temp == headResource)
4150 headResource = temp->next;
4153 else if (temp == tailResource)
4155 tailResource = prev;
4156 tailResource->next = NULL;
4160 prev->next = temp->next;
4163 deleteResourceElements(temp);
4174 return OC_STACK_ERROR;
4177 void deleteResourceElements(OCResource *resource)
4184 OICFree(resource->uri);
4185 deleteResourceType(resource->rsrcType);
4186 deleteResourceInterface(resource->rsrcInterface);
4189 void deleteResourceType(OCResourceType *resourceType)
4191 OCResourceType *pointer = resourceType;
4192 OCResourceType *next = NULL;
4196 next = pointer->next;
4197 OICFree(pointer->resourcetypename);
4203 void deleteResourceInterface(OCResourceInterface *resourceInterface)
4205 OCResourceInterface *pointer = resourceInterface;
4206 OCResourceInterface *next = NULL;
4210 next = pointer->next;
4211 OICFree(pointer->name);
4217 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
4219 OCResourceType *pointer = NULL;
4220 OCResourceType *previous = NULL;
4221 if (!resource || !resourceType)
4225 // resource type list is empty.
4226 else if (!resource->rsrcType)
4228 resource->rsrcType = resourceType;
4232 pointer = resource->rsrcType;
4236 if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
4238 OIC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
4239 OICFree(resourceType->resourcetypename);
4240 OICFree(resourceType);
4244 pointer = pointer->next;
4246 previous->next = resourceType;
4248 resourceType->next = NULL;
4250 OIC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
4253 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
4255 OCResource *resource = NULL;
4256 OCResourceType *pointer = NULL;
4258 // Find the specified resource
4259 resource = findResource((OCResource *) handle);
4265 // Make sure a resource has a resourcetype
4266 if (!resource->rsrcType)
4271 // Iterate through the list
4272 pointer = resource->rsrcType;
4273 for(uint8_t i = 0; i< index && pointer; ++i)
4275 pointer = pointer->next;
4280 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
4282 if(resourceTypeList && resourceTypeName)
4284 OCResourceType * rtPointer = resourceTypeList;
4285 while(resourceTypeName && rtPointer)
4287 if(rtPointer->resourcetypename &&
4288 strcmp(resourceTypeName, (const char *)
4289 (rtPointer->resourcetypename)) == 0)
4293 rtPointer = rtPointer->next;
4301 * Insert a new interface into interface linked list only if not already present.
4302 * If alredy present, 2nd arg is free'd.
4303 * Default interface will always be first if present.
4305 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
4307 OCResourceInterface *pointer = NULL;
4308 OCResourceInterface *previous = NULL;
4310 newInterface->next = NULL;
4312 OCResourceInterface **firstInterface = &(resource->rsrcInterface);
4314 if (!*firstInterface)
4316 // If first interface is not oic.if.baseline, by default add it as first interface type.
4317 if (0 == strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT))
4319 *firstInterface = newInterface;
4323 OCStackResult result = BindResourceInterfaceToResource(resource, OC_RSRVD_INTERFACE_DEFAULT);
4324 if (result != OC_STACK_OK)
4326 OICFree(newInterface->name);
4327 OICFree(newInterface);
4330 if (*firstInterface)
4332 (*firstInterface)->next = newInterface;
4336 // If once add oic.if.baseline, later too below code take care of freeing memory.
4337 else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4339 if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4341 OICFree(newInterface->name);
4342 OICFree(newInterface);
4345 // This code will not hit anymore, keeping
4348 newInterface->next = *firstInterface;
4349 *firstInterface = newInterface;
4354 pointer = *firstInterface;
4357 if (strcmp(newInterface->name, pointer->name) == 0)
4359 OICFree(newInterface->name);
4360 OICFree(newInterface);
4364 pointer = pointer->next;
4366 previous->next = newInterface;
4370 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
4373 OCResource *resource = NULL;
4374 OCResourceInterface *pointer = NULL;
4376 // Find the specified resource
4377 resource = findResource((OCResource *) handle);
4383 // Make sure a resource has a resourceinterface
4384 if (!resource->rsrcInterface)
4389 // Iterate through the list
4390 pointer = resource->rsrcInterface;
4392 for (uint8_t i = 0; i < index && pointer; ++i)
4394 pointer = pointer->next;
4400 * This function splits the uri using the '?' delimiter.
4401 * "uriWithoutQuery" is the block of characters between the beginning
4402 * till the delimiter or '\0' which ever comes first.
4403 * "query" is whatever is to the right of the delimiter if present.
4404 * No delimiter sets the query to NULL.
4405 * If either are present, they will be malloc'ed into the params 2, 3.
4406 * The first param, *uri is left untouched.
4408 * NOTE: This function does not account for whitespace at the end of the uri NOR
4409 * malformed uri's with '??'. Whitespace at the end will be assumed to be
4410 * part of the query.
4412 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
4416 return OC_STACK_INVALID_URI;
4418 if(!query || !uriWithoutQuery)
4420 return OC_STACK_INVALID_PARAM;
4424 *uriWithoutQuery = NULL;
4426 size_t uriWithoutQueryLen = 0;
4427 size_t queryLen = 0;
4428 size_t uriLen = strlen(uri);
4430 char *pointerToDelimiter = strstr(uri, "?");
4432 uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : (size_t)(pointerToDelimiter - uri);
4433 queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
4435 if (uriWithoutQueryLen)
4437 *uriWithoutQuery = (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
4438 if (!*uriWithoutQuery)
4442 OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
4446 *query = (char *) OICCalloc(queryLen + 1, 1);
4449 OICFree(*uriWithoutQuery);
4450 *uriWithoutQuery = NULL;
4453 OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
4459 return OC_STACK_NO_MEMORY;
4462 static const OicUuid_t* OCGetServerInstanceID(void)
4464 static bool generated = false;
4465 static OicUuid_t sid;
4471 if (OC_STACK_OK != GetDoxmDeviceID(&sid))
4473 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
4480 const char* OCGetServerInstanceIDString(void)
4482 static bool generated = false;
4483 static char sidStr[UUID_STRING_SIZE];
4490 const OicUuid_t *sid = OCGetServerInstanceID();
4491 if(OCConvertUuidToString(sid->id, sidStr) != RAND_UUID_OK)
4493 OIC_LOG(FATAL, TAG, "Generate UUID String for Server Instance failed!");
4501 CAResult_t OCSelectNetwork()
4503 CAResult_t retResult = CA_STATUS_FAILED;
4504 CAResult_t caResult = CA_STATUS_OK;
4506 CATransportAdapter_t connTypes[] = {
4508 CA_ADAPTER_RFCOMM_BTEDR,
4509 CA_ADAPTER_GATT_BTLE,
4512 ,CA_ADAPTER_REMOTE_ACCESS
4519 int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
4521 for(int i = 0; i<numConnTypes; i++)
4523 // Ignore CA_NOT_SUPPORTED error. The CA Layer may have not compiled in the interface.
4524 if(caResult == CA_STATUS_OK || caResult == CA_NOT_SUPPORTED)
4526 caResult = CASelectNetwork(connTypes[i]);
4527 if(caResult == CA_STATUS_OK)
4529 retResult = CA_STATUS_OK;
4534 if(retResult != CA_STATUS_OK)
4536 return caResult; // Returns error of appropriate transport that failed fatally.
4542 OCStackResult CAResultToOCResult(CAResult_t caResult)
4548 case CA_STATUS_INVALID_PARAM:
4549 return OC_STACK_INVALID_PARAM;
4550 case CA_ADAPTER_NOT_ENABLED:
4551 return OC_STACK_ADAPTER_NOT_ENABLED;
4552 case CA_SERVER_STARTED_ALREADY:
4554 case CA_SERVER_NOT_STARTED:
4555 return OC_STACK_ERROR;
4556 case CA_DESTINATION_NOT_REACHABLE:
4557 return OC_STACK_COMM_ERROR;
4558 case CA_SOCKET_OPERATION_FAILED:
4559 return OC_STACK_COMM_ERROR;
4560 case CA_SEND_FAILED:
4561 return OC_STACK_COMM_ERROR;
4562 case CA_RECEIVE_FAILED:
4563 return OC_STACK_COMM_ERROR;
4564 case CA_MEMORY_ALLOC_FAILED:
4565 return OC_STACK_NO_MEMORY;
4566 case CA_REQUEST_TIMEOUT:
4567 return OC_STACK_TIMEOUT;
4568 case CA_DESTINATION_DISCONNECTED:
4569 return OC_STACK_COMM_ERROR;
4570 case CA_STATUS_FAILED:
4571 return OC_STACK_ERROR;
4572 case CA_NOT_SUPPORTED:
4573 return OC_STACK_NOTIMPL;
4575 return OC_STACK_ERROR;