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->ifindex = in->ifindex;
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->ifindex = in->ifindex;
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 if (!serverRequest.payload)
1681 OIC_LOG(ERROR, TAG, "Allocation for payload failed.");
1684 memcpy (serverRequest.payload, requestInfo->info.payload,
1685 requestInfo->info.payloadSize);
1689 serverRequest.reqTotalSize = 0;
1692 switch (requestInfo->method)
1695 serverRequest.method = OC_REST_GET;
1698 serverRequest.method = OC_REST_PUT;
1701 serverRequest.method = OC_REST_POST;
1704 serverRequest.method = OC_REST_DELETE;
1707 OIC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1708 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1709 requestInfo->info.type, requestInfo->info.numOptions,
1710 requestInfo->info.options, requestInfo->info.token,
1711 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1712 OICFree(serverRequest.payload);
1716 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1717 requestInfo->info.tokenLength);
1719 serverRequest.tokenLength = requestInfo->info.tokenLength;
1720 if (serverRequest.tokenLength) {
1722 serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1724 if (!serverRequest.requestToken)
1726 OIC_LOG(FATAL, TAG, "Allocation for token failed.");
1727 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1728 requestInfo->info.type, requestInfo->info.numOptions,
1729 requestInfo->info.options, requestInfo->info.token,
1730 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1731 OICFree(serverRequest.payload);
1734 memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1737 switch (requestInfo->info.acceptFormat)
1739 case CA_FORMAT_APPLICATION_CBOR:
1740 serverRequest.acceptFormat = OC_FORMAT_CBOR;
1742 case CA_FORMAT_UNDEFINED:
1743 serverRequest.acceptFormat = OC_FORMAT_UNDEFINED;
1746 serverRequest.acceptFormat = OC_FORMAT_UNSUPPORTED;
1749 if (requestInfo->info.type == CA_MSG_CONFIRM)
1751 serverRequest.qos = OC_HIGH_QOS;
1755 serverRequest.qos = OC_LOW_QOS;
1757 // CA does not need the following field
1758 // Are we sure CA does not need them? how is it responding to multicast
1759 serverRequest.delayedResNeeded = 0;
1761 serverRequest.coapID = requestInfo->info.messageId;
1763 CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1765 // copy vendor specific header options
1766 uint8_t tempNum = (requestInfo->info.numOptions);
1768 // Assume no observation requested and it is a pure GET.
1769 // If obs registration/de-registration requested it'll be fetched from the
1770 // options in GetObserveHeaderOption()
1771 serverRequest.observationOption = OC_OBSERVE_NO_OPTION;
1773 GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1774 if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1777 "The request info numOptions is greater than MAX_HEADER_OPTIONS");
1778 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1779 requestInfo->info.type, requestInfo->info.numOptions,
1780 requestInfo->info.options, requestInfo->info.token,
1781 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1782 OICFree(serverRequest.payload);
1783 OICFree(serverRequest.requestToken);
1786 serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1787 if (serverRequest.numRcvdVendorSpecificHeaderOptions)
1789 memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1790 sizeof(CAHeaderOption_t)*tempNum);
1793 requestResult = HandleStackRequests (&serverRequest);
1795 // Send ACK to client as precursor to slow response
1796 if (requestResult == OC_STACK_SLOW_RESOURCE)
1798 if (requestInfo->info.type == CA_MSG_CONFIRM)
1800 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1801 CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0, NULL);
1804 else if(requestResult != OC_STACK_OK)
1806 OIC_LOG_V(ERROR, TAG, "HandleStackRequests failed. error: %d", requestResult);
1808 CAResponseResult_t stackResponse =
1809 OCToCAStackResult(requestResult, serverRequest.method);
1811 SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1812 requestInfo->info.type, requestInfo->info.numOptions,
1813 requestInfo->info.options, requestInfo->info.token,
1814 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1816 // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1817 // The token is copied in there, and is thus still owned by this function.
1818 OICFree(serverRequest.payload);
1819 OICFree(serverRequest.requestToken);
1820 OIC_LOG(INFO, TAG, "Exit OCHandleRequests");
1823 //This function will be called back by CA layer when a request is received
1824 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1826 OIC_LOG(INFO, TAG, "Enter HandleCARequests");
1829 OIC_LOG(ERROR, TAG, "endPoint is NULL");
1835 OIC_LOG(ERROR, TAG, "requestInfo is NULL");
1839 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1840 #ifdef ROUTING_GATEWAY
1841 bool needRIHandling = false;
1842 bool isEmptyMsg = false;
1844 * Routing manager is going to update either of endpoint or request or both.
1845 * This typecasting is done to avoid unnecessary duplication of Endpoint and requestInfo
1846 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1847 * destination. It can also remove "RM" coap header option before passing request / response to
1848 * RI as this option will make no sense to either RI or application.
1850 OCStackResult ret = RMHandleRequest((CARequestInfo_t *)requestInfo, (CAEndpoint_t *)endPoint,
1851 &needRIHandling, &isEmptyMsg);
1852 if(OC_STACK_OK != ret || !needRIHandling)
1854 OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1860 * Put source in sender endpoint so that the next packet from application can be routed to
1861 * proper destination and remove RM header option.
1863 RMUpdateInfo((CAHeaderOption_t **) &(requestInfo->info.options),
1864 (uint8_t *) &(requestInfo->info.numOptions),
1865 (CAEndpoint_t *) endPoint);
1867 #ifdef ROUTING_GATEWAY
1871 * In Gateways, the MSGType in route option is used to check if the actual
1872 * response is EMPTY message(4 bytes CoAP Header). In case of Client, the
1873 * EMPTY response is sent in the form of POST request which need to be changed
1874 * to a EMPTY response by RM. This translation is done in this part of the code.
1876 OIC_LOG(INFO, TAG, "This is a Empty response from the Client");
1877 CAResponseInfo_t respInfo = {.result = CA_EMPTY,
1878 .info.messageId = requestInfo->info.messageId,
1879 .info.type = CA_MSG_ACKNOWLEDGE};
1880 OCHandleResponse(endPoint, &respInfo);
1886 // Normal handling of the packet
1887 OCHandleRequests(endPoint, requestInfo);
1889 OIC_LOG(INFO, TAG, "Exit HandleCARequests");
1892 bool validatePlatformInfo(OCPlatformInfo info)
1895 if (!info.platformID)
1897 OIC_LOG(ERROR, TAG, "No platform ID found.");
1901 if (info.manufacturerName)
1903 size_t lenManufacturerName = strlen(info.manufacturerName);
1905 if(lenManufacturerName == 0 || lenManufacturerName > MAX_MANUFACTURER_NAME_LENGTH)
1907 OIC_LOG(ERROR, TAG, "Manufacturer name fails length requirements.");
1913 OIC_LOG(ERROR, TAG, "No manufacturer name present");
1917 if (info.manufacturerUrl)
1919 if(strlen(info.manufacturerUrl) > MAX_MANUFACTURER_URL_LENGTH)
1921 OIC_LOG(ERROR, TAG, "Manufacturer url fails length requirements.");
1928 //-----------------------------------------------------------------------------
1930 //-----------------------------------------------------------------------------
1932 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
1935 !raInfo->username ||
1936 !raInfo->hostname ||
1937 !raInfo->xmpp_domain)
1940 return OC_STACK_INVALID_PARAM;
1942 OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
1943 gRASetInfo = (result == OC_STACK_OK)? true : false;
1949 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1953 return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
1956 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
1958 if(stackState == OC_STACK_INITIALIZED)
1960 OIC_LOG(INFO, TAG, "Subsequent calls to OCInit() without calling \
1961 OCStop() between them are ignored.");
1965 #ifndef ROUTING_GATEWAY
1966 if (OC_GATEWAY == mode)
1968 OIC_LOG(ERROR, TAG, "Routing Manager not supported");
1969 return OC_STACK_INVALID_PARAM;
1976 OIC_LOG(ERROR, TAG, "Need to call OCSetRAInfo before calling OCInit");
1977 return OC_STACK_ERROR;
1981 OCStackResult result = OC_STACK_ERROR;
1982 OIC_LOG(INFO, TAG, "Entering OCInit");
1985 if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)
1986 || (mode == OC_GATEWAY)))
1988 OIC_LOG(ERROR, TAG, "Invalid mode");
1989 return OC_STACK_ERROR;
1993 if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1995 caglobals.client = true;
1997 if (mode == OC_SERVER || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1999 caglobals.server = true;
2002 caglobals.serverFlags = (CATransportFlags_t)serverFlags;
2003 if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
2005 caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4|CA_IPV6);
2007 caglobals.clientFlags = (CATransportFlags_t)clientFlags;
2008 if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
2010 caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4|CA_IPV6);
2013 defaultDeviceHandler = NULL;
2014 defaultDeviceHandlerCallbackParameter = NULL;
2016 result = CAResultToOCResult(CAInitialize());
2017 VERIFY_SUCCESS(result, OC_STACK_OK);
2019 result = CAResultToOCResult(OCSelectNetwork());
2020 VERIFY_SUCCESS(result, OC_STACK_OK);
2022 switch (myStackMode)
2025 CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2026 result = CAResultToOCResult(CAStartDiscoveryServer());
2027 OIC_LOG(INFO, TAG, "Client mode: CAStartDiscoveryServer");
2030 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2031 result = CAResultToOCResult(CAStartListeningServer());
2032 OIC_LOG(INFO, TAG, "Server mode: CAStartListeningServer");
2034 case OC_CLIENT_SERVER:
2036 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2037 result = CAResultToOCResult(CAStartListeningServer());
2038 if(result == OC_STACK_OK)
2040 result = CAResultToOCResult(CAStartDiscoveryServer());
2044 VERIFY_SUCCESS(result, OC_STACK_OK);
2047 CARegisterKeepAliveHandler(HandleKeepAliveConnCB);
2050 #ifdef WITH_PRESENCE
2051 PresenceTimeOutSize = sizeof (PresenceTimeOut) / sizeof (PresenceTimeOut[0]) - 1;
2052 #endif // WITH_PRESENCE
2054 //Update Stack state to initialized
2055 stackState = OC_STACK_INITIALIZED;
2057 // Initialize resource
2058 if(myStackMode != OC_CLIENT)
2060 result = initResources();
2063 // Initialize the SRM Policy Engine
2064 if(result == OC_STACK_OK)
2066 result = SRMInitPolicyEngine();
2067 // TODO after BeachHead delivery: consolidate into single SRMInit()
2069 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
2070 RMSetStackMode(mode);
2071 #ifdef ROUTING_GATEWAY
2072 if (OC_GATEWAY == myStackMode)
2074 result = RMInitialize();
2080 if (result == OC_STACK_OK)
2082 result = InitializeKeepAlive(myStackMode);
2087 if(result != OC_STACK_OK)
2089 OIC_LOG(ERROR, TAG, "Stack initialization error");
2090 deleteAllResources();
2092 stackState = OC_STACK_UNINITIALIZED;
2097 OCStackResult OCStop()
2099 OIC_LOG(INFO, TAG, "Entering OCStop");
2101 if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
2103 OIC_LOG(DEBUG, TAG, "Stack already stopping, exiting");
2106 else if (stackState != OC_STACK_INITIALIZED)
2108 OIC_LOG(ERROR, TAG, "Stack not initialized");
2109 return OC_STACK_ERROR;
2112 stackState = OC_STACK_UNINIT_IN_PROGRESS;
2114 #ifdef WITH_PRESENCE
2115 // Ensure that the TTL associated with ANY and ALL presence notifications originating from
2116 // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
2117 presenceResource.presenceTTL = 0;
2118 #endif // WITH_PRESENCE
2120 #ifdef ROUTING_GATEWAY
2121 if (OC_GATEWAY == myStackMode)
2128 TerminateKeepAlive(myStackMode);
2131 // Free memory dynamically allocated for resources
2132 deleteAllResources();
2134 DeletePlatformInfo();
2136 // Remove all observers
2137 DeleteObserverList();
2138 // Remove all the client callbacks
2139 DeleteClientCBList();
2141 // De-init the SRM Policy Engine
2142 // TODO after BeachHead delivery: consolidate into single SRMDeInit()
2143 SRMDeInitPolicyEngine();
2146 stackState = OC_STACK_UNINITIALIZED;
2150 OCStackResult OCStartMulticastServer()
2152 if(stackState != OC_STACK_INITIALIZED)
2154 OIC_LOG(ERROR, TAG, "OCStack is not initalized. Cannot start multicast server.");
2155 return OC_STACK_ERROR;
2157 CAResult_t ret = CAStartListeningServer();
2158 if (CA_STATUS_OK != ret)
2160 OIC_LOG_V(ERROR, TAG, "Failed starting listening server: %d", ret);
2161 return OC_STACK_ERROR;
2166 OCStackResult OCStopMulticastServer()
2168 CAResult_t ret = CAStopListeningServer();
2169 if (CA_STATUS_OK != ret)
2171 OIC_LOG_V(ERROR, TAG, "Failed stopping listening server: %d", ret);
2172 return OC_STACK_ERROR;
2177 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
2182 return CA_MSG_CONFIRM;
2187 return CA_MSG_NONCONFIRM;
2191 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
2195 query = strchr (inputUri, '?');
2199 if((query - inputUri) > MAX_URI_LENGTH)
2201 return OC_STACK_INVALID_URI;
2204 if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
2206 return OC_STACK_INVALID_QUERY;
2209 else if(uriLen > MAX_URI_LENGTH)
2211 return OC_STACK_INVALID_URI;
2217 * A request uri consists of the following components in order:
2220 * CoAP over UDP prefix "coap://"
2221 * CoAP over TCP prefix "coap+tcp://"
2223 * IPv6 address "[1234::5678]"
2224 * IPv4 address "192.168.1.1"
2225 * optional port ":5683"
2226 * resource uri "/oc/core..."
2228 * for PRESENCE requests, extract resource type.
2230 static OCStackResult ParseRequestUri(const char *fullUri,
2231 OCTransportAdapter adapter,
2232 OCTransportFlags flags,
2233 OCDevAddr **devAddr,
2235 char **resourceType)
2237 VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
2239 OCStackResult result = OC_STACK_OK;
2240 OCDevAddr *da = NULL;
2244 // provide defaults for all returned values
2251 *resourceUri = NULL;
2255 *resourceType = NULL;
2258 // delimit url prefix, if any
2259 const char *start = fullUri;
2260 char *slash2 = strstr(start, "//");
2265 char *slash = strchr(start, '/');
2268 return OC_STACK_INVALID_URI;
2271 // process url scheme
2272 size_t prefixLen = slash2 - fullUri;
2276 if ((prefixLen == sizeof(COAP_TCP) - 1) && (!strncmp(fullUri, COAP_TCP, prefixLen)))
2282 // TODO: this logic should come in with unit tests exercising the various strings
2283 // processs url prefix, if any
2284 size_t urlLen = slash - start;
2288 if (urlLen && devAddr)
2289 { // construct OCDevAddr
2290 if (start[0] == '[')
2292 char *close = strchr(++start, ']');
2293 if (!close || close > slash)
2295 return OC_STACK_INVALID_URI;
2298 if (close[1] == ':')
2305 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2309 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2311 flags = (OCTransportFlags)(flags | OC_IP_USE_V6);
2315 char *dot = strchr(start, '.');
2316 if (dot && dot < slash)
2318 colon = strchr(start, ':');
2319 end = (colon && colon < slash) ? colon : slash;
2324 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2328 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2330 flags = (OCTransportFlags)(flags | OC_IP_USE_V4);
2338 if (len >= sizeof(da->addr))
2340 return OC_STACK_INVALID_URI;
2342 // collect port, if any
2343 if (colon && colon < slash)
2345 for (colon++; colon < slash; colon++)
2348 if (c < '0' || c > '9')
2350 return OC_STACK_INVALID_URI;
2352 port = 10 * port + c - '0';
2357 if (len >= sizeof(da->addr))
2359 return OC_STACK_INVALID_URI;
2362 da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
2365 return OC_STACK_NO_MEMORY;
2367 OICStrcpyPartial(da->addr, sizeof(da->addr), start, len);
2369 da->adapter = adapter;
2371 if (!strncmp(fullUri, "coaps:", 6))
2373 da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
2378 // process resource uri, if any
2380 { // request uri and query
2381 size_t ulen = strlen(slash); // resource uri length
2382 size_t tlen = 0; // resource type length
2385 static const char strPresence[] = "/oic/ad?rt=";
2386 static const size_t lenPresence = sizeof(strPresence) - 1;
2387 if (!strncmp(slash, strPresence, lenPresence))
2389 type = slash + lenPresence;
2390 tlen = ulen - lenPresence;
2395 *resourceUri = (char *)OICMalloc(ulen + 1);
2398 result = OC_STACK_NO_MEMORY;
2401 strcpy(*resourceUri, slash);
2404 if (type && resourceType)
2406 *resourceType = (char *)OICMalloc(tlen + 1);
2409 result = OC_STACK_NO_MEMORY;
2413 OICStrcpy(*resourceType, (tlen+1), type);
2420 // free all returned values
2427 OICFree(*resourceUri);
2431 OICFree(*resourceType);
2436 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
2437 char *resourceUri, char **requestUri)
2439 char uri[CA_MAX_URI_LENGTH];
2441 FormCanonicalPresenceUri(endpoint, resourceUri, uri);
2443 *requestUri = OICStrdup(uri);
2446 return OC_STACK_NO_MEMORY;
2453 * Discover or Perform requests on a specified resource
2455 OCStackResult OCDoResource(OCDoHandle *handle,
2457 const char *requestUri,
2458 const OCDevAddr *destination,
2460 OCConnectivityType connectivityType,
2461 OCQualityOfService qos,
2462 OCCallbackData *cbData,
2463 OCHeaderOption *options,
2466 OIC_LOG(INFO, TAG, "Entering OCDoResource");
2468 // Validate input parameters
2469 VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
2470 VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
2471 VERIFY_NON_NULL(requestUri , FATAL, OC_STACK_INVALID_URI);
2473 OCStackResult result = OC_STACK_ERROR;
2474 CAResult_t caResult;
2475 CAToken_t token = NULL;
2476 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2477 ClientCB *clientCB = NULL;
2478 OCDoHandle resHandle = NULL;
2479 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2480 OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
2482 OCTransportAdapter adapter;
2483 OCTransportFlags flags;
2484 // the request contents are put here
2485 CARequestInfo_t requestInfo = {.method = CA_GET};
2486 // requestUri will be parsed into the following three variables
2487 OCDevAddr *devAddr = NULL;
2488 char *resourceUri = NULL;
2489 char *resourceType = NULL;
2492 * Support original behavior with address on resourceUri argument.
2494 adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2495 flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2497 result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2499 if (result != OC_STACK_OK)
2501 OIC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2508 case OC_REST_OBSERVE:
2509 case OC_REST_OBSERVE_ALL:
2510 case OC_REST_CANCEL_OBSERVE:
2511 requestInfo.method = CA_GET;
2514 requestInfo.method = CA_PUT;
2517 requestInfo.method = CA_POST;
2519 case OC_REST_DELETE:
2520 requestInfo.method = CA_DELETE;
2522 case OC_REST_DISCOVER:
2524 if (destination || devAddr)
2526 requestInfo.isMulticast = false;
2530 tmpDevAddr.adapter = adapter;
2531 tmpDevAddr.flags = flags;
2532 destination = &tmpDevAddr;
2533 requestInfo.isMulticast = true;
2535 // CA_DISCOVER will become GET and isMulticast
2536 requestInfo.method = CA_GET;
2538 #ifdef WITH_PRESENCE
2539 case OC_REST_PRESENCE:
2540 // Replacing method type with GET because "presence"
2541 // is a stack layer only implementation.
2542 requestInfo.method = CA_GET;
2546 result = OC_STACK_INVALID_METHOD;
2550 if (!devAddr && !destination)
2552 OIC_LOG(DEBUG, TAG, "no devAddr and no destination");
2553 result = OC_STACK_INVALID_PARAM;
2557 /* If not original behavior, use destination argument */
2558 if (destination && !devAddr)
2560 devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2563 result = OC_STACK_NO_MEMORY;
2566 *devAddr = *destination;
2569 resHandle = GenerateInvocationHandle();
2572 result = OC_STACK_NO_MEMORY;
2576 caResult = CAGenerateToken(&token, tokenLength);
2577 if (caResult != CA_STATUS_OK)
2579 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2580 result= OC_STACK_ERROR;
2584 // fill in request data
2585 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2586 requestInfo.info.token = token;
2587 requestInfo.info.tokenLength = tokenLength;
2588 requestInfo.info.resourceUri = resourceUri;
2590 if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2592 result = CreateObserveHeaderOption (&(requestInfo.info.options),
2593 options, numOptions, OC_OBSERVE_REGISTER);
2594 if (result != OC_STACK_OK)
2598 requestInfo.info.numOptions = numOptions + 1;
2602 requestInfo.info.numOptions = numOptions;
2603 requestInfo.info.options =
2604 (CAHeaderOption_t*) OICCalloc(numOptions, sizeof(CAHeaderOption_t));
2605 memcpy(requestInfo.info.options, (CAHeaderOption_t*)options,
2606 numOptions * sizeof(CAHeaderOption_t));
2609 CopyDevAddrToEndpoint(devAddr, &endpoint);
2614 OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2617 OIC_LOG(ERROR, TAG, "Failed to create CBOR Payload");
2620 requestInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
2624 requestInfo.info.payload = NULL;
2625 requestInfo.info.payloadSize = 0;
2626 requestInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
2629 if (result != OC_STACK_OK)
2631 OIC_LOG(ERROR, TAG, "CACreateEndpoint error");
2635 // prepare for response
2636 #ifdef WITH_PRESENCE
2637 if (method == OC_REST_PRESENCE)
2639 char *presenceUri = NULL;
2640 result = OCPreparePresence(&endpoint, resourceUri, &presenceUri);
2641 if (OC_STACK_OK != result)
2646 // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2647 // Presence notification will form a canonical uri to
2648 // look for callbacks into the application.
2649 resourceUri = presenceUri;
2653 ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2654 result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2655 method, devAddr, resourceUri, resourceType, ttl);
2656 if (OC_STACK_OK != result)
2661 devAddr = NULL; // Client CB list entry now owns it
2662 resourceUri = NULL; // Client CB list entry now owns it
2663 resourceType = NULL; // Client CB list entry now owns it
2666 result = OCSendRequest(&endpoint, &requestInfo);
2667 if (OC_STACK_OK != result)
2674 *handle = resHandle;
2678 if (result != OC_STACK_OK)
2680 OIC_LOG(ERROR, TAG, "OCDoResource error");
2681 FindAndDeleteClientCB(clientCB);
2682 CADestroyToken(token);
2690 // This is the owner of the payload object, so we free it
2691 OCPayloadDestroy(payload);
2692 OICFree(requestInfo.info.payload);
2694 OICFree(resourceUri);
2695 OICFree(resourceType);
2696 OICFree(requestInfo.info.options);
2700 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2704 * This ftn is implemented one of two ways in the case of observation:
2706 * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2707 * Remove the callback associated on client side.
2708 * When the next notification comes in from server,
2709 * reply with RESET message to server.
2710 * Keep in mind that the server will react to RESET only
2711 * if the last notification was sent as CON
2713 * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2714 * and it is associated with an observe request
2715 * (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2716 * Send CON Observe request to server with
2717 * observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2718 * Remove the callback associated on client side.
2720 OCStackResult ret = OC_STACK_OK;
2721 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2722 CARequestInfo_t requestInfo = {.method = CA_GET};
2726 return OC_STACK_INVALID_PARAM;
2729 ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2732 OIC_LOG(ERROR, TAG, "Callback not found. Called OCCancel on same resource twice?");
2733 return OC_STACK_ERROR;
2736 switch (clientCB->method)
2738 case OC_REST_OBSERVE:
2739 case OC_REST_OBSERVE_ALL:
2741 OIC_LOG_V(INFO, TAG, "Canceling observation for resource %s", clientCB->requestUri);
2743 CopyDevAddrToEndpoint(clientCB->devAddr, &endpoint);
2745 if ((endpoint.adapter & CA_ADAPTER_IP) && qos != OC_HIGH_QOS)
2747 FindAndDeleteClientCB(clientCB);
2751 OIC_LOG(INFO, TAG, "Cancelling observation as CONFIRMABLE");
2753 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2754 requestInfo.info.token = clientCB->token;
2755 requestInfo.info.tokenLength = clientCB->tokenLength;
2757 if (CreateObserveHeaderOption (&(requestInfo.info.options),
2758 options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2760 return OC_STACK_ERROR;
2762 requestInfo.info.numOptions = numOptions + 1;
2763 requestInfo.info.resourceUri = OICStrdup (clientCB->requestUri);
2766 ret = OCSendRequest(&endpoint, &requestInfo);
2768 if (requestInfo.info.options)
2770 OICFree (requestInfo.info.options);
2772 if (requestInfo.info.resourceUri)
2774 OICFree (requestInfo.info.resourceUri);
2779 case OC_REST_DISCOVER:
2780 OIC_LOG_V(INFO, TAG, "Cancelling discovery callback for resource %s",
2781 clientCB->requestUri);
2782 FindAndDeleteClientCB(clientCB);
2785 #ifdef WITH_PRESENCE
2786 case OC_REST_PRESENCE:
2787 FindAndDeleteClientCB(clientCB);
2792 ret = OC_STACK_INVALID_METHOD;
2800 * @brief Register Persistent storage callback.
2801 * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2803 * OC_STACK_OK - No errors; Success
2804 * OC_STACK_INVALID_PARAM - Invalid parameter
2806 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2808 OIC_LOG(INFO, TAG, "RegisterPersistentStorageHandler !!");
2809 if(!persistentStorageHandler)
2811 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2812 return OC_STACK_INVALID_PARAM;
2816 if( !persistentStorageHandler->open ||
2817 !persistentStorageHandler->close ||
2818 !persistentStorageHandler->read ||
2819 !persistentStorageHandler->unlink ||
2820 !persistentStorageHandler->write)
2822 OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2823 return OC_STACK_INVALID_PARAM;
2826 return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2829 #ifdef WITH_PRESENCE
2831 OCStackResult OCProcessPresence()
2833 OCStackResult result = OC_STACK_OK;
2835 // the following line floods the log with messages that are irrelevant
2836 // to most purposes. Uncomment as needed.
2837 //OIC_LOG(INFO, TAG, "Entering RequestPresence");
2838 ClientCB* cbNode = NULL;
2839 OCClientResponse clientResponse;
2840 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2842 LL_FOREACH(cbList, cbNode)
2844 if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
2849 uint32_t now = GetTicks(0);
2850 OIC_LOG_V(DEBUG, TAG, "this TTL level %d",
2851 cbNode->presence->TTLlevel);
2852 OIC_LOG_V(DEBUG, TAG, "current ticks %d", now);
2854 if (cbNode->presence->TTLlevel > PresenceTimeOutSize)
2859 if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
2861 OIC_LOG_V(DEBUG, TAG, "timeout ticks %d",
2862 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2864 if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2866 OIC_LOG(DEBUG, TAG, "No more timeout ticks");
2868 clientResponse.sequenceNumber = 0;
2869 clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
2870 clientResponse.devAddr = *cbNode->devAddr;
2871 FixUpClientResponse(&clientResponse);
2872 clientResponse.payload = NULL;
2874 // Increment the TTLLevel (going to a next state), so we don't keep
2875 // sending presence notification to client.
2876 cbNode->presence->TTLlevel++;
2877 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
2878 cbNode->presence->TTLlevel);
2880 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
2881 if (cbResult == OC_STACK_DELETE_TRANSACTION)
2883 FindAndDeleteClientCB(cbNode);
2887 if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2892 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2893 CAInfo_t requestData = {.type = CA_MSG_CONFIRM};
2894 CARequestInfo_t requestInfo = {.method = CA_GET};
2896 OIC_LOG(DEBUG, TAG, "time to test server presence");
2898 CopyDevAddrToEndpoint(cbNode->devAddr, &endpoint);
2900 requestData.type = CA_MSG_NONCONFIRM;
2901 requestData.token = cbNode->token;
2902 requestData.tokenLength = cbNode->tokenLength;
2903 requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
2904 requestInfo.method = CA_GET;
2905 requestInfo.info = requestData;
2907 result = OCSendRequest(&endpoint, &requestInfo);
2908 if (OC_STACK_OK != result)
2913 cbNode->presence->TTLlevel++;
2914 OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
2917 if (result != OC_STACK_OK)
2919 OIC_LOG(ERROR, TAG, "OCProcessPresence error");
2924 #endif // WITH_PRESENCE
2926 OCStackResult OCProcess()
2928 #ifdef WITH_PRESENCE
2929 OCProcessPresence();
2931 CAHandleRequestResponse();
2933 #ifdef ROUTING_GATEWAY
2943 #ifdef WITH_PRESENCE
2944 OCStackResult OCStartPresence(const uint32_t ttl)
2946 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2947 OCChangeResourceProperty(
2948 &(((OCResource *)presenceResource.handle)->resourceProperties),
2951 if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
2953 presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
2954 OIC_LOG(INFO, TAG, "Setting Presence TTL to max value");
2958 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
2959 OIC_LOG(INFO, TAG, "Setting Presence TTL to default value");
2963 presenceResource.presenceTTL = ttl;
2965 OIC_LOG_V(DEBUG, TAG, "Presence TTL is %" PRIu32 " seconds", presenceResource.presenceTTL);
2967 if (OC_PRESENCE_UNINITIALIZED == presenceState)
2969 presenceState = OC_PRESENCE_INITIALIZED;
2971 OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
2973 CAToken_t caToken = NULL;
2974 CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
2975 if (caResult != CA_STATUS_OK)
2977 OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2978 CADestroyToken(caToken);
2979 return OC_STACK_ERROR;
2982 AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
2983 (OCResource *)presenceResource.handle, OC_LOW_QOS, OC_FORMAT_UNDEFINED, &devAddr);
2984 CADestroyToken(caToken);
2987 // Each time OCStartPresence is called
2988 // a different random 32-bit integer number is used
2989 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2991 return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
2992 OC_PRESENCE_TRIGGER_CREATE);
2995 OCStackResult OCStopPresence()
2997 OCStackResult result = OC_STACK_ERROR;
2999 if(presenceResource.handle)
3001 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3003 // make resource inactive
3004 result = OCChangeResourceProperty(
3005 &(((OCResource *) presenceResource.handle)->resourceProperties),
3009 if(result != OC_STACK_OK)
3012 "Changing the presence resource properties to ACTIVE not successful");
3016 return SendStopNotification();
3020 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
3021 void* callbackParameter)
3023 defaultDeviceHandler = entityHandler;
3024 defaultDeviceHandlerCallbackParameter = callbackParameter;
3029 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo)
3031 OIC_LOG(INFO, TAG, "Entering OCSetPlatformInfo");
3033 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER || myStackMode == OC_GATEWAY)
3035 if (validatePlatformInfo(platformInfo))
3037 return SavePlatformInfo(platformInfo);
3041 return OC_STACK_INVALID_PARAM;
3046 return OC_STACK_ERROR;
3050 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
3052 OIC_LOG(INFO, TAG, "Entering OCSetDeviceInfo");
3054 if (!deviceInfo.deviceName || deviceInfo.deviceName[0] == '\0')
3056 OIC_LOG(ERROR, TAG, "Null or empty device name.");
3057 return OC_STACK_INVALID_PARAM;
3060 if (deviceInfo.types)
3062 OCStringLL *type = deviceInfo.types;
3063 OCResource *resource = findResource((OCResource *) deviceResource);
3066 return OC_STACK_INVALID_PARAM;
3068 deleteResourceType(resource->rsrcType);
3069 resource->rsrcType = NULL;
3073 OCBindResourceTypeToResource(deviceResource, type->value);
3077 return SaveDeviceInfo(deviceInfo);
3080 OCStackResult OCCreateResource(OCResourceHandle *handle,
3081 const char *resourceTypeName,
3082 const char *resourceInterfaceName,
3083 const char *uri, OCEntityHandler entityHandler,
3084 void* callbackParam,
3085 uint8_t resourceProperties)
3088 OCResource *pointer = NULL;
3089 OCStackResult result = OC_STACK_ERROR;
3091 OIC_LOG(INFO, TAG, "Entering OCCreateResource");
3093 if(myStackMode == OC_CLIENT)
3095 return OC_STACK_INVALID_PARAM;
3097 // Validate parameters
3098 if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
3100 OIC_LOG(ERROR, TAG, "URI is empty or too long");
3101 return OC_STACK_INVALID_URI;
3103 // Is it presented during resource discovery?
3104 if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
3106 OIC_LOG(ERROR, TAG, "Input parameter is NULL");
3107 return OC_STACK_INVALID_PARAM;
3110 if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
3112 resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
3115 // Make sure resourceProperties bitmask has allowed properties specified
3116 if (resourceProperties
3117 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
3118 OC_EXPLICIT_DISCOVERABLE))
3120 OIC_LOG(ERROR, TAG, "Invalid property");
3121 return OC_STACK_INVALID_PARAM;
3124 // If the headResource is NULL, then no resources have been created...
3125 pointer = headResource;
3128 // At least one resources is in the resource list, so we need to search for
3129 // repeated URLs, which are not allowed. If a repeat is found, exit with an error
3132 if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
3134 OIC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
3135 return OC_STACK_INVALID_PARAM;
3137 pointer = pointer->next;
3140 // Create the pointer and insert it into the resource list
3141 pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
3144 result = OC_STACK_NO_MEMORY;
3147 pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
3149 insertResource(pointer);
3152 pointer->uri = OICStrdup(uri);
3155 result = OC_STACK_NO_MEMORY;
3159 // Set properties. Set OC_ACTIVE
3160 pointer->resourceProperties = (OCResourceProperty) (resourceProperties
3163 // Add the resourcetype to the resource
3164 result = BindResourceTypeToResource(pointer, resourceTypeName);
3165 if (result != OC_STACK_OK)
3167 OIC_LOG(ERROR, TAG, "Error adding resourcetype");
3171 // Add the resourceinterface to the resource
3172 result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
3173 if (result != OC_STACK_OK)
3175 OIC_LOG(ERROR, TAG, "Error adding resourceinterface");
3179 // If an entity handler has been passed, attach it to the newly created
3180 // resource. Otherwise, set the default entity handler.
3183 pointer->entityHandler = entityHandler;
3184 pointer->entityHandlerCallbackParam = callbackParam;
3188 pointer->entityHandler = defaultResourceEHandler;
3189 pointer->entityHandlerCallbackParam = NULL;
3192 // Initialize a pointer indicating child resources in case of collection
3193 pointer->rsrcChildResourcesHead = NULL;
3196 result = OC_STACK_OK;
3198 #ifdef WITH_PRESENCE
3199 if (presenceResource.handle)
3201 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3202 SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
3206 if (result != OC_STACK_OK)
3208 // Deep delete of resource and other dynamic elements that it contains
3209 deleteResource(pointer);
3214 OCStackResult OCBindResource(
3215 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3217 OCResource *resource = NULL;
3218 OCChildResource *tempChildResource = NULL;
3219 OCChildResource *newChildResource = NULL;
3221 OIC_LOG(INFO, TAG, "Entering OCBindResource");
3223 // Validate parameters
3224 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3225 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3226 // Container cannot contain itself
3227 if (collectionHandle == resourceHandle)
3229 OIC_LOG(ERROR, TAG, "Added handle equals collection handle");
3230 return OC_STACK_INVALID_PARAM;
3233 // Use the handle to find the resource in the resource linked list
3234 resource = findResource((OCResource *) collectionHandle);
3237 OIC_LOG(ERROR, TAG, "Collection handle not found");
3238 return OC_STACK_INVALID_PARAM;
3241 // Look for an open slot to add add the child resource.
3242 // If found, add it and return success
3244 tempChildResource = resource->rsrcChildResourcesHead;
3246 while(resource->rsrcChildResourcesHead && tempChildResource->next)
3248 // TODO: what if one of child resource was deregistered without unbinding?
3249 tempChildResource = tempChildResource->next;
3252 // Do memory allocation for child resource
3253 newChildResource = (OCChildResource *) OICCalloc(1, sizeof(OCChildResource));
3254 if(!newChildResource)
3256 OIC_LOG(ERROR, TAG, "Adding new child resource is failed due to memory allocation failure");
3257 return OC_STACK_ERROR;
3260 newChildResource->rsrcResource = (OCResource *) resourceHandle;
3261 newChildResource->next = NULL;
3263 if(!resource->rsrcChildResourcesHead)
3265 resource->rsrcChildResourcesHead = newChildResource;
3268 tempChildResource->next = newChildResource;
3271 OIC_LOG(INFO, TAG, "resource bound");
3273 #ifdef WITH_PRESENCE
3274 if (presenceResource.handle)
3276 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3277 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3278 OC_PRESENCE_TRIGGER_CHANGE);
3285 OCStackResult OCUnBindResource(
3286 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3288 OCResource *resource = NULL;
3289 OCChildResource *tempChildResource = NULL;
3290 OCChildResource *tempLastChildResource = NULL;
3292 OIC_LOG(INFO, TAG, "Entering OCUnBindResource");
3294 // Validate parameters
3295 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3296 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3297 // Container cannot contain itself
3298 if (collectionHandle == resourceHandle)
3300 OIC_LOG(ERROR, TAG, "removing handle equals collection handle");
3301 return OC_STACK_INVALID_PARAM;
3304 // Use the handle to find the resource in the resource linked list
3305 resource = findResource((OCResource *) collectionHandle);
3308 OIC_LOG(ERROR, TAG, "Collection handle not found");
3309 return OC_STACK_INVALID_PARAM;
3312 // Look for an open slot to add add the child resource.
3313 // If found, add it and return success
3314 if(!resource->rsrcChildResourcesHead)
3316 OIC_LOG(INFO, TAG, "resource not found in collection");
3318 // Unable to add resourceHandle, so return error
3319 return OC_STACK_ERROR;
3323 tempChildResource = resource->rsrcChildResourcesHead;
3325 while (tempChildResource)
3327 if(tempChildResource->rsrcResource == resourceHandle)
3329 // if resource going to be unbinded is the head one.
3330 if( tempChildResource == resource->rsrcChildResourcesHead )
3332 OCChildResource *temp = resource->rsrcChildResourcesHead->next;
3333 OICFree(resource->rsrcChildResourcesHead);
3334 resource->rsrcChildResourcesHead = temp;
3339 OCChildResource *temp = tempChildResource->next;
3340 OICFree(tempChildResource);
3341 tempLastChildResource->next = temp;
3345 OIC_LOG(INFO, TAG, "resource unbound");
3347 // Send notification when resource is unbounded successfully.
3348 #ifdef WITH_PRESENCE
3349 if (presenceResource.handle)
3351 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3352 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3353 OC_PRESENCE_TRIGGER_CHANGE);
3356 tempChildResource = NULL;
3357 tempLastChildResource = NULL;
3363 tempLastChildResource = tempChildResource;
3364 tempChildResource = tempChildResource->next;
3367 OIC_LOG(INFO, TAG, "resource not found in collection");
3369 tempChildResource = NULL;
3370 tempLastChildResource = NULL;
3372 // Unable to add resourceHandle, so return error
3373 return OC_STACK_ERROR;
3376 // Precondition is that the parameter has been checked to not equal NULL.
3377 static bool ValidateResourceTypeInterface(const char *resourceItemName)
3379 if (resourceItemName[0] < 'a' || resourceItemName[0] > 'z')
3385 while (resourceItemName[index] != '\0')
3387 if (resourceItemName[index] != '.' &&
3388 resourceItemName[index] != '-' &&
3389 (resourceItemName[index] < 'a' || resourceItemName[index] > 'z') &&
3390 (resourceItemName[index] < '0' || resourceItemName[index] > '9'))
3399 OCStackResult BindResourceTypeToResource(OCResource* resource,
3400 const char *resourceTypeName)
3402 OCResourceType *pointer = NULL;
3404 OCStackResult result = OC_STACK_ERROR;
3406 VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
3408 if (!ValidateResourceTypeInterface(resourceTypeName))
3410 OIC_LOG(ERROR, TAG, "resource type illegal (see RFC 6690)");
3411 return OC_STACK_INVALID_PARAM;
3414 pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
3417 result = OC_STACK_NO_MEMORY;
3421 str = OICStrdup(resourceTypeName);
3424 result = OC_STACK_NO_MEMORY;
3427 pointer->resourcetypename = str;
3428 pointer->next = NULL;
3430 insertResourceType(resource, pointer);
3431 result = OC_STACK_OK;
3434 if (result != OC_STACK_OK)
3443 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
3444 const char *resourceInterfaceName)
3446 OCResourceInterface *pointer = NULL;
3448 OCStackResult result = OC_STACK_ERROR;
3450 VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
3452 if (!ValidateResourceTypeInterface(resourceInterfaceName))
3454 OIC_LOG(ERROR, TAG, "resource /interface illegal (see RFC 6690)");
3455 return OC_STACK_INVALID_PARAM;
3458 OIC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
3460 pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
3463 result = OC_STACK_NO_MEMORY;
3467 str = OICStrdup(resourceInterfaceName);
3470 result = OC_STACK_NO_MEMORY;
3473 pointer->name = str;
3475 // Bind the resourceinterface to the resource
3476 insertResourceInterface(resource, pointer);
3478 result = OC_STACK_OK;
3481 if (result != OC_STACK_OK)
3490 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
3491 const char *resourceTypeName)
3494 OCStackResult result = OC_STACK_ERROR;
3495 OCResource *resource = NULL;
3497 resource = findResource((OCResource *) handle);
3500 OIC_LOG(ERROR, TAG, "Resource not found");
3501 return OC_STACK_ERROR;
3504 result = BindResourceTypeToResource(resource, resourceTypeName);
3506 #ifdef WITH_PRESENCE
3507 if(presenceResource.handle)
3509 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3510 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3517 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
3518 const char *resourceInterfaceName)
3521 OCStackResult result = OC_STACK_ERROR;
3522 OCResource *resource = NULL;
3524 resource = findResource((OCResource *) handle);
3527 OIC_LOG(ERROR, TAG, "Resource not found");
3528 return OC_STACK_ERROR;
3531 result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
3533 #ifdef WITH_PRESENCE
3534 if (presenceResource.handle)
3536 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3537 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3544 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
3546 OCResource *pointer = headResource;
3548 VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
3552 *numResources = *numResources + 1;
3553 pointer = pointer->next;
3558 OCResourceHandle OCGetResourceHandle(uint8_t index)
3560 OCResource *pointer = headResource;
3562 for( uint8_t i = 0; i < index && pointer; ++i)
3564 pointer = pointer->next;
3566 return (OCResourceHandle) pointer;
3569 OCStackResult OCDeleteResource(OCResourceHandle handle)
3573 OIC_LOG(ERROR, TAG, "Invalid handle for deletion");
3574 return OC_STACK_INVALID_PARAM;
3577 OCResource *resource = findResource((OCResource *) handle);
3578 if (resource == NULL)
3580 OIC_LOG(ERROR, TAG, "Resource not found");
3581 return OC_STACK_NO_RESOURCE;
3584 if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3586 OIC_LOG(ERROR, TAG, "Error deleting resource");
3587 return OC_STACK_ERROR;
3593 const char *OCGetResourceUri(OCResourceHandle handle)
3595 OCResource *resource = NULL;
3597 resource = findResource((OCResource *) handle);
3600 return resource->uri;
3602 return (const char *) NULL;
3605 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3607 OCResource *resource = NULL;
3609 resource = findResource((OCResource *) handle);
3612 return resource->resourceProperties;
3614 return (OCResourceProperty)-1;
3617 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3618 uint8_t *numResourceTypes)
3620 OCResource *resource = NULL;
3621 OCResourceType *pointer = NULL;
3623 VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3624 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3626 *numResourceTypes = 0;
3628 resource = findResource((OCResource *) handle);
3631 pointer = resource->rsrcType;
3634 *numResourceTypes = *numResourceTypes + 1;
3635 pointer = pointer->next;
3641 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3643 OCResourceType *resourceType = NULL;
3645 resourceType = findResourceTypeAtIndex(handle, index);
3648 return resourceType->resourcetypename;
3650 return (const char *) NULL;
3653 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3654 uint8_t *numResourceInterfaces)
3656 OCResourceInterface *pointer = NULL;
3657 OCResource *resource = NULL;
3659 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3660 VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3662 *numResourceInterfaces = 0;
3663 resource = findResource((OCResource *) handle);
3666 pointer = resource->rsrcInterface;
3669 *numResourceInterfaces = *numResourceInterfaces + 1;
3670 pointer = pointer->next;
3676 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3678 OCResourceInterface *resourceInterface = NULL;
3680 resourceInterface = findResourceInterfaceAtIndex(handle, index);
3681 if (resourceInterface)
3683 return resourceInterface->name;
3685 return (const char *) NULL;
3688 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3691 OCResource *resource = NULL;
3692 OCChildResource *tempChildResource = NULL;
3695 resource = findResource((OCResource *) collectionHandle);
3701 tempChildResource = resource->rsrcChildResourcesHead;
3703 while(tempChildResource)
3707 return tempChildResource->rsrcResource;
3710 tempChildResource = tempChildResource->next;
3713 // In this case, the number of resource handles in the collection exceeds the index
3714 tempChildResource = NULL;
3718 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3719 OCEntityHandler entityHandler,
3720 void* callbackParam)
3722 OCResource *resource = NULL;
3724 // Validate parameters
3725 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3727 // Use the handle to find the resource in the resource linked list
3728 resource = findResource((OCResource *)handle);
3731 OIC_LOG(ERROR, TAG, "Resource not found");
3732 return OC_STACK_ERROR;
3736 resource->entityHandler = entityHandler;
3737 resource->entityHandlerCallbackParam = callbackParam;
3739 #ifdef WITH_PRESENCE
3740 if (presenceResource.handle)
3742 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3743 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3750 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3752 OCResource *resource = NULL;
3754 resource = findResource((OCResource *)handle);
3757 OIC_LOG(ERROR, TAG, "Resource not found");
3762 return resource->entityHandler;
3765 void incrementSequenceNumber(OCResource * resPtr)
3767 // Increment the sequence number
3768 resPtr->sequenceNum += 1;
3769 if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3771 resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3776 #ifdef WITH_PRESENCE
3777 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3778 OCPresenceTrigger trigger)
3780 OCResource *resPtr = NULL;
3781 OCStackResult result = OC_STACK_ERROR;
3782 OCMethod method = OC_REST_PRESENCE;
3783 uint32_t maxAge = 0;
3784 resPtr = findResource((OCResource *) presenceResource.handle);
3787 return OC_STACK_NO_RESOURCE;
3790 if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3792 maxAge = presenceResource.presenceTTL;
3794 result = SendAllObserverNotification(method, resPtr, maxAge,
3795 trigger, resourceType, OC_LOW_QOS);
3801 OCStackResult SendStopNotification()
3803 OCResource *resPtr = NULL;
3804 OCStackResult result = OC_STACK_ERROR;
3805 OCMethod method = OC_REST_PRESENCE;
3806 resPtr = findResource((OCResource *) presenceResource.handle);
3809 return OC_STACK_NO_RESOURCE;
3812 // maxAge is 0. ResourceType is NULL.
3813 result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3819 #endif // WITH_PRESENCE
3820 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3822 OCResource *resPtr = NULL;
3823 OCStackResult result = OC_STACK_ERROR;
3824 OCMethod method = OC_REST_NOMETHOD;
3825 uint32_t maxAge = 0;
3827 OIC_LOG(INFO, TAG, "Notifying all observers");
3828 #ifdef WITH_PRESENCE
3829 if(handle == presenceResource.handle)
3833 #endif // WITH_PRESENCE
3834 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3836 // Verify that the resource exists
3837 resPtr = findResource ((OCResource *) handle);
3840 return OC_STACK_NO_RESOURCE;
3844 //only increment in the case of regular observing (not presence)
3845 incrementSequenceNumber(resPtr);
3846 method = OC_REST_OBSERVE;
3847 maxAge = MAX_OBSERVE_AGE;
3848 #ifdef WITH_PRESENCE
3849 result = SendAllObserverNotification (method, resPtr, maxAge,
3850 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3852 result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3859 OCNotifyListOfObservers (OCResourceHandle handle,
3860 OCObservationId *obsIdList,
3861 uint8_t numberOfIds,
3862 const OCRepPayload *payload,
3863 OCQualityOfService qos)
3865 OIC_LOG(INFO, TAG, "Entering OCNotifyListOfObservers");
3867 OCResource *resPtr = NULL;
3868 //TODO: we should allow the server to define this
3869 uint32_t maxAge = MAX_OBSERVE_AGE;
3871 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3872 VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3873 VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
3875 resPtr = findResource ((OCResource *) handle);
3876 if (NULL == resPtr || myStackMode == OC_CLIENT)
3878 return OC_STACK_NO_RESOURCE;
3882 incrementSequenceNumber(resPtr);
3884 return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3885 payload, maxAge, qos));
3888 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3890 OCStackResult result = OC_STACK_ERROR;
3891 OCServerRequest *serverRequest = NULL;
3893 OIC_LOG(INFO, TAG, "Entering OCDoResponse");
3895 // Validate input parameters
3896 VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3897 VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3900 // Get pointer to request info
3901 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3904 // response handler in ocserverrequest.c. Usually HandleSingleResponse.
3905 result = serverRequest->ehResponseHandler(ehResponse);
3911 //#ifdef DIRECT_PAIRING
3912 const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime)
3914 OIC_LOG(INFO, TAG, "Start OCDiscoverDirectPairingDevices");
3915 if(OC_STACK_OK != DPDeviceDiscovery(waittime))
3917 OIC_LOG(ERROR, TAG, "Fail to discover Direct-Pairing device");
3921 return (const OCDPDev_t*)DPGetDiscoveredDevices();
3924 const OCDPDev_t* OCGetDirectPairedDevices()
3926 return (const OCDPDev_t*)DPGetPairedDevices();
3929 void DirectPairingCB (OCDirectPairingDev_t * peer, OCStackResult result)
3931 if (gDirectpairingCallback)
3933 gDirectpairingCallback((OCDPDev_t*)peer, result);
3934 gDirectpairingCallback = NULL;
3938 OCStackResult OCDoDirectPairing(OCDPDev_t* peer, OCPrm_t pmSel, char *pinNumber,
3939 OCDirectPairingCB resultCallback)
3941 OIC_LOG(INFO, TAG, "Start OCDoDirectPairing");
3942 if(NULL == peer || NULL == pinNumber)
3944 OIC_LOG(ERROR, TAG, "Invalid parameters");
3945 return OC_STACK_INVALID_PARAM;
3947 if (NULL == resultCallback)
3949 OIC_LOG(ERROR, TAG, "Invalid callback");
3950 return OC_STACK_INVALID_CALLBACK;
3953 gDirectpairingCallback = resultCallback;
3954 return DPDirectPairing((OCDirectPairingDev_t*)peer, (OicSecPrm_t)pmSel,
3955 pinNumber, DirectPairingCB);
3957 //#endif // DIRECT_PAIRING
3959 //-----------------------------------------------------------------------------
3960 // Private internal function definitions
3961 //-----------------------------------------------------------------------------
3962 static OCDoHandle GenerateInvocationHandle()
3964 OCDoHandle handle = NULL;
3965 // Generate token here, it will be deleted when the transaction is deleted
3966 handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3969 OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3975 #ifdef WITH_PRESENCE
3976 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3977 OCResourceProperty resourceProperties, uint8_t enable)
3981 return OC_STACK_INVALID_PARAM;
3983 if (resourceProperties
3984 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
3986 OIC_LOG(ERROR, TAG, "Invalid property");
3987 return OC_STACK_INVALID_PARAM;
3991 *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3995 *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
4001 OCStackResult initResources()
4003 OCStackResult result = OC_STACK_OK;
4005 headResource = NULL;
4006 tailResource = NULL;
4007 // Init Virtual Resources
4008 #ifdef WITH_PRESENCE
4009 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
4011 result = OCCreateResource(&presenceResource.handle,
4012 OC_RSRVD_RESOURCE_TYPE_PRESENCE,
4014 OC_RSRVD_PRESENCE_URI,
4018 //make resource inactive
4019 result = OCChangeResourceProperty(
4020 &(((OCResource *) presenceResource.handle)->resourceProperties),
4023 #ifndef WITH_ARDUINO
4024 if (result == OC_STACK_OK)
4026 result = SRMInitSecureResources();
4030 if(result == OC_STACK_OK)
4032 result = OCCreateResource(&deviceResource,
4033 OC_RSRVD_RESOURCE_TYPE_DEVICE,
4034 OC_RSRVD_INTERFACE_DEFAULT,
4035 OC_RSRVD_DEVICE_URI,
4039 if(result == OC_STACK_OK)
4041 result = BindResourceInterfaceToResource((OCResource *)deviceResource,
4042 OC_RSRVD_INTERFACE_READ);
4046 if(result == OC_STACK_OK)
4048 result = OCCreateResource(&platformResource,
4049 OC_RSRVD_RESOURCE_TYPE_PLATFORM,
4050 OC_RSRVD_INTERFACE_DEFAULT,
4051 OC_RSRVD_PLATFORM_URI,
4055 if(result == OC_STACK_OK)
4057 result = BindResourceInterfaceToResource((OCResource *)platformResource,
4058 OC_RSRVD_INTERFACE_READ);
4065 void insertResource(OCResource *resource)
4069 headResource = resource;
4070 tailResource = resource;
4074 tailResource->next = resource;
4075 tailResource = resource;
4077 resource->next = NULL;
4080 OCResource *findResource(OCResource *resource)
4082 OCResource *pointer = headResource;
4086 if (pointer == resource)
4090 pointer = pointer->next;
4095 void deleteAllResources()
4097 OCResource *pointer = headResource;
4098 OCResource *temp = NULL;
4102 temp = pointer->next;
4103 #ifdef WITH_PRESENCE
4104 if (pointer != (OCResource *) presenceResource.handle)
4106 #endif // WITH_PRESENCE
4107 deleteResource(pointer);
4108 #ifdef WITH_PRESENCE
4110 #endif // WITH_PRESENCE
4114 SRMDeInitSecureResources();
4116 #ifdef WITH_PRESENCE
4117 // Ensure that the last resource to be deleted is the presence resource. This allows for all
4118 // presence notification attributed to their deletion to be processed.
4119 deleteResource((OCResource *) presenceResource.handle);
4120 #endif // WITH_PRESENCE
4123 OCStackResult deleteResource(OCResource *resource)
4125 OCResource *prev = NULL;
4126 OCResource *temp = NULL;
4129 OIC_LOG(DEBUG,TAG,"resource is NULL");
4130 return OC_STACK_INVALID_PARAM;
4133 OIC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
4135 temp = headResource;
4138 if (temp == resource)
4140 // Invalidate all Resource Properties.
4141 resource->resourceProperties = (OCResourceProperty) 0;
4142 #ifdef WITH_PRESENCE
4143 if(resource != (OCResource *) presenceResource.handle)
4145 #endif // WITH_PRESENCE
4146 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
4147 #ifdef WITH_PRESENCE
4150 if(presenceResource.handle)
4152 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
4153 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
4156 // Only resource in list.
4157 if (temp == headResource && temp == tailResource)
4159 headResource = NULL;
4160 tailResource = NULL;
4163 else if (temp == headResource)
4165 headResource = temp->next;
4168 else if (temp == tailResource)
4170 tailResource = prev;
4171 tailResource->next = NULL;
4175 prev->next = temp->next;
4178 deleteResourceElements(temp);
4189 return OC_STACK_ERROR;
4192 void deleteResourceElements(OCResource *resource)
4199 OICFree(resource->uri);
4200 deleteResourceType(resource->rsrcType);
4201 deleteResourceInterface(resource->rsrcInterface);
4204 void deleteResourceType(OCResourceType *resourceType)
4206 OCResourceType *pointer = resourceType;
4207 OCResourceType *next = NULL;
4211 next = pointer->next;
4212 OICFree(pointer->resourcetypename);
4218 void deleteResourceInterface(OCResourceInterface *resourceInterface)
4220 OCResourceInterface *pointer = resourceInterface;
4221 OCResourceInterface *next = NULL;
4225 next = pointer->next;
4226 OICFree(pointer->name);
4232 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
4234 OCResourceType *pointer = NULL;
4235 OCResourceType *previous = NULL;
4236 if (!resource || !resourceType)
4240 // resource type list is empty.
4241 else if (!resource->rsrcType)
4243 resource->rsrcType = resourceType;
4247 pointer = resource->rsrcType;
4251 if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
4253 OIC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
4254 OICFree(resourceType->resourcetypename);
4255 OICFree(resourceType);
4259 pointer = pointer->next;
4264 previous->next = resourceType;
4267 resourceType->next = NULL;
4269 OIC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
4272 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
4274 OCResource *resource = NULL;
4275 OCResourceType *pointer = NULL;
4277 // Find the specified resource
4278 resource = findResource((OCResource *) handle);
4284 // Make sure a resource has a resourcetype
4285 if (!resource->rsrcType)
4290 // Iterate through the list
4291 pointer = resource->rsrcType;
4292 for(uint8_t i = 0; i< index && pointer; ++i)
4294 pointer = pointer->next;
4299 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
4301 if(resourceTypeList && resourceTypeName)
4303 OCResourceType * rtPointer = resourceTypeList;
4304 while(resourceTypeName && rtPointer)
4306 if(rtPointer->resourcetypename &&
4307 strcmp(resourceTypeName, (const char *)
4308 (rtPointer->resourcetypename)) == 0)
4312 rtPointer = rtPointer->next;
4320 * Insert a new interface into interface linked list only if not already present.
4321 * If alredy present, 2nd arg is free'd.
4322 * Default interface will always be first if present.
4324 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
4326 OCResourceInterface *pointer = NULL;
4327 OCResourceInterface *previous = NULL;
4329 newInterface->next = NULL;
4331 OCResourceInterface **firstInterface = &(resource->rsrcInterface);
4333 if (!*firstInterface)
4335 // If first interface is not oic.if.baseline, by default add it as first interface type.
4336 if (0 == strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT))
4338 *firstInterface = newInterface;
4342 OCStackResult result = BindResourceInterfaceToResource(resource, OC_RSRVD_INTERFACE_DEFAULT);
4343 if (result != OC_STACK_OK)
4345 OICFree(newInterface->name);
4346 OICFree(newInterface);
4349 if (*firstInterface)
4351 (*firstInterface)->next = newInterface;
4355 // If once add oic.if.baseline, later too below code take care of freeing memory.
4356 else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4358 if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4360 OICFree(newInterface->name);
4361 OICFree(newInterface);
4364 // This code will not hit anymore, keeping
4367 newInterface->next = *firstInterface;
4368 *firstInterface = newInterface;
4373 pointer = *firstInterface;
4376 if (strcmp(newInterface->name, pointer->name) == 0)
4378 OICFree(newInterface->name);
4379 OICFree(newInterface);
4383 pointer = pointer->next;
4385 previous->next = newInterface;
4389 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
4392 OCResource *resource = NULL;
4393 OCResourceInterface *pointer = NULL;
4395 // Find the specified resource
4396 resource = findResource((OCResource *) handle);
4402 // Make sure a resource has a resourceinterface
4403 if (!resource->rsrcInterface)
4408 // Iterate through the list
4409 pointer = resource->rsrcInterface;
4411 for (uint8_t i = 0; i < index && pointer; ++i)
4413 pointer = pointer->next;
4419 * This function splits the uri using the '?' delimiter.
4420 * "uriWithoutQuery" is the block of characters between the beginning
4421 * till the delimiter or '\0' which ever comes first.
4422 * "query" is whatever is to the right of the delimiter if present.
4423 * No delimiter sets the query to NULL.
4424 * If either are present, they will be malloc'ed into the params 2, 3.
4425 * The first param, *uri is left untouched.
4427 * NOTE: This function does not account for whitespace at the end of the uri NOR
4428 * malformed uri's with '??'. Whitespace at the end will be assumed to be
4429 * part of the query.
4431 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
4435 return OC_STACK_INVALID_URI;
4437 if(!query || !uriWithoutQuery)
4439 return OC_STACK_INVALID_PARAM;
4443 *uriWithoutQuery = NULL;
4445 size_t uriWithoutQueryLen = 0;
4446 size_t queryLen = 0;
4447 size_t uriLen = strlen(uri);
4449 char *pointerToDelimiter = strstr(uri, "?");
4451 uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : (size_t)(pointerToDelimiter - uri);
4452 queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
4454 if (uriWithoutQueryLen)
4456 *uriWithoutQuery = (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
4457 if (!*uriWithoutQuery)
4461 OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
4465 *query = (char *) OICCalloc(queryLen + 1, 1);
4468 OICFree(*uriWithoutQuery);
4469 *uriWithoutQuery = NULL;
4472 OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
4478 return OC_STACK_NO_MEMORY;
4481 static const OicUuid_t* OCGetServerInstanceID(void)
4483 static bool generated = false;
4484 static OicUuid_t sid;
4490 if (OC_STACK_OK != GetDoxmDeviceID(&sid))
4492 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
4499 const char* OCGetServerInstanceIDString(void)
4501 static bool generated = false;
4502 static char sidStr[UUID_STRING_SIZE];
4509 const OicUuid_t *sid = OCGetServerInstanceID();
4510 if(OCConvertUuidToString(sid->id, sidStr) != RAND_UUID_OK)
4512 OIC_LOG(FATAL, TAG, "Generate UUID String for Server Instance failed!");
4520 CAResult_t OCSelectNetwork()
4522 CAResult_t retResult = CA_STATUS_FAILED;
4523 CAResult_t caResult = CA_STATUS_OK;
4525 CATransportAdapter_t connTypes[] = {
4527 CA_ADAPTER_RFCOMM_BTEDR,
4528 CA_ADAPTER_GATT_BTLE,
4531 ,CA_ADAPTER_REMOTE_ACCESS
4538 int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
4540 for(int i = 0; i<numConnTypes; i++)
4542 // Ignore CA_NOT_SUPPORTED error. The CA Layer may have not compiled in the interface.
4543 if(caResult == CA_STATUS_OK || caResult == CA_NOT_SUPPORTED)
4545 caResult = CASelectNetwork(connTypes[i]);
4546 if(caResult == CA_STATUS_OK)
4548 retResult = CA_STATUS_OK;
4553 if(retResult != CA_STATUS_OK)
4555 return caResult; // Returns error of appropriate transport that failed fatally.
4561 OCStackResult CAResultToOCResult(CAResult_t caResult)
4567 case CA_STATUS_INVALID_PARAM:
4568 return OC_STACK_INVALID_PARAM;
4569 case CA_ADAPTER_NOT_ENABLED:
4570 return OC_STACK_ADAPTER_NOT_ENABLED;
4571 case CA_SERVER_STARTED_ALREADY:
4573 case CA_SERVER_NOT_STARTED:
4574 return OC_STACK_ERROR;
4575 case CA_DESTINATION_NOT_REACHABLE:
4576 return OC_STACK_COMM_ERROR;
4577 case CA_SOCKET_OPERATION_FAILED:
4578 return OC_STACK_COMM_ERROR;
4579 case CA_SEND_FAILED:
4580 return OC_STACK_COMM_ERROR;
4581 case CA_RECEIVE_FAILED:
4582 return OC_STACK_COMM_ERROR;
4583 case CA_MEMORY_ALLOC_FAILED:
4584 return OC_STACK_NO_MEMORY;
4585 case CA_REQUEST_TIMEOUT:
4586 return OC_STACK_TIMEOUT;
4587 case CA_DESTINATION_DISCONNECTED:
4588 return OC_STACK_COMM_ERROR;
4589 case CA_STATUS_FAILED:
4590 return OC_STACK_ERROR;
4591 case CA_NOT_SUPPORTED:
4592 return OC_STACK_NOTIMPL;
4594 return OC_STACK_ERROR;