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
37 #include "ocstackinternal.h"
38 #include "ocresourcehandler.h"
39 #include "occlientcb.h"
40 #include "ocobserve.h"
42 #include "oic_malloc.h"
43 #include "oic_string.h"
45 #include "ocserverrequest.h"
46 #include "secureresourcemanager.h"
47 #include "doxmresource.h"
49 #include "cainterface.h"
50 #include "ocpayload.h"
51 #include "ocpayloadcbor.h"
53 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
54 #include "routingutility.h"
55 #ifdef ROUTING_GATEWAY
56 #include "routingmanager.h"
65 #include "coap_time.h"
70 #include <arpa/inet.h>
74 #define UINT32_MAX (0xFFFFFFFFUL)
77 //-----------------------------------------------------------------------------
79 //-----------------------------------------------------------------------------
82 OC_STACK_UNINITIALIZED = 0,
84 OC_STACK_UNINIT_IN_PROGRESS
90 OC_PRESENCE_UNINITIALIZED = 0,
91 OC_PRESENCE_INITIALIZED
95 //-----------------------------------------------------------------------------
97 //-----------------------------------------------------------------------------
98 static OCStackState stackState = OC_STACK_UNINITIALIZED;
100 OCResource *headResource = NULL;
101 static OCResource *tailResource = NULL;
103 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
104 static PresenceResource presenceResource;
105 static uint8_t PresenceTimeOutSize = 0;
106 static uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
109 static OCMode myStackMode;
111 //TODO: revisit this design
112 static bool gRASetInfo = false;
114 OCDeviceEntityHandler defaultDeviceHandler;
115 void* defaultDeviceHandlerCallbackParameter = NULL;
118 static const char COAP_TCP[] = "coap+tcp:";
121 //-----------------------------------------------------------------------------
123 //-----------------------------------------------------------------------------
124 #define TAG "OCStack"
125 #define VERIFY_SUCCESS(op, successCode) { if ((op) != (successCode)) \
126 {OC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
127 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OC_LOG((logLevel), \
128 TAG, #arg " is NULL"); return (retVal); } }
129 #define VERIFY_NON_NULL_NR(arg, logLevel) { if (!(arg)) { OC_LOG((logLevel), \
130 TAG, #arg " is NULL"); return; } }
131 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OC_LOG_V(FATAL, TAG, "%s is NULL", #arg);\
134 //TODO: we should allow the server to define this
135 #define MAX_OBSERVE_AGE (0x2FFFFUL)
137 #define MILLISECONDS_PER_SECOND (1000)
139 //-----------------------------------------------------------------------------
140 // Private internal function prototypes
141 //-----------------------------------------------------------------------------
144 * Generate handle of OCDoResource invocation for callback management.
146 * @return Generated OCDoResource handle.
148 static OCDoHandle GenerateInvocationHandle();
151 * Initialize resource data structures, variables, etc.
153 * @return ::OC_STACK_OK on success, some other value upon failure.
155 static OCStackResult initResources();
158 * Add a resource to the end of the linked list of resources.
160 * @param resource Resource to be added
162 static void insertResource(OCResource *resource);
165 * Find a resource in the linked list of resources.
167 * @param resource Resource to be found.
168 * @return Pointer to resource that was found in the linked list or NULL if the resource was not
171 static OCResource *findResource(OCResource *resource);
174 * Insert a resource type into a resource's resource type linked list.
175 * If resource type already exists, it will not be inserted and the
176 * resourceType will be free'd.
177 * resourceType->next should be null to avoid memory leaks.
178 * Function returns silently for null args.
180 * @param resource Resource where resource type is to be inserted.
181 * @param resourceType Resource type to be inserted.
183 static void insertResourceType(OCResource *resource,
184 OCResourceType *resourceType);
187 * Get a resource type at the specified index within a resource.
189 * @param handle Handle of resource.
190 * @param index Index of resource type.
192 * @return Pointer to resource type if found, NULL otherwise.
194 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
198 * Insert a resource interface into a resource's resource interface linked list.
199 * If resource interface already exists, it will not be inserted and the
200 * resourceInterface will be free'd.
201 * resourceInterface->next should be null to avoid memory leaks.
203 * @param resource Resource where resource interface is to be inserted.
204 * @param resourceInterface Resource interface to be inserted.
206 static void insertResourceInterface(OCResource *resource,
207 OCResourceInterface *resourceInterface);
210 * Get a resource interface at the specified index within a resource.
212 * @param handle Handle of resource.
213 * @param index Index of resource interface.
215 * @return Pointer to resource interface if found, NULL otherwise.
217 static OCResourceInterface *findResourceInterfaceAtIndex(
218 OCResourceHandle handle, uint8_t index);
221 * Delete all of the dynamically allocated elements that were created for the resource type.
223 * @param resourceType Specified resource type.
225 static void deleteResourceType(OCResourceType *resourceType);
228 * Delete all of the dynamically allocated elements that were created for the resource interface.
230 * @param resourceInterface Specified resource interface.
232 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
235 * Delete all of the dynamically allocated elements that were created for the resource.
237 * @param resource Specified resource.
239 static void deleteResourceElements(OCResource *resource);
242 * Delete resource specified by handle. Deletes resource and all resourcetype and resourceinterface
245 * @param handle Handle of resource to be deleted.
247 * @return ::OC_STACK_OK on success, some other value upon failure.
249 static OCStackResult deleteResource(OCResource *resource);
252 * Delete all of the resources in the resource list.
254 static void deleteAllResources();
257 * Increment resource sequence number. Handles rollover.
259 * @param resPtr Pointer to resource.
261 static void incrementSequenceNumber(OCResource * resPtr);
264 * Verify the lengths of the URI and the query separately.
266 * @param inputUri Input URI and query.
267 * @param uriLen The length of the initial URI with query.
268 * @return ::OC_STACK_OK on success, some other value upon failure.
270 static OCStackResult verifyUriQueryLength(const char * inputUri,
274 * Attempts to initialize every network interface that the CA Layer might have compiled in.
276 * Note: At least one interface must succeed to initialize. If all calls to @ref CASelectNetwork
277 * return something other than @ref CA_STATUS_OK, then this function fails.
279 * @return ::CA_STATUS_OK on success, some other value upon failure.
281 static CAResult_t OCSelectNetwork();
284 * Get the CoAP ticks after the specified number of milli-seconds.
286 * @param afterMilliSeconds Milli-seconds.
290 static uint32_t GetTicks(uint32_t afterMilliSeconds);
293 * Convert CAResponseResult_t to OCStackResult.
295 * @param caCode CAResponseResult_t code.
296 * @return ::OC_STACK_OK on success, some other value upon failure.
298 static OCStackResult CAToOCStackResult(CAResponseResult_t caCode);
301 * Convert OCStackResult to CAResponseResult_t.
303 * @param caCode OCStackResult code.
304 * @param method OCMethod method the return code replies to.
305 * @return ::CA_CONTENT on OK, some other value upon failure.
307 static CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method);
310 * Convert OCTransportFlags_t to CATransportModifiers_t.
312 * @param ocConType OCTransportFlags_t input.
313 * @return CATransportFlags
315 static CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocConType);
318 * Convert CATransportFlags_t to OCTransportModifiers_t.
320 * @param caConType CATransportFlags_t input.
321 * @return OCTransportFlags
323 static OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caConType);
326 * Handle response from presence request.
328 * @param endPoint CA remote endpoint.
329 * @param responseInfo CA response info.
330 * @return ::OC_STACK_OK on success, some other value upon failure.
332 static OCStackResult HandlePresenceResponse(const CAEndpoint_t *endPoint,
333 const CAResponseInfo_t *responseInfo);
336 * This function will be called back by CA layer when a response is received.
338 * @param endPoint CA remote endpoint.
339 * @param responseInfo CA response info.
341 static void HandleCAResponses(const CAEndpoint_t* endPoint,
342 const CAResponseInfo_t* responseInfo);
345 * This function will be called back by CA layer when a request is received.
347 * @param endPoint CA remote endpoint.
348 * @param requestInfo CA request info.
350 static void HandleCARequests(const CAEndpoint_t* endPoint,
351 const CARequestInfo_t* requestInfo);
354 * Extract query from a URI.
356 * @param uri Full URI with query.
357 * @param query Pointer to string that will contain query.
358 * @param newURI Pointer to string that will contain URI.
359 * @return ::OC_STACK_OK on success, some other value upon failure.
361 static OCStackResult getQueryFromUri(const char * uri, char** resourceType, char ** newURI);
364 * Finds a resource type in an OCResourceType link-list.
366 * @param resourceTypeList The link-list to be searched through.
367 * @param resourceTypeName The key to search for.
369 * @return Resource type that matches the key (ie. resourceTypeName) or
370 * NULL if there is either an invalid parameter or this function was unable to find the key.
372 static OCResourceType *findResourceType(OCResourceType * resourceTypeList,
373 const char * resourceTypeName);
376 * Reset presence TTL for a ClientCB struct. ttlLevel will be set to 0.
377 * TTL will be set to maxAge.
379 * @param cbNode Callback Node for which presence ttl is to be reset.
380 * @param maxAge New value of ttl in seconds.
382 * @return ::OC_STACK_OK on success, some other value upon failure.
384 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds);
387 * Ensure the accept header option is set appropriatly before sending the requests and routing
388 * header option is updated with destination.
390 * @param object CA remote endpoint.
391 * @param requestInfo CA request info.
393 * @return ::OC_STACK_OK on success, some other value upon failure.
395 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo);
397 //-----------------------------------------------------------------------------
398 // Internal functions
399 //-----------------------------------------------------------------------------
401 uint32_t GetTicks(uint32_t afterMilliSeconds)
406 // Guard against overflow of uint32_t
407 if (afterMilliSeconds <= ((UINT32_MAX - (uint32_t)now) * MILLISECONDS_PER_SECOND) /
408 COAP_TICKS_PER_SECOND)
410 return now + (afterMilliSeconds * COAP_TICKS_PER_SECOND)/MILLISECONDS_PER_SECOND;
418 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out)
420 VERIFY_NON_NULL_NR(in, FATAL);
421 VERIFY_NON_NULL_NR(out, FATAL);
423 out->adapter = (OCTransportAdapter)in->adapter;
424 out->flags = CAToOCTransportFlags(in->flags);
425 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
426 out->port = in->port;
427 out->interface = in->interface;
428 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
429 memcpy(out->routeData, in->routeData, sizeof(out->routeData));
433 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out)
435 VERIFY_NON_NULL_NR(in, FATAL);
436 VERIFY_NON_NULL_NR(out, FATAL);
438 out->adapter = (CATransportAdapter_t)in->adapter;
439 out->flags = OCToCATransportFlags(in->flags);
440 OICStrcpy(out->addr, sizeof(out->addr), in->addr);
441 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
442 memcpy(out->routeData, in->routeData, sizeof(out->routeData));
444 out->port = in->port;
445 out->interface = in->interface;
448 void FixUpClientResponse(OCClientResponse *cr)
450 VERIFY_NON_NULL_NR(cr, FATAL);
452 cr->addr = &cr->devAddr;
453 cr->connType = (OCConnectivityType)
454 ((cr->devAddr.adapter << CT_ADAPTER_SHIFT) | (cr->devAddr.flags & CT_MASK_FLAGS));
457 static OCStackResult OCSendRequest(const CAEndpoint_t *object, CARequestInfo_t *requestInfo)
459 VERIFY_NON_NULL(object, FATAL, OC_STACK_INVALID_PARAM);
460 VERIFY_NON_NULL(requestInfo, FATAL, OC_STACK_INVALID_PARAM);
462 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
463 OCStackResult rmResult = RMAddInfo(object->routeData, &(requestInfo->info.options),
464 &(requestInfo->info.numOptions));
465 if (OC_STACK_OK != rmResult)
467 OC_LOG(ERROR, TAG, "Add destination option failed");
472 // OC stack prefer CBOR encoded payloads.
473 requestInfo->info.acceptFormat = CA_FORMAT_APPLICATION_CBOR;
474 CAResult_t result = CASendRequest(object, requestInfo);
475 if(CA_STATUS_OK != result)
477 OC_LOG_V(ERROR, TAG, "CASendRequest failed with CA error %u", result);
478 return CAResultToOCResult(result);
482 //-----------------------------------------------------------------------------
483 // Internal API function
484 //-----------------------------------------------------------------------------
486 // This internal function is called to update the stack with the status of
487 // observers and communication failures
488 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status)
490 OCStackResult result = OC_STACK_ERROR;
491 ResourceObserver * observer = NULL;
492 OCEntityHandlerRequest ehRequest = {0};
496 case OC_OBSERVER_NOT_INTERESTED:
497 OC_LOG(DEBUG, TAG, "observer not interested in our notifications");
498 observer = GetObserverUsingToken (token, tokenLength);
501 result = FormOCEntityHandlerRequest(&ehRequest,
502 (OCRequestHandle)NULL,
505 (OCResourceHandle)NULL,
506 NULL, PAYLOAD_TYPE_REPRESENTATION,
508 OC_OBSERVE_DEREGISTER,
509 observer->observeId);
510 if(result != OC_STACK_OK)
514 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
515 observer->resource->entityHandlerCallbackParam);
518 result = DeleteObserverUsingToken (token, tokenLength);
519 if(result == OC_STACK_OK)
521 OC_LOG(DEBUG, TAG, "Removed observer successfully");
525 result = OC_STACK_OK;
526 OC_LOG(DEBUG, TAG, "Observer Removal failed");
530 case OC_OBSERVER_STILL_INTERESTED:
531 OC_LOG(DEBUG, TAG, "observer still interested, reset the failedCount");
532 observer = GetObserverUsingToken (token, tokenLength);
535 observer->forceHighQos = 0;
536 observer->failedCommCount = 0;
537 result = OC_STACK_OK;
541 result = OC_STACK_OBSERVER_NOT_FOUND;
545 case OC_OBSERVER_FAILED_COMM:
546 OC_LOG(DEBUG, TAG, "observer is unreachable");
547 observer = GetObserverUsingToken (token, tokenLength);
550 if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
552 result = FormOCEntityHandlerRequest(&ehRequest,
553 (OCRequestHandle)NULL,
556 (OCResourceHandle)NULL,
557 NULL, PAYLOAD_TYPE_REPRESENTATION,
559 OC_OBSERVE_DEREGISTER,
560 observer->observeId);
561 if(result != OC_STACK_OK)
563 return OC_STACK_ERROR;
565 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
566 observer->resource->entityHandlerCallbackParam);
568 result = DeleteObserverUsingToken (token, tokenLength);
569 if(result == OC_STACK_OK)
571 OC_LOG(DEBUG, TAG, "Removed observer successfully");
575 result = OC_STACK_OK;
576 OC_LOG(DEBUG, TAG, "Observer Removal failed");
581 observer->failedCommCount++;
582 result = OC_STACK_CONTINUE;
584 observer->forceHighQos = 1;
585 OC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",observer->failedCommCount);
589 OC_LOG(ERROR, TAG, "Unknown status");
590 result = OC_STACK_ERROR;
595 OCStackResult CAToOCStackResult(CAResponseResult_t caCode)
597 OCStackResult ret = OC_STACK_ERROR;
602 ret = OC_STACK_RESOURCE_CREATED;
605 ret = OC_STACK_RESOURCE_DELETED;
612 ret = OC_STACK_INVALID_QUERY;
614 case CA_UNAUTHORIZED_REQ:
615 ret = OC_STACK_UNAUTHORIZED_REQ;
618 ret = OC_STACK_INVALID_OPTION;
621 ret = OC_STACK_NO_RESOURCE;
623 case CA_RETRANSMIT_TIMEOUT:
624 ret = OC_STACK_COMM_ERROR;
632 CAResponseResult_t OCToCAStackResult(OCStackResult ocCode, OCMethod method)
634 CAResponseResult_t ret = CA_INTERNAL_SERVER_ERROR;
643 // This Response Code is like HTTP 204 "No Content" but only used in
644 // response to POST and PUT requests.
648 // This Response Code is like HTTP 200 "OK" but only used in response to
653 // This should not happen but,
654 // give it a value just in case but output an error
656 OC_LOG_V(ERROR, TAG, "Unexpected OC_STACK_OK return code for method [d].", method);
659 case OC_STACK_RESOURCE_CREATED:
662 case OC_STACK_RESOURCE_DELETED:
665 case OC_STACK_INVALID_QUERY:
668 case OC_STACK_INVALID_OPTION:
671 case OC_STACK_NO_RESOURCE:
674 case OC_STACK_COMM_ERROR:
675 ret = CA_RETRANSMIT_TIMEOUT;
677 case OC_STACK_UNAUTHORIZED_REQ:
678 ret = CA_UNAUTHORIZED_REQ;
686 CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocFlags)
688 CATransportFlags_t caFlags = (CATransportFlags_t)ocFlags;
690 // supply default behavior.
691 if ((caFlags & (CA_IPV6|CA_IPV4)) == 0)
693 caFlags = (CATransportFlags_t)(caFlags|CA_IPV6|CA_IPV4);
695 if ((caFlags & OC_MASK_SCOPE) == 0)
697 caFlags = (CATransportFlags_t)(caFlags|OC_SCOPE_LINK);
702 OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caFlags)
704 return (OCTransportFlags)caFlags;
707 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds)
709 uint32_t lowerBound = 0;
710 uint32_t higherBound = 0;
712 if (!cbNode || !cbNode->presence || !cbNode->presence->timeOut)
714 return OC_STACK_INVALID_PARAM;
717 OC_LOG_V(INFO, TAG, "Update presence TTL, time is %u", GetTicks(0));
719 cbNode->presence->TTL = maxAgeSeconds;
721 for (int index = 0; index < PresenceTimeOutSize; index++)
723 // Guard against overflow
724 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index]))
727 lowerBound = GetTicks((PresenceTimeOut[index] *
728 cbNode->presence->TTL *
729 MILLISECONDS_PER_SECOND)/100);
733 lowerBound = GetTicks(UINT32_MAX);
736 if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index+1]))
739 higherBound = GetTicks((PresenceTimeOut[index + 1] *
740 cbNode->presence->TTL *
741 MILLISECONDS_PER_SECOND)/100);
745 higherBound = GetTicks(UINT32_MAX);
748 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
750 OC_LOG_V(DEBUG, TAG, "lowerBound timeout %d", lowerBound);
751 OC_LOG_V(DEBUG, TAG, "higherBound timeout %d", higherBound);
752 OC_LOG_V(DEBUG, TAG, "timeOut entry %d", cbNode->presence->timeOut[index]);
755 cbNode->presence->TTLlevel = 0;
757 OC_LOG_V(DEBUG, TAG, "this TTL level %d", cbNode->presence->TTLlevel);
761 const char *convertTriggerEnumToString(OCPresenceTrigger trigger)
763 if (trigger == OC_PRESENCE_TRIGGER_CREATE)
765 return OC_RSRVD_TRIGGER_CREATE;
767 else if (trigger == OC_PRESENCE_TRIGGER_CHANGE)
769 return OC_RSRVD_TRIGGER_CHANGE;
773 return OC_RSRVD_TRIGGER_DELETE;
777 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr)
781 return OC_PRESENCE_TRIGGER_CREATE;
783 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CREATE) == 0)
785 return OC_PRESENCE_TRIGGER_CREATE;
787 else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CHANGE) == 0)
789 return OC_PRESENCE_TRIGGER_CHANGE;
793 return OC_PRESENCE_TRIGGER_DELETE;
798 * The cononical presence allows constructed URIs to be string compared.
800 * requestUri must be a char array of size CA_MAX_URI_LENGTH
802 static int FormCanonicalPresenceUri(const CAEndpoint_t *endpoint, char *resourceUri,
805 VERIFY_NON_NULL(endpoint , FATAL, OC_STACK_INVALID_PARAM);
806 VERIFY_NON_NULL(resourceUri, FATAL, OC_STACK_INVALID_PARAM);
807 VERIFY_NON_NULL(presenceUri, FATAL, OC_STACK_INVALID_PARAM);
809 CAEndpoint_t *ep = (CAEndpoint_t *)endpoint;
811 if (ep->adapter == CA_ADAPTER_IP)
813 if ((ep->flags & CA_IPV6) && !(ep->flags & CA_IPV4))
815 if ('\0' == ep->addr[0]) // multicast
817 return snprintf(presenceUri, CA_MAX_URI_LENGTH, OC_RSRVD_PRESENCE_URI);
821 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://[%s]:%u%s",
822 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
827 if ('\0' == ep->addr[0]) // multicast
829 OICStrcpy(ep->addr, sizeof(ep->addr), OC_MULTICAST_IP);
830 ep->port = OC_MULTICAST_PORT;
832 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s:%u%s",
833 ep->addr, ep->port, OC_RSRVD_PRESENCE_URI);
837 // might work for other adapters (untested, but better than nothing)
838 return snprintf(presenceUri, CA_MAX_URI_LENGTH, "coap://%s%s", ep->addr,
839 OC_RSRVD_PRESENCE_URI);
843 OCStackResult HandlePresenceResponse(const CAEndpoint_t *endpoint,
844 const CAResponseInfo_t *responseInfo)
846 VERIFY_NON_NULL(endpoint, FATAL, OC_STACK_INVALID_PARAM);
847 VERIFY_NON_NULL(responseInfo, FATAL, OC_STACK_INVALID_PARAM);
849 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
850 ClientCB * cbNode = NULL;
851 char *resourceTypeName = NULL;
852 OCClientResponse response = {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
853 OCStackResult result = OC_STACK_ERROR;
856 char presenceUri[CA_MAX_URI_LENGTH];
858 int presenceSubscribe = 0;
859 int multicastPresenceSubscribe = 0;
861 if (responseInfo->result != CA_CONTENT)
863 OC_LOG_V(ERROR, TAG, "HandlePresenceResponse failed %d", responseInfo->result);
864 return OC_STACK_ERROR;
867 // check for unicast presence
868 uriLen = FormCanonicalPresenceUri(endpoint, OC_RSRVD_PRESENCE_URI, presenceUri);
869 if (uriLen < 0 || (size_t)uriLen >= sizeof (presenceUri))
871 return OC_STACK_INVALID_URI;
874 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
877 presenceSubscribe = 1;
881 // check for multiicast presence
882 CAEndpoint_t ep = { .adapter = endpoint->adapter,
883 .flags = endpoint->flags };
885 uriLen = FormCanonicalPresenceUri(&ep, OC_RSRVD_PRESENCE_URI, presenceUri);
887 cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
890 multicastPresenceSubscribe = 1;
894 if (!presenceSubscribe && !multicastPresenceSubscribe)
896 OC_LOG(ERROR, TAG, "Received a presence notification, but no callback, ignoring");
900 response.payload = NULL;
901 response.result = OC_STACK_OK;
903 CopyEndpointToDevAddr(endpoint, &response.devAddr);
904 FixUpClientResponse(&response);
906 if (responseInfo->info.payload)
908 result = OCParsePayload(&response.payload,
909 PAYLOAD_TYPE_PRESENCE,
910 responseInfo->info.payload,
911 responseInfo->info.payloadSize);
913 if(result != OC_STACK_OK)
915 OC_LOG(ERROR, TAG, "Presence parse failed");
918 if(!response.payload || response.payload->type != PAYLOAD_TYPE_PRESENCE)
920 OC_LOG(ERROR, TAG, "Presence payload was wrong type");
921 result = OC_STACK_ERROR;
924 response.sequenceNumber = ((OCPresencePayload*)response.payload)->sequenceNumber;
925 resourceTypeName = ((OCPresencePayload*)response.payload)->resourceType;
926 maxAge = ((OCPresencePayload*)response.payload)->maxAge;
929 if (presenceSubscribe)
931 if(cbNode->sequenceNumber == response.sequenceNumber)
933 OC_LOG(INFO, TAG, "No presence change");
939 OC_LOG(INFO, TAG, "Stopping presence");
940 response.result = OC_STACK_PRESENCE_STOPPED;
943 OICFree(cbNode->presence->timeOut);
944 OICFree(cbNode->presence);
945 cbNode->presence = NULL;
950 if(!cbNode->presence)
952 cbNode->presence = (OCPresence *)OICMalloc(sizeof (OCPresence));
954 if(!(cbNode->presence))
956 OC_LOG(ERROR, TAG, "Could not allocate memory for cbNode->presence");
957 result = OC_STACK_NO_MEMORY;
961 VERIFY_NON_NULL_V(cbNode->presence);
962 cbNode->presence->timeOut = NULL;
963 cbNode->presence->timeOut = (uint32_t *)
964 OICMalloc(PresenceTimeOutSize * sizeof(uint32_t));
965 if(!(cbNode->presence->timeOut)){
967 "Could not allocate memory for cbNode->presence->timeOut");
968 OICFree(cbNode->presence);
969 result = OC_STACK_NO_MEMORY;
974 ResetPresenceTTL(cbNode, maxAge);
976 cbNode->sequenceNumber = response.sequenceNumber;
978 // Ensure that a filter is actually applied.
979 if( resourceTypeName && cbNode->filterResourceType)
981 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
990 // This is the multicast case
991 OCMulticastNode* mcNode = NULL;
992 mcNode = GetMCPresenceNode(presenceUri);
996 if(mcNode->nonce == response.sequenceNumber)
998 OC_LOG(INFO, TAG, "No presence change (Multicast)");
1001 mcNode->nonce = response.sequenceNumber;
1005 OC_LOG(INFO, TAG, "Stopping presence");
1006 response.result = OC_STACK_PRESENCE_STOPPED;
1011 char* uri = OICStrdup(presenceUri);
1015 "No Memory for URI to store in the presence node");
1016 result = OC_STACK_NO_MEMORY;
1020 result = AddMCPresenceNode(&mcNode, uri, response.sequenceNumber);
1021 if(result == OC_STACK_NO_MEMORY)
1024 "No Memory for Multicast Presence Node");
1028 // presence node now owns uri
1031 // Ensure that a filter is actually applied.
1032 if(resourceTypeName && cbNode->filterResourceType)
1034 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1041 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
1043 if (cbResult == OC_STACK_DELETE_TRANSACTION)
1045 FindAndDeleteClientCB(cbNode);
1049 OCPayloadDestroy(response.payload);
1053 void HandleCAResponses(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
1055 VERIFY_NON_NULL_NR(endPoint, FATAL);
1056 VERIFY_NON_NULL_NR(responseInfo, FATAL);
1058 OC_LOG(INFO, TAG, "Enter HandleCAResponses");
1060 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1061 #ifdef ROUTING_GATEWAY
1062 bool needRIHandling = false;
1064 * Routing manager is going to update either of endpoint or response or both.
1065 * This typecasting is done to avoid unnecessary duplication of Endpoint and responseInfo
1066 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1069 OCStackResult ret = RMHandleResponse((CAResponseInfo_t *)responseInfo, (CAEndpoint_t *)endPoint,
1071 if(ret != OC_STACK_OK || !needRIHandling)
1073 OC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1079 * Put source in sender endpoint so that the next packet from application can be routed to
1080 * proper destination and remove "RM" coap header option before passing request / response to
1081 * RI as this option will make no sense to either RI or application.
1083 RMUpdateInfo((CAHeaderOption_t **) &(responseInfo->info.options),
1084 (uint8_t *) &(responseInfo->info.numOptions),
1085 (CAEndpoint_t *) endPoint);
1088 if(responseInfo->info.resourceUri &&
1089 strcmp(responseInfo->info.resourceUri, OC_RSRVD_PRESENCE_URI) == 0)
1091 HandlePresenceResponse(endPoint, responseInfo);
1095 ClientCB *cbNode = GetClientCB(responseInfo->info.token,
1096 responseInfo->info.tokenLength, NULL, NULL);
1098 ResourceObserver * observer = GetObserverUsingToken (responseInfo->info.token,
1099 responseInfo->info.tokenLength);
1103 OC_LOG(INFO, TAG, "There is a cbNode associated with the response token");
1104 if(responseInfo->result == CA_EMPTY)
1106 OC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1107 // We do not have a case for the client to receive a RESET
1108 if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1110 //This is the case of receiving an ACK on a request to a slow resource!
1111 OC_LOG(INFO, TAG, "This is a pure ACK");
1112 //TODO: should we inform the client
1113 // app that at least the request was received at the server?
1116 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1118 OC_LOG(INFO, TAG, "Receiving A Timeout for this token");
1119 OC_LOG(INFO, TAG, "Calling into application address space");
1121 OCClientResponse response =
1122 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1123 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1124 FixUpClientResponse(&response);
1125 response.resourceUri = responseInfo->info.resourceUri;
1126 memcpy(response.identity.id, responseInfo->info.identity.id,
1127 sizeof (response.identity.id));
1128 response.identity.id_length = responseInfo->info.identity.id_length;
1130 response.result = CAToOCStackResult(responseInfo->result);
1131 cbNode->callBack(cbNode->context,
1132 cbNode->handle, &response);
1133 FindAndDeleteClientCB(cbNode);
1137 OC_LOG(INFO, TAG, "This is a regular response, A client call back is found");
1138 OC_LOG(INFO, TAG, "Calling into application address space");
1140 OCClientResponse response =
1141 {.devAddr = {.adapter = OC_DEFAULT_ADAPTER}};
1142 response.sequenceNumber = OC_OBSERVE_NO_OPTION;
1143 CopyEndpointToDevAddr(endPoint, &response.devAddr);
1144 FixUpClientResponse(&response);
1145 response.resourceUri = responseInfo->info.resourceUri;
1146 memcpy(response.identity.id, responseInfo->info.identity.id,
1147 sizeof (response.identity.id));
1148 response.identity.id_length = responseInfo->info.identity.id_length;
1150 response.result = CAToOCStackResult(responseInfo->result);
1152 if(responseInfo->info.payload &&
1153 responseInfo->info.payloadSize)
1155 OCPayloadType type = PAYLOAD_TYPE_INVALID;
1156 // check the security resource
1157 if (SRMIsSecurityResourceURI(cbNode->requestUri))
1159 type = PAYLOAD_TYPE_SECURITY;
1161 else if (cbNode->method == OC_REST_DISCOVER)
1163 if (strncmp(OC_RSRVD_WELL_KNOWN_URI,cbNode->requestUri,
1164 sizeof(OC_RSRVD_WELL_KNOWN_URI) - 1) == 0)
1166 type = PAYLOAD_TYPE_DISCOVERY;
1168 else if (strcmp(cbNode->requestUri, OC_RSRVD_DEVICE_URI) == 0)
1170 type = PAYLOAD_TYPE_DEVICE;
1172 else if (strcmp(cbNode->requestUri, OC_RSRVD_PLATFORM_URI) == 0)
1174 type = PAYLOAD_TYPE_PLATFORM;
1176 #ifdef ROUTING_GATEWAY
1177 else if (strcmp(cbNode->requestUri, OC_RSRVD_GATEWAY_URI) == 0)
1179 type = PAYLOAD_TYPE_REPRESENTATION;
1184 OC_LOG_V(ERROR, TAG, "Unknown Payload type in Discovery: %d %s",
1185 cbNode->method, cbNode->requestUri);
1189 else if (cbNode->method == OC_REST_GET ||
1190 cbNode->method == OC_REST_PUT ||
1191 cbNode->method == OC_REST_POST ||
1192 cbNode->method == OC_REST_OBSERVE ||
1193 cbNode->method == OC_REST_OBSERVE_ALL ||
1194 cbNode->method == OC_REST_DELETE)
1196 OC_LOG_V(INFO, TAG, "Assuming PAYLOAD_TYPE_REPRESENTATION: %d %s",
1197 cbNode->method, cbNode->requestUri);
1198 type = PAYLOAD_TYPE_REPRESENTATION;
1202 OC_LOG_V(ERROR, TAG, "Unknown Payload type: %d %s",
1203 cbNode->method, cbNode->requestUri);
1207 if(OC_STACK_OK != OCParsePayload(&response.payload,
1209 responseInfo->info.payload,
1210 responseInfo->info.payloadSize))
1212 OC_LOG(ERROR, TAG, "Error converting payload");
1213 OCPayloadDestroy(response.payload);
1218 response.numRcvdVendorSpecificHeaderOptions = 0;
1219 if(responseInfo->info.numOptions > 0)
1222 //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
1223 if(responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
1226 uint32_t observationOption;
1227 uint8_t* optionData = (uint8_t*)responseInfo->info.options[0].optionData;
1228 for (observationOption=0, i=0;
1229 i<sizeof(uint32_t) && i<responseInfo->info.options[0].optionLength;
1233 (observationOption << 8) | optionData[i];
1235 response.sequenceNumber = observationOption;
1237 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
1242 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
1245 if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
1247 OC_LOG(ERROR, TAG, "#header options are more than MAX_HEADER_OPTIONS");
1248 OCPayloadDestroy(response.payload);
1252 for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
1254 memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
1255 &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
1259 if (cbNode->method == OC_REST_OBSERVE &&
1260 response.sequenceNumber > OC_OFFSET_SEQUENCE_NUMBER &&
1261 response.sequenceNumber <= cbNode->sequenceNumber)
1263 OC_LOG_V(INFO, TAG, "Received stale notification. Number :%d",
1264 response.sequenceNumber);
1268 OCStackApplicationResult appFeedback = cbNode->callBack(cbNode->context,
1271 cbNode->sequenceNumber = response.sequenceNumber;
1273 if (appFeedback == OC_STACK_DELETE_TRANSACTION)
1275 FindAndDeleteClientCB(cbNode);
1279 // To keep discovery callbacks active.
1280 cbNode->TTL = GetTicks(MAX_CB_TIMEOUT_SECONDS *
1281 MILLISECONDS_PER_SECOND);
1285 //Need to send ACK when the response is CON
1286 if(responseInfo->info.type == CA_MSG_CONFIRM)
1288 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1289 CA_MSG_ACKNOWLEDGE, 0, NULL, NULL, 0, NULL);
1292 OCPayloadDestroy(response.payload);
1299 OC_LOG(INFO, TAG, "There is an observer associated with the response token");
1300 if(responseInfo->result == CA_EMPTY)
1302 OC_LOG(INFO, TAG, "Receiving A ACK/RESET for this token");
1303 if(responseInfo->info.type == CA_MSG_RESET)
1305 OC_LOG(INFO, TAG, "This is a RESET");
1306 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1307 OC_OBSERVER_NOT_INTERESTED);
1309 else if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1311 OC_LOG(INFO, TAG, "This is a pure ACK");
1312 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1313 OC_OBSERVER_STILL_INTERESTED);
1316 else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1318 OC_LOG(INFO, TAG, "Receiving Time Out for an observer");
1319 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1320 OC_OBSERVER_FAILED_COMM);
1325 if(!cbNode && !observer)
1327 if(myStackMode == OC_CLIENT || myStackMode == OC_CLIENT_SERVER
1328 || myStackMode == OC_GATEWAY)
1330 OC_LOG(INFO, TAG, "This is a client, but no cbNode was found for token");
1331 if(responseInfo->result == CA_EMPTY)
1333 OC_LOG(INFO, TAG, "Receiving CA_EMPTY in the ocstack");
1337 OC_LOG(INFO, TAG, "Received a message without callbacks. Sending RESET");
1338 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1339 CA_MSG_RESET, 0, NULL, NULL, 0, NULL);
1343 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER
1344 || myStackMode == OC_GATEWAY)
1346 OC_LOG(INFO, TAG, "This is a server, but no observer was found for token");
1347 if (responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1349 OC_LOG_V(INFO, TAG, "Received ACK at server for messageId : %d",
1350 responseInfo->info.messageId);
1352 if (responseInfo->info.type == CA_MSG_RESET)
1354 OC_LOG_V(INFO, TAG, "Received RESET at server for messageId : %d",
1355 responseInfo->info.messageId);
1362 OC_LOG(INFO, TAG, "Exit HandleCAResponses");
1366 * This function handles error response from CA
1367 * code shall be added to handle the errors
1369 void HandleCAErrorResponse(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errrorInfo)
1371 OC_LOG(INFO, TAG, "Enter HandleCAErrorResponse");
1373 if(NULL == endPoint)
1375 OC_LOG(ERROR, TAG, "endPoint is NULL");
1379 if(NULL == errrorInfo)
1381 OC_LOG(ERROR, TAG, "errrorInfo is NULL");
1384 OC_LOG(INFO, TAG, "Exit HandleCAErrorResponse");
1388 * This function sends out Direct Stack Responses. These are responses that are not coming
1389 * from the application entity handler. These responses have no payload and are usually ACKs,
1390 * RESETs or some error conditions that were caught by the stack.
1392 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
1393 const CAResponseResult_t responseResult, const CAMessageType_t type,
1394 const uint8_t numOptions, const CAHeaderOption_t *options,
1395 CAToken_t token, uint8_t tokenLength, const char *resourceUri)
1397 CAResponseInfo_t respInfo = {
1398 .result = responseResult
1400 respInfo.info.messageId = coapID;
1401 respInfo.info.numOptions = numOptions;
1402 respInfo.info.options = (CAHeaderOption_t*)options;
1403 respInfo.info.payload = NULL;
1404 respInfo.info.token = token;
1405 respInfo.info.tokenLength = tokenLength;
1406 respInfo.info.type = type;
1407 respInfo.info.resourceUri = OICStrdup (resourceUri);
1408 respInfo.info.acceptFormat = CA_FORMAT_UNDEFINED;
1410 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1411 // Add the destination to route option from the endpoint->routeData.
1412 OCStackResult result = RMAddInfo(endPoint->routeData,
1413 &(respInfo.info.options),
1414 &(respInfo.info.numOptions));
1415 if(OC_STACK_OK != result)
1417 OC_LOG_V(ERROR, TAG, "Add routing option failed [%d]", result);
1422 CAResult_t caResult = CASendResponse(endPoint, &respInfo);
1424 // resourceUri in the info field is cloned in the CA layer and
1425 // thus ownership is still here.
1426 OICFree (respInfo.info.resourceUri);
1428 if(CA_STATUS_OK != caResult)
1430 OC_LOG(ERROR, TAG, "CASendResponse error");
1431 return CAResultToOCResult(caResult);
1436 //This function will be called back by CA layer when a request is received
1437 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1439 OC_LOG(INFO, TAG, "Enter HandleCARequests");
1442 OC_LOG(ERROR, TAG, "endPoint is NULL");
1448 OC_LOG(ERROR, TAG, "requestInfo is NULL");
1452 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1453 #ifdef ROUTING_GATEWAY
1454 bool needRIHandling = false;
1456 * Routing manager is going to update either of endpoint or request or both.
1457 * This typecasting is done to avoid unnecessary duplication of Endpoint and requestInfo
1458 * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1459 * destination. It can also remove "RM" coap header option before passing request / response to
1460 * RI as this option will make no sense to either RI or application.
1462 OCStackResult ret = RMHandleRequest((CARequestInfo_t *)requestInfo, (CAEndpoint_t *)endPoint,
1464 if(OC_STACK_OK != ret || !needRIHandling)
1466 OC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1472 * Put source in sender endpoint so that the next packet from application can be routed to
1473 * proper destination and remove RM header option.
1475 RMUpdateInfo((CAHeaderOption_t **) &(requestInfo->info.options),
1476 (uint8_t *) &(requestInfo->info.numOptions),
1477 (CAEndpoint_t *) endPoint);
1480 OCStackResult requestResult = OC_STACK_ERROR;
1482 if(myStackMode == OC_CLIENT)
1484 //TODO: should the client be responding to requests?
1488 OCServerProtocolRequest serverRequest = {0};
1490 OC_LOG_V(INFO, TAG, "Endpoint URI : %s", requestInfo->info.resourceUri);
1492 char * uriWithoutQuery = NULL;
1493 char * query = NULL;
1495 requestResult = getQueryFromUri(requestInfo->info.resourceUri, &query, &uriWithoutQuery);
1497 if (requestResult != OC_STACK_OK || !uriWithoutQuery)
1499 OC_LOG_V(ERROR, TAG, "getQueryFromUri() failed with OC error code %d\n", requestResult);
1502 OC_LOG_V(INFO, TAG, "URI without query: %s", uriWithoutQuery);
1503 OC_LOG_V(INFO, TAG, "Query : %s", query);
1505 if(strlen(uriWithoutQuery) < MAX_URI_LENGTH)
1507 OICStrcpy(serverRequest.resourceUrl, sizeof(serverRequest.resourceUrl), uriWithoutQuery);
1508 OICFree(uriWithoutQuery);
1512 OC_LOG(ERROR, TAG, "URI length exceeds MAX_URI_LENGTH.");
1513 OICFree(uriWithoutQuery);
1520 if(strlen(query) < MAX_QUERY_LENGTH)
1522 OICStrcpy(serverRequest.query, sizeof(serverRequest.query), query);
1527 OC_LOG(ERROR, TAG, "Query length exceeds MAX_QUERY_LENGTH.");
1533 if ((requestInfo->info.payload) && (0 < requestInfo->info.payloadSize))
1535 serverRequest.reqTotalSize = requestInfo->info.payloadSize;
1536 serverRequest.payload = (uint8_t *) OICMalloc(requestInfo->info.payloadSize);
1537 memcpy (serverRequest.payload, requestInfo->info.payload,
1538 requestInfo->info.payloadSize);
1542 serverRequest.reqTotalSize = 0;
1545 switch (requestInfo->method)
1548 serverRequest.method = OC_REST_GET;
1551 serverRequest.method = OC_REST_PUT;
1554 serverRequest.method = OC_REST_POST;
1557 serverRequest.method = OC_REST_DELETE;
1560 OC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1561 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1562 requestInfo->info.type, requestInfo->info.numOptions,
1563 requestInfo->info.options, requestInfo->info.token,
1564 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1565 OICFree(serverRequest.payload);
1569 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1570 requestInfo->info.tokenLength);
1571 serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1572 serverRequest.tokenLength = requestInfo->info.tokenLength;
1574 if (!serverRequest.requestToken)
1576 OC_LOG(FATAL, TAG, "Allocation for token failed.");
1577 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1578 requestInfo->info.type, requestInfo->info.numOptions,
1579 requestInfo->info.options, requestInfo->info.token,
1580 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1581 OICFree(serverRequest.payload);
1584 memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1586 switch (requestInfo->info.acceptFormat)
1588 case CA_FORMAT_APPLICATION_CBOR:
1589 serverRequest.acceptFormat = OC_FORMAT_CBOR;
1591 case CA_FORMAT_UNDEFINED:
1592 serverRequest.acceptFormat = OC_FORMAT_UNDEFINED;
1595 serverRequest.acceptFormat = OC_FORMAT_UNSUPPORTED;
1598 if (requestInfo->info.type == CA_MSG_CONFIRM)
1600 serverRequest.qos = OC_HIGH_QOS;
1604 serverRequest.qos = OC_LOW_QOS;
1606 // CA does not need the following field
1607 // Are we sure CA does not need them? how is it responding to multicast
1608 serverRequest.delayedResNeeded = 0;
1610 serverRequest.coapID = requestInfo->info.messageId;
1612 CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1614 // copy vendor specific header options
1615 uint8_t tempNum = (requestInfo->info.numOptions);
1617 // Assume no observation requested and it is a pure GET.
1618 // If obs registration/de-registration requested it'll be fetched from the
1619 // options in GetObserveHeaderOption()
1620 serverRequest.observationOption = OC_OBSERVE_NO_OPTION;
1622 GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1623 if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1626 "The request info numOptions is greater than MAX_HEADER_OPTIONS");
1627 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1628 requestInfo->info.type, requestInfo->info.numOptions,
1629 requestInfo->info.options, requestInfo->info.token,
1630 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1631 OICFree(serverRequest.payload);
1632 OICFree(serverRequest.requestToken);
1635 serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1636 if (serverRequest.numRcvdVendorSpecificHeaderOptions)
1638 memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1639 sizeof(CAHeaderOption_t)*tempNum);
1642 requestResult = HandleStackRequests (&serverRequest);
1644 // Send ACK to client as precursor to slow response
1645 if(requestResult == OC_STACK_SLOW_RESOURCE)
1647 SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1648 CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0, NULL);
1650 else if(requestResult != OC_STACK_OK)
1652 OC_LOG_V(ERROR, TAG, "HandleStackRequests failed. error: %d", requestResult);
1654 CAResponseResult_t stackResponse =
1655 OCToCAStackResult(requestResult, serverRequest.method);
1657 SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1658 requestInfo->info.type, requestInfo->info.numOptions,
1659 requestInfo->info.options, requestInfo->info.token,
1660 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1662 // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1663 // The token is copied in there, and is thus still owned by this function.
1664 OICFree(serverRequest.payload);
1665 OICFree(serverRequest.requestToken);
1666 OC_LOG(INFO, TAG, "Exit HandleCARequests");
1669 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
1671 OC_LOG(INFO, TAG, "Entering HandleStackRequests (OCStack Layer)");
1672 OCStackResult result = OC_STACK_ERROR;
1673 ResourceHandling resHandling;
1674 OCResource *resource;
1675 if(!protocolRequest)
1677 OC_LOG(ERROR, TAG, "protocolRequest is NULL");
1678 return OC_STACK_INVALID_PARAM;
1681 OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken,
1682 protocolRequest->tokenLength);
1685 OC_LOG(INFO, TAG, "This is a new Server Request");
1686 result = AddServerRequest(&request, protocolRequest->coapID,
1687 protocolRequest->delayedResNeeded, 0, protocolRequest->method,
1688 protocolRequest->numRcvdVendorSpecificHeaderOptions,
1689 protocolRequest->observationOption, protocolRequest->qos,
1690 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
1691 protocolRequest->payload, protocolRequest->requestToken,
1692 protocolRequest->tokenLength, protocolRequest->resourceUrl,
1693 protocolRequest->reqTotalSize, protocolRequest->acceptFormat,
1694 &protocolRequest->devAddr);
1695 if (OC_STACK_OK != result)
1697 OC_LOG(ERROR, TAG, "Error adding server request");
1703 OC_LOG(ERROR, TAG, "Out of Memory");
1704 return OC_STACK_NO_MEMORY;
1707 if(!protocolRequest->reqMorePacket)
1709 request->requestComplete = 1;
1714 OC_LOG(INFO, TAG, "This is either a repeated or blocked Server Request");
1717 if(request->requestComplete)
1719 OC_LOG(INFO, TAG, "This Server Request is complete");
1720 result = DetermineResourceHandling (request, &resHandling, &resource);
1721 if (result == OC_STACK_OK)
1723 result = ProcessRequest(resHandling, resource, request);
1728 OC_LOG(INFO, TAG, "This Server Request is incomplete");
1729 result = OC_STACK_CONTINUE;
1734 bool validatePlatformInfo(OCPlatformInfo info)
1737 if (!info.platformID)
1739 OC_LOG(ERROR, TAG, "No platform ID found.");
1743 if (info.manufacturerName)
1745 size_t lenManufacturerName = strlen(info.manufacturerName);
1747 if(lenManufacturerName == 0 || lenManufacturerName > MAX_MANUFACTURER_NAME_LENGTH)
1749 OC_LOG(ERROR, TAG, "Manufacturer name fails length requirements.");
1755 OC_LOG(ERROR, TAG, "No manufacturer name present");
1759 if (info.manufacturerUrl)
1761 if(strlen(info.manufacturerUrl) > MAX_MANUFACTURER_URL_LENGTH)
1763 OC_LOG(ERROR, TAG, "Manufacturer url fails length requirements.");
1770 //-----------------------------------------------------------------------------
1772 //-----------------------------------------------------------------------------
1774 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
1777 !raInfo->username ||
1778 !raInfo->hostname ||
1779 !raInfo->xmpp_domain)
1782 return OC_STACK_INVALID_PARAM;
1784 OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
1785 gRASetInfo = (result == OC_STACK_OK)? true : false;
1791 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1795 return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
1798 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
1800 if(stackState == OC_STACK_INITIALIZED)
1802 OC_LOG(INFO, TAG, "Subsequent calls to OCInit() without calling \
1803 OCStop() between them are ignored.");
1807 #ifndef ROUTING_GATEWAY
1808 if (OC_GATEWAY == mode)
1810 OC_LOG(ERROR, TAG, "Routing Manager not supported");
1811 return OC_STACK_INVALID_PARAM;
1818 OC_LOG(ERROR, TAG, "Need to call OCSetRAInfo before calling OCInit");
1819 return OC_STACK_ERROR;
1823 OCStackResult result = OC_STACK_ERROR;
1824 OC_LOG(INFO, TAG, "Entering OCInit");
1827 if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)
1828 || (mode == OC_GATEWAY)))
1830 OC_LOG(ERROR, TAG, "Invalid mode");
1831 return OC_STACK_ERROR;
1835 if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1837 caglobals.client = true;
1839 if (mode == OC_SERVER || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1841 caglobals.server = true;
1844 caglobals.serverFlags = (CATransportFlags_t)serverFlags;
1845 if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
1847 caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4|CA_IPV6);
1849 caglobals.clientFlags = (CATransportFlags_t)clientFlags;
1850 if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
1852 caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4|CA_IPV6);
1856 if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
1858 caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4);
1860 if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
1862 caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4);
1866 defaultDeviceHandler = NULL;
1867 defaultDeviceHandlerCallbackParameter = NULL;
1870 result = CAResultToOCResult(CAInitialize());
1871 VERIFY_SUCCESS(result, OC_STACK_OK);
1873 result = CAResultToOCResult(OCSelectNetwork());
1874 VERIFY_SUCCESS(result, OC_STACK_OK);
1876 switch (myStackMode)
1879 CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
1880 result = CAResultToOCResult(CAStartDiscoveryServer());
1881 OC_LOG(INFO, TAG, "Client mode: CAStartDiscoveryServer");
1884 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
1885 result = CAResultToOCResult(CAStartListeningServer());
1886 OC_LOG(INFO, TAG, "Server mode: CAStartListeningServer");
1888 case OC_CLIENT_SERVER:
1890 SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
1891 result = CAResultToOCResult(CAStartListeningServer());
1892 if(result == OC_STACK_OK)
1894 result = CAResultToOCResult(CAStartDiscoveryServer());
1898 VERIFY_SUCCESS(result, OC_STACK_OK);
1900 #ifdef WITH_PRESENCE
1901 PresenceTimeOutSize = sizeof (PresenceTimeOut) / sizeof (PresenceTimeOut[0]) - 1;
1902 #endif // WITH_PRESENCE
1904 //Update Stack state to initialized
1905 stackState = OC_STACK_INITIALIZED;
1907 // Initialize resource
1908 if(myStackMode != OC_CLIENT)
1910 result = initResources();
1913 // Initialize the SRM Policy Engine
1914 if(result == OC_STACK_OK)
1916 result = SRMInitPolicyEngine();
1917 // TODO after BeachHead delivery: consolidate into single SRMInit()
1920 #ifdef ROUTING_GATEWAY
1921 if (OC_GATEWAY == myStackMode)
1923 result = RMInitialize();
1928 if(result != OC_STACK_OK)
1930 OC_LOG(ERROR, TAG, "Stack initialization error");
1931 deleteAllResources();
1933 stackState = OC_STACK_UNINITIALIZED;
1938 OCStackResult OCStop()
1940 OC_LOG(INFO, TAG, "Entering OCStop");
1942 if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
1944 OC_LOG(DEBUG, TAG, "Stack already stopping, exiting");
1947 else if (stackState != OC_STACK_INITIALIZED)
1949 OC_LOG(ERROR, TAG, "Stack not initialized");
1950 return OC_STACK_ERROR;
1953 stackState = OC_STACK_UNINIT_IN_PROGRESS;
1955 #ifdef WITH_PRESENCE
1956 // Ensure that the TTL associated with ANY and ALL presence notifications originating from
1957 // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
1958 presenceResource.presenceTTL = 0;
1959 #endif // WITH_PRESENCE
1961 #ifdef ROUTING_GATEWAY
1962 if (OC_GATEWAY == myStackMode)
1968 // Free memory dynamically allocated for resources
1969 deleteAllResources();
1971 DeletePlatformInfo();
1973 // Remove all observers
1974 DeleteObserverList();
1975 // Remove all the client callbacks
1976 DeleteClientCBList();
1978 // De-init the SRM Policy Engine
1979 // TODO after BeachHead delivery: consolidate into single SRMDeInit()
1980 SRMDeInitPolicyEngine();
1983 stackState = OC_STACK_UNINITIALIZED;
1987 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
1992 return CA_MSG_CONFIRM;
1997 return CA_MSG_NONCONFIRM;
2001 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
2005 query = strchr (inputUri, '?');
2009 if((query - inputUri) > MAX_URI_LENGTH)
2011 return OC_STACK_INVALID_URI;
2014 if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
2016 return OC_STACK_INVALID_QUERY;
2019 else if(uriLen > MAX_URI_LENGTH)
2021 return OC_STACK_INVALID_URI;
2027 * A request uri consists of the following components in order:
2030 * CoAP over UDP prefix "coap://"
2031 * CoAP over TCP prefix "coap+tcp://"
2033 * IPv6 address "[1234::5678]"
2034 * IPv4 address "192.168.1.1"
2035 * optional port ":5683"
2036 * resource uri "/oc/core..."
2038 * for PRESENCE requests, extract resource type.
2040 static OCStackResult ParseRequestUri(const char *fullUri,
2041 OCTransportAdapter adapter,
2042 OCTransportFlags flags,
2043 OCDevAddr **devAddr,
2045 char **resourceType)
2047 VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
2049 OCStackResult result = OC_STACK_OK;
2050 OCDevAddr *da = NULL;
2054 // provide defaults for all returned values
2061 *resourceUri = NULL;
2065 *resourceType = NULL;
2068 // delimit url prefix, if any
2069 const char *start = fullUri;
2070 char *slash2 = strstr(start, "//");
2075 char *slash = strchr(start, '/');
2078 return OC_STACK_INVALID_URI;
2082 // process url scheme
2083 size_t prefixLen = slash2 - fullUri;
2087 if ((prefixLen == sizeof(COAP_TCP) - 1) && (!strncmp(fullUri, COAP_TCP, prefixLen)))
2094 // TODO: this logic should come in with unit tests exercising the various strings
2095 // processs url prefix, if any
2096 size_t urlLen = slash - start;
2100 if (urlLen && devAddr)
2101 { // construct OCDevAddr
2102 if (start[0] == '[')
2104 char *close = strchr(++start, ']');
2105 if (!close || close > slash)
2107 return OC_STACK_INVALID_URI;
2110 if (close[1] == ':')
2114 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2115 flags = (OCTransportFlags)(flags | OC_IP_USE_V6);
2119 char *dot = strchr(start, '.');
2120 if (dot && dot < slash)
2122 colon = strchr(start, ':');
2123 end = (colon && colon < slash) ? colon : slash;
2127 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2132 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2133 flags = (OCTransportFlags)(flags | OC_IP_USE_V4);
2142 if (len >= sizeof(da->addr))
2144 return OC_STACK_INVALID_URI;
2146 // collect port, if any
2147 if (colon && colon < slash)
2149 for (colon++; colon < slash; colon++)
2152 if (c < '0' || c > '9')
2154 return OC_STACK_INVALID_URI;
2156 port = 10 * port + c - '0';
2161 if (len >= sizeof(da->addr))
2163 return OC_STACK_INVALID_URI;
2166 da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
2169 return OC_STACK_NO_MEMORY;
2171 OICStrcpyPartial(da->addr, sizeof(da->addr), start, len);
2173 da->adapter = adapter;
2175 if (!strncmp(fullUri, "coaps:", 6))
2177 da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
2182 // process resource uri, if any
2184 { // request uri and query
2185 size_t ulen = strlen(slash); // resource uri length
2186 size_t tlen = 0; // resource type length
2189 static const char strPresence[] = "/oic/ad?rt=";
2190 static const size_t lenPresence = sizeof(strPresence) - 1;
2191 if (!strncmp(slash, strPresence, lenPresence))
2193 type = slash + lenPresence;
2194 tlen = ulen - lenPresence;
2199 *resourceUri = (char *)OICMalloc(ulen + 1);
2202 result = OC_STACK_NO_MEMORY;
2205 strcpy(*resourceUri, slash);
2208 if (type && resourceType)
2210 *resourceType = (char *)OICMalloc(tlen + 1);
2213 result = OC_STACK_NO_MEMORY;
2217 OICStrcpy(*resourceType, (tlen+1), type);
2224 // free all returned values
2231 OICFree(*resourceUri);
2235 OICFree(*resourceType);
2240 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
2241 char *resourceUri, char **requestUri)
2243 char uri[CA_MAX_URI_LENGTH];
2245 FormCanonicalPresenceUri(endpoint, resourceUri, uri);
2247 *requestUri = OICStrdup(uri);
2250 return OC_STACK_NO_MEMORY;
2257 * Discover or Perform requests on a specified resource
2259 OCStackResult OCDoResource(OCDoHandle *handle,
2261 const char *requestUri,
2262 const OCDevAddr *destination,
2264 OCConnectivityType connectivityType,
2265 OCQualityOfService qos,
2266 OCCallbackData *cbData,
2267 OCHeaderOption *options,
2270 OC_LOG(INFO, TAG, "Entering OCDoResource");
2272 // Validate input parameters
2273 VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
2274 VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
2275 VERIFY_NON_NULL(requestUri , FATAL, OC_STACK_INVALID_URI);
2277 OCStackResult result = OC_STACK_ERROR;
2278 CAResult_t caResult;
2279 CAToken_t token = NULL;
2280 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2281 ClientCB *clientCB = NULL;
2282 OCDoHandle resHandle = NULL;
2283 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2284 OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
2286 OCTransportAdapter adapter;
2287 OCTransportFlags flags;
2288 // the request contents are put here
2289 CARequestInfo_t requestInfo = {.method = CA_GET};
2290 // requestUri will be parsed into the following three variables
2291 OCDevAddr *devAddr = NULL;
2292 char *resourceUri = NULL;
2293 char *resourceType = NULL;
2295 // To track if memory is allocated for additional header options
2296 uint8_t hdrOptionMemAlloc = 0;
2298 // This validation is broken, but doesn't cause harm
2299 size_t uriLen = strlen(requestUri );
2300 if ((result = verifyUriQueryLength(requestUri , uriLen)) != OC_STACK_OK)
2306 * Support original behavior with address on resourceUri argument.
2308 adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2309 flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2311 result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2313 if (result != OC_STACK_OK)
2315 OC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2322 case OC_REST_OBSERVE:
2323 case OC_REST_OBSERVE_ALL:
2324 case OC_REST_CANCEL_OBSERVE:
2325 requestInfo.method = CA_GET;
2328 requestInfo.method = CA_PUT;
2331 requestInfo.method = CA_POST;
2333 case OC_REST_DELETE:
2334 requestInfo.method = CA_DELETE;
2336 case OC_REST_DISCOVER:
2338 if (destination || devAddr)
2340 requestInfo.isMulticast = false;
2344 tmpDevAddr.adapter = adapter;
2345 tmpDevAddr.flags = flags;
2346 destination = &tmpDevAddr;
2347 requestInfo.isMulticast = true;
2349 // CA_DISCOVER will become GET and isMulticast
2350 requestInfo.method = CA_GET;
2352 #ifdef WITH_PRESENCE
2353 case OC_REST_PRESENCE:
2354 // Replacing method type with GET because "presence"
2355 // is a stack layer only implementation.
2356 requestInfo.method = CA_GET;
2360 result = OC_STACK_INVALID_METHOD;
2364 if (!devAddr && !destination)
2366 OC_LOG(DEBUG, TAG, "no devAddr and no destination");
2367 result = OC_STACK_INVALID_PARAM;
2371 /* If not original behavior, use destination argument */
2372 if (destination && !devAddr)
2374 devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2377 result = OC_STACK_NO_MEMORY;
2380 *devAddr = *destination;
2383 resHandle = GenerateInvocationHandle();
2386 result = OC_STACK_NO_MEMORY;
2390 caResult = CAGenerateToken(&token, tokenLength);
2391 if (caResult != CA_STATUS_OK)
2393 OC_LOG(ERROR, TAG, "CAGenerateToken error");
2394 result= OC_STACK_ERROR;
2398 // fill in request data
2399 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2400 requestInfo.info.token = token;
2401 requestInfo.info.tokenLength = tokenLength;
2402 requestInfo.info.resourceUri = resourceUri;
2404 if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2406 result = CreateObserveHeaderOption (&(requestInfo.info.options),
2407 options, numOptions, OC_OBSERVE_REGISTER);
2408 if (result != OC_STACK_OK)
2412 hdrOptionMemAlloc = 1;
2413 requestInfo.info.numOptions = numOptions + 1;
2417 requestInfo.info.options = (CAHeaderOption_t*)options;
2418 requestInfo.info.numOptions = numOptions;
2421 CopyDevAddrToEndpoint(devAddr, &endpoint);
2426 OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2429 OC_LOG(ERROR, TAG, "Failed to create CBOR Payload");
2432 requestInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
2436 requestInfo.info.payload = NULL;
2437 requestInfo.info.payloadSize = 0;
2438 requestInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
2441 if (result != OC_STACK_OK)
2443 OC_LOG(ERROR, TAG, "CACreateEndpoint error");
2447 // prepare for response
2448 #ifdef WITH_PRESENCE
2449 if (method == OC_REST_PRESENCE)
2451 char *presenceUri = NULL;
2452 result = OCPreparePresence(&endpoint, resourceUri, &presenceUri);
2453 if (OC_STACK_OK != result)
2458 // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2459 // Presence notification will form a canonical uri to
2460 // look for callbacks into the application.
2461 resourceUri = presenceUri;
2465 ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2466 result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2467 method, devAddr, resourceUri, resourceType, ttl);
2468 if (OC_STACK_OK != result)
2473 devAddr = NULL; // Client CB list entry now owns it
2474 resourceUri = NULL; // Client CB list entry now owns it
2475 resourceType = NULL; // Client CB list entry now owns it
2478 result = OCSendRequest(&endpoint, &requestInfo);
2479 if (OC_STACK_OK != result)
2486 *handle = resHandle;
2490 if (result != OC_STACK_OK)
2492 OC_LOG(ERROR, TAG, "OCDoResource error");
2493 FindAndDeleteClientCB(clientCB);
2494 CADestroyToken(token);
2502 // This is the owner of the payload object, so we free it
2503 OCPayloadDestroy(payload);
2504 OICFree(requestInfo.info.payload);
2506 OICFree(resourceUri);
2507 OICFree(resourceType);
2508 if (hdrOptionMemAlloc)
2510 OICFree(requestInfo.info.options);
2515 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2519 * This ftn is implemented one of two ways in the case of observation:
2521 * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2522 * Remove the callback associated on client side.
2523 * When the next notification comes in from server,
2524 * reply with RESET message to server.
2525 * Keep in mind that the server will react to RESET only
2526 * if the last notification was sent as CON
2528 * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2529 * and it is associated with an observe request
2530 * (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2531 * Send CON Observe request to server with
2532 * observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2533 * Remove the callback associated on client side.
2535 OCStackResult ret = OC_STACK_OK;
2536 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2537 CARequestInfo_t requestInfo = {.method = CA_GET};
2541 return OC_STACK_INVALID_PARAM;
2544 ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2547 OC_LOG(ERROR, TAG, "Callback not found. Called OCCancel on same resource twice?");
2548 return OC_STACK_ERROR;
2551 switch (clientCB->method)
2553 case OC_REST_OBSERVE:
2554 case OC_REST_OBSERVE_ALL:
2556 OC_LOG_V(INFO, TAG, "Canceling observation for resource %s",
2557 clientCB->requestUri);
2558 if (qos != OC_HIGH_QOS)
2560 FindAndDeleteClientCB(clientCB);
2564 OC_LOG(INFO, TAG, "Cancelling observation as CONFIRMABLE");
2566 requestInfo.info.type = qualityOfServiceToMessageType(qos);
2567 requestInfo.info.token = clientCB->token;
2568 requestInfo.info.tokenLength = clientCB->tokenLength;
2570 if (CreateObserveHeaderOption (&(requestInfo.info.options),
2571 options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2573 return OC_STACK_ERROR;
2575 requestInfo.info.numOptions = numOptions + 1;
2576 requestInfo.info.resourceUri = OICStrdup (clientCB->requestUri);
2578 CopyDevAddrToEndpoint(clientCB->devAddr, &endpoint);
2580 ret = OCSendRequest(&endpoint, &requestInfo);
2582 if (requestInfo.info.options)
2584 OICFree (requestInfo.info.options);
2586 if (requestInfo.info.resourceUri)
2588 OICFree (requestInfo.info.resourceUri);
2593 #ifdef WITH_PRESENCE
2594 case OC_REST_PRESENCE:
2595 FindAndDeleteClientCB(clientCB);
2600 ret = OC_STACK_INVALID_METHOD;
2608 * @brief Register Persistent storage callback.
2609 * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2611 * OC_STACK_OK - No errors; Success
2612 * OC_STACK_INVALID_PARAM - Invalid parameter
2614 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2616 OC_LOG(INFO, TAG, "RegisterPersistentStorageHandler !!");
2617 if(!persistentStorageHandler)
2619 OC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2620 return OC_STACK_INVALID_PARAM;
2624 if( !persistentStorageHandler->open ||
2625 !persistentStorageHandler->close ||
2626 !persistentStorageHandler->read ||
2627 !persistentStorageHandler->unlink ||
2628 !persistentStorageHandler->write)
2630 OC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2631 return OC_STACK_INVALID_PARAM;
2634 return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2637 #ifdef WITH_PRESENCE
2639 OCStackResult OCProcessPresence()
2641 OCStackResult result = OC_STACK_OK;
2643 // the following line floods the log with messages that are irrelevant
2644 // to most purposes. Uncomment as needed.
2645 //OC_LOG(INFO, TAG, "Entering RequestPresence");
2646 ClientCB* cbNode = NULL;
2647 OCClientResponse clientResponse;
2648 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2650 LL_FOREACH(cbList, cbNode)
2652 if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
2657 uint32_t now = GetTicks(0);
2658 OC_LOG_V(DEBUG, TAG, "this TTL level %d",
2659 cbNode->presence->TTLlevel);
2660 OC_LOG_V(DEBUG, TAG, "current ticks %d", now);
2662 if (cbNode->presence->TTLlevel > PresenceTimeOutSize)
2667 if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
2669 OC_LOG_V(DEBUG, TAG, "timeout ticks %d",
2670 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2672 if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2674 OC_LOG(DEBUG, TAG, "No more timeout ticks");
2676 clientResponse.sequenceNumber = 0;
2677 clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
2678 clientResponse.devAddr = *cbNode->devAddr;
2679 FixUpClientResponse(&clientResponse);
2680 clientResponse.payload = NULL;
2682 // Increment the TTLLevel (going to a next state), so we don't keep
2683 // sending presence notification to client.
2684 cbNode->presence->TTLlevel++;
2685 OC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
2686 cbNode->presence->TTLlevel);
2688 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
2689 if (cbResult == OC_STACK_DELETE_TRANSACTION)
2691 FindAndDeleteClientCB(cbNode);
2695 if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2700 CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2701 CAInfo_t requestData = {.type = CA_MSG_CONFIRM};
2702 CARequestInfo_t requestInfo = {.method = CA_GET};
2704 OC_LOG(DEBUG, TAG, "time to test server presence");
2706 CopyDevAddrToEndpoint(cbNode->devAddr, &endpoint);
2708 requestData.type = CA_MSG_NONCONFIRM;
2709 requestData.token = cbNode->token;
2710 requestData.tokenLength = cbNode->tokenLength;
2711 requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
2712 requestInfo.method = CA_GET;
2713 requestInfo.info = requestData;
2715 result = OCSendRequest(&endpoint, &requestInfo);
2716 if (OC_STACK_OK != result)
2721 cbNode->presence->TTLlevel++;
2722 OC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
2725 if (result != OC_STACK_OK)
2727 OC_LOG(ERROR, TAG, "OCProcessPresence error");
2732 #endif // WITH_PRESENCE
2734 OCStackResult OCProcess()
2736 #ifdef WITH_PRESENCE
2737 OCProcessPresence();
2739 CAHandleRequestResponse();
2741 #ifdef ROUTING_GATEWAY
2747 #ifdef WITH_PRESENCE
2748 OCStackResult OCStartPresence(const uint32_t ttl)
2750 uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2751 OCChangeResourceProperty(
2752 &(((OCResource *)presenceResource.handle)->resourceProperties),
2755 if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
2757 presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
2758 OC_LOG(INFO, TAG, "Setting Presence TTL to max value");
2762 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
2763 OC_LOG(INFO, TAG, "Setting Presence TTL to default value");
2767 presenceResource.presenceTTL = ttl;
2769 OC_LOG_V(DEBUG, TAG, "Presence TTL is %lu seconds", presenceResource.presenceTTL);
2771 if (OC_PRESENCE_UNINITIALIZED == presenceState)
2773 presenceState = OC_PRESENCE_INITIALIZED;
2775 OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
2777 CAToken_t caToken = NULL;
2778 CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
2779 if (caResult != CA_STATUS_OK)
2781 OC_LOG(ERROR, TAG, "CAGenerateToken error");
2782 CADestroyToken(caToken);
2783 return OC_STACK_ERROR;
2786 AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
2787 (OCResource *)presenceResource.handle, OC_LOW_QOS, OC_FORMAT_UNDEFINED, &devAddr);
2788 CADestroyToken(caToken);
2791 // Each time OCStartPresence is called
2792 // a different random 32-bit integer number is used
2793 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2795 return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
2796 OC_PRESENCE_TRIGGER_CREATE);
2799 OCStackResult OCStopPresence()
2801 OCStackResult result = OC_STACK_ERROR;
2803 if(presenceResource.handle)
2805 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2807 // make resource inactive
2808 result = OCChangeResourceProperty(
2809 &(((OCResource *) presenceResource.handle)->resourceProperties),
2813 if(result != OC_STACK_OK)
2816 "Changing the presence resource properties to ACTIVE not successful");
2820 return SendStopNotification();
2824 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
2825 void* callbackParameter)
2827 defaultDeviceHandler = entityHandler;
2828 defaultDeviceHandlerCallbackParameter = callbackParameter;
2833 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo)
2835 OC_LOG(INFO, TAG, "Entering OCSetPlatformInfo");
2837 if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER || myStackMode == OC_GATEWAY)
2839 if (validatePlatformInfo(platformInfo))
2841 return SavePlatformInfo(platformInfo);
2845 return OC_STACK_INVALID_PARAM;
2850 return OC_STACK_ERROR;
2854 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
2856 OC_LOG(INFO, TAG, "Entering OCSetDeviceInfo");
2858 if (!deviceInfo.deviceName || deviceInfo.deviceName[0] == '\0')
2860 OC_LOG(ERROR, TAG, "Null or empty device name.");
2861 return OC_STACK_INVALID_PARAM;
2864 return SaveDeviceInfo(deviceInfo);
2867 OCStackResult OCCreateResource(OCResourceHandle *handle,
2868 const char *resourceTypeName,
2869 const char *resourceInterfaceName,
2870 const char *uri, OCEntityHandler entityHandler,
2871 void* callbackParam,
2872 uint8_t resourceProperties)
2875 OCResource *pointer = NULL;
2876 OCStackResult result = OC_STACK_ERROR;
2878 OC_LOG(INFO, TAG, "Entering OCCreateResource");
2880 if(myStackMode == OC_CLIENT)
2882 return OC_STACK_INVALID_PARAM;
2884 // Validate parameters
2885 if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
2887 OC_LOG(ERROR, TAG, "URI is empty or too long");
2888 return OC_STACK_INVALID_URI;
2890 // Is it presented during resource discovery?
2891 if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
2893 OC_LOG(ERROR, TAG, "Input parameter is NULL");
2894 return OC_STACK_INVALID_PARAM;
2897 if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
2899 resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
2902 // Make sure resourceProperties bitmask has allowed properties specified
2903 if (resourceProperties
2904 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
2905 OC_EXPLICIT_DISCOVERABLE))
2907 OC_LOG(ERROR, TAG, "Invalid property");
2908 return OC_STACK_INVALID_PARAM;
2911 // If the headResource is NULL, then no resources have been created...
2912 pointer = headResource;
2915 // At least one resources is in the resource list, so we need to search for
2916 // repeated URLs, which are not allowed. If a repeat is found, exit with an error
2919 if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
2921 OC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
2922 return OC_STACK_INVALID_PARAM;
2924 pointer = pointer->next;
2927 // Create the pointer and insert it into the resource list
2928 pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
2931 result = OC_STACK_NO_MEMORY;
2934 pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
2936 insertResource(pointer);
2939 pointer->uri = OICStrdup(uri);
2942 result = OC_STACK_NO_MEMORY;
2946 // Set properties. Set OC_ACTIVE
2947 pointer->resourceProperties = (OCResourceProperty) (resourceProperties
2950 // Add the resourcetype to the resource
2951 result = BindResourceTypeToResource(pointer, resourceTypeName);
2952 if (result != OC_STACK_OK)
2954 OC_LOG(ERROR, TAG, "Error adding resourcetype");
2958 // Add the resourceinterface to the resource
2959 result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
2960 if (result != OC_STACK_OK)
2962 OC_LOG(ERROR, TAG, "Error adding resourceinterface");
2966 // If an entity handler has been passed, attach it to the newly created
2967 // resource. Otherwise, set the default entity handler.
2970 pointer->entityHandler = entityHandler;
2971 pointer->entityHandlerCallbackParam = callbackParam;
2975 pointer->entityHandler = defaultResourceEHandler;
2976 pointer->entityHandlerCallbackParam = NULL;
2980 result = OC_STACK_OK;
2982 #ifdef WITH_PRESENCE
2983 if (presenceResource.handle)
2985 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2986 SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
2990 if (result != OC_STACK_OK)
2992 // Deep delete of resource and other dynamic elements that it contains
2993 deleteResource(pointer);
2999 OCStackResult OCBindResource(
3000 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3002 OCResource *resource = NULL;
3005 OC_LOG(INFO, TAG, "Entering OCBindResource");
3007 // Validate parameters
3008 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3009 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3010 // Container cannot contain itself
3011 if (collectionHandle == resourceHandle)
3013 OC_LOG(ERROR, TAG, "Added handle equals collection handle");
3014 return OC_STACK_INVALID_PARAM;
3017 // Use the handle to find the resource in the resource linked list
3018 resource = findResource((OCResource *) collectionHandle);
3021 OC_LOG(ERROR, TAG, "Collection handle not found");
3022 return OC_STACK_INVALID_PARAM;
3025 // Look for an open slot to add add the child resource.
3026 // If found, add it and return success
3027 for (i = 0; i < MAX_CONTAINED_RESOURCES; i++)
3029 if (!resource->rsrcResources[i])
3031 resource->rsrcResources[i] = (OCResource *) resourceHandle;
3032 OC_LOG(INFO, TAG, "resource bound");
3034 #ifdef WITH_PRESENCE
3035 if (presenceResource.handle)
3037 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3038 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3039 OC_PRESENCE_TRIGGER_CHANGE);
3047 // Unable to add resourceHandle, so return error
3048 return OC_STACK_ERROR;
3051 OCStackResult OCUnBindResource(
3052 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3054 OCResource *resource = NULL;
3057 OC_LOG(INFO, TAG, "Entering OCUnBindResource");
3059 // Validate parameters
3060 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3061 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3062 // Container cannot contain itself
3063 if (collectionHandle == resourceHandle)
3065 OC_LOG(ERROR, TAG, "removing handle equals collection handle");
3066 return OC_STACK_INVALID_PARAM;
3069 // Use the handle to find the resource in the resource linked list
3070 resource = findResource((OCResource *) collectionHandle);
3073 OC_LOG(ERROR, TAG, "Collection handle not found");
3074 return OC_STACK_INVALID_PARAM;
3077 // Look for an open slot to add add the child resource.
3078 // If found, add it and return success
3079 for (i = 0; i < MAX_CONTAINED_RESOURCES; i++)
3081 if (resourceHandle == resource->rsrcResources[i])
3083 resource->rsrcResources[i] = (OCResource *) NULL;
3084 OC_LOG(INFO, TAG, "resource unbound");
3086 // Send notification when resource is unbounded successfully.
3087 #ifdef WITH_PRESENCE
3088 if (presenceResource.handle)
3090 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3091 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3092 OC_PRESENCE_TRIGGER_CHANGE);
3099 OC_LOG(INFO, TAG, "resource not found in collection");
3101 // Unable to add resourceHandle, so return error
3102 return OC_STACK_ERROR;
3105 // Precondition is that the parameter has been checked to not equal NULL.
3106 static bool ValidateResourceTypeInterface(const char *resourceItemName)
3108 if (resourceItemName[0] < 'a' || resourceItemName[0] > 'z')
3114 while (resourceItemName[index] != '\0')
3116 if (resourceItemName[index] != '.' &&
3117 resourceItemName[index] != '-' &&
3118 (resourceItemName[index] < 'a' || resourceItemName[index] > 'z') &&
3119 (resourceItemName[index] < '0' || resourceItemName[index] > '9'))
3128 OCStackResult BindResourceTypeToResource(OCResource* resource,
3129 const char *resourceTypeName)
3131 OCResourceType *pointer = NULL;
3133 OCStackResult result = OC_STACK_ERROR;
3135 VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
3137 if (!ValidateResourceTypeInterface(resourceTypeName))
3139 OC_LOG(ERROR, TAG, "resource type illegal (see RFC 6690)");
3140 return OC_STACK_INVALID_PARAM;
3143 pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
3146 result = OC_STACK_NO_MEMORY;
3150 str = OICStrdup(resourceTypeName);
3153 result = OC_STACK_NO_MEMORY;
3156 pointer->resourcetypename = str;
3158 insertResourceType(resource, pointer);
3159 result = OC_STACK_OK;
3162 if (result != OC_STACK_OK)
3171 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
3172 const char *resourceInterfaceName)
3174 OCResourceInterface *pointer = NULL;
3176 OCStackResult result = OC_STACK_ERROR;
3178 VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
3180 if (!ValidateResourceTypeInterface(resourceInterfaceName))
3182 OC_LOG(ERROR, TAG, "resource /interface illegal (see RFC 6690)");
3183 return OC_STACK_INVALID_PARAM;
3186 OC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
3188 pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
3191 result = OC_STACK_NO_MEMORY;
3195 str = OICStrdup(resourceInterfaceName);
3198 result = OC_STACK_NO_MEMORY;
3201 pointer->name = str;
3203 // Bind the resourceinterface to the resource
3204 insertResourceInterface(resource, pointer);
3206 result = OC_STACK_OK;
3209 if (result != OC_STACK_OK)
3218 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
3219 const char *resourceTypeName)
3222 OCStackResult result = OC_STACK_ERROR;
3223 OCResource *resource = NULL;
3225 resource = findResource((OCResource *) handle);
3228 OC_LOG(ERROR, TAG, "Resource not found");
3229 return OC_STACK_ERROR;
3232 result = BindResourceTypeToResource(resource, resourceTypeName);
3234 #ifdef WITH_PRESENCE
3235 if(presenceResource.handle)
3237 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3238 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3245 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
3246 const char *resourceInterfaceName)
3249 OCStackResult result = OC_STACK_ERROR;
3250 OCResource *resource = NULL;
3252 resource = findResource((OCResource *) handle);
3255 OC_LOG(ERROR, TAG, "Resource not found");
3256 return OC_STACK_ERROR;
3259 result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
3261 #ifdef WITH_PRESENCE
3262 if (presenceResource.handle)
3264 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3265 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3272 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
3274 OCResource *pointer = headResource;
3276 VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
3280 *numResources = *numResources + 1;
3281 pointer = pointer->next;
3286 OCResourceHandle OCGetResourceHandle(uint8_t index)
3288 OCResource *pointer = headResource;
3290 for( uint8_t i = 0; i < index && pointer; ++i)
3292 pointer = pointer->next;
3294 return (OCResourceHandle) pointer;
3297 OCStackResult OCDeleteResource(OCResourceHandle handle)
3301 OC_LOG(ERROR, TAG, "Invalid handle for deletion");
3302 return OC_STACK_INVALID_PARAM;
3305 OCResource *resource = findResource((OCResource *) handle);
3306 if (resource == NULL)
3308 OC_LOG(ERROR, TAG, "Resource not found");
3309 return OC_STACK_NO_RESOURCE;
3312 if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3314 OC_LOG(ERROR, TAG, "Error deleting resource");
3315 return OC_STACK_ERROR;
3321 const char *OCGetResourceUri(OCResourceHandle handle)
3323 OCResource *resource = NULL;
3325 resource = findResource((OCResource *) handle);
3328 return resource->uri;
3330 return (const char *) NULL;
3333 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3335 OCResource *resource = NULL;
3337 resource = findResource((OCResource *) handle);
3340 return resource->resourceProperties;
3342 return (OCResourceProperty)-1;
3345 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3346 uint8_t *numResourceTypes)
3348 OCResource *resource = NULL;
3349 OCResourceType *pointer = NULL;
3351 VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3352 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3354 *numResourceTypes = 0;
3356 resource = findResource((OCResource *) handle);
3359 pointer = resource->rsrcType;
3362 *numResourceTypes = *numResourceTypes + 1;
3363 pointer = pointer->next;
3369 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3371 OCResourceType *resourceType = NULL;
3373 resourceType = findResourceTypeAtIndex(handle, index);
3376 return resourceType->resourcetypename;
3378 return (const char *) NULL;
3381 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3382 uint8_t *numResourceInterfaces)
3384 OCResourceInterface *pointer = NULL;
3385 OCResource *resource = NULL;
3387 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3388 VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3390 *numResourceInterfaces = 0;
3391 resource = findResource((OCResource *) handle);
3394 pointer = resource->rsrcInterface;
3397 *numResourceInterfaces = *numResourceInterfaces + 1;
3398 pointer = pointer->next;
3404 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3406 OCResourceInterface *resourceInterface = NULL;
3408 resourceInterface = findResourceInterfaceAtIndex(handle, index);
3409 if (resourceInterface)
3411 return resourceInterface->name;
3413 return (const char *) NULL;
3416 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3419 OCResource *resource = NULL;
3421 if (index >= MAX_CONTAINED_RESOURCES)
3426 resource = findResource((OCResource *) collectionHandle);
3432 return resource->rsrcResources[index];
3435 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3436 OCEntityHandler entityHandler,
3437 void* callbackParam)
3439 OCResource *resource = NULL;
3441 // Validate parameters
3442 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3444 // Use the handle to find the resource in the resource linked list
3445 resource = findResource((OCResource *)handle);
3448 OC_LOG(ERROR, TAG, "Resource not found");
3449 return OC_STACK_ERROR;
3453 resource->entityHandler = entityHandler;
3454 resource->entityHandlerCallbackParam = callbackParam;
3456 #ifdef WITH_PRESENCE
3457 if (presenceResource.handle)
3459 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3460 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3467 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3469 OCResource *resource = NULL;
3471 resource = findResource((OCResource *)handle);
3474 OC_LOG(ERROR, TAG, "Resource not found");
3479 return resource->entityHandler;
3482 void incrementSequenceNumber(OCResource * resPtr)
3484 // Increment the sequence number
3485 resPtr->sequenceNum += 1;
3486 if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3488 resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3493 #ifdef WITH_PRESENCE
3494 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3495 OCPresenceTrigger trigger)
3497 OCResource *resPtr = NULL;
3498 OCStackResult result = OC_STACK_ERROR;
3499 OCMethod method = OC_REST_PRESENCE;
3500 uint32_t maxAge = 0;
3501 resPtr = findResource((OCResource *) presenceResource.handle);
3504 return OC_STACK_NO_RESOURCE;
3507 if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3509 maxAge = presenceResource.presenceTTL;
3511 result = SendAllObserverNotification(method, resPtr, maxAge,
3512 trigger, resourceType, OC_LOW_QOS);
3518 OCStackResult SendStopNotification()
3520 OCResource *resPtr = NULL;
3521 OCStackResult result = OC_STACK_ERROR;
3522 OCMethod method = OC_REST_PRESENCE;
3523 resPtr = findResource((OCResource *) presenceResource.handle);
3526 return OC_STACK_NO_RESOURCE;
3529 // maxAge is 0. ResourceType is NULL.
3530 result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3536 #endif // WITH_PRESENCE
3537 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3539 OCResource *resPtr = NULL;
3540 OCStackResult result = OC_STACK_ERROR;
3541 OCMethod method = OC_REST_NOMETHOD;
3542 uint32_t maxAge = 0;
3544 OC_LOG(INFO, TAG, "Notifying all observers");
3545 #ifdef WITH_PRESENCE
3546 if(handle == presenceResource.handle)
3550 #endif // WITH_PRESENCE
3551 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3553 // Verify that the resource exists
3554 resPtr = findResource ((OCResource *) handle);
3557 return OC_STACK_NO_RESOURCE;
3561 //only increment in the case of regular observing (not presence)
3562 incrementSequenceNumber(resPtr);
3563 method = OC_REST_OBSERVE;
3564 maxAge = MAX_OBSERVE_AGE;
3565 #ifdef WITH_PRESENCE
3566 result = SendAllObserverNotification (method, resPtr, maxAge,
3567 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3569 result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3576 OCNotifyListOfObservers (OCResourceHandle handle,
3577 OCObservationId *obsIdList,
3578 uint8_t numberOfIds,
3579 const OCRepPayload *payload,
3580 OCQualityOfService qos)
3582 OC_LOG(INFO, TAG, "Entering OCNotifyListOfObservers");
3584 OCResource *resPtr = NULL;
3585 //TODO: we should allow the server to define this
3586 uint32_t maxAge = MAX_OBSERVE_AGE;
3588 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3589 VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3590 VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
3592 resPtr = findResource ((OCResource *) handle);
3593 if (NULL == resPtr || myStackMode == OC_CLIENT)
3595 return OC_STACK_NO_RESOURCE;
3599 incrementSequenceNumber(resPtr);
3601 return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3602 payload, maxAge, qos));
3605 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3607 OCStackResult result = OC_STACK_ERROR;
3608 OCServerRequest *serverRequest = NULL;
3610 OC_LOG(INFO, TAG, "Entering OCDoResponse");
3612 // Validate input parameters
3613 VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3614 VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3617 // Get pointer to request info
3618 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3621 // response handler in ocserverrequest.c. Usually HandleSingleResponse.
3622 result = serverRequest->ehResponseHandler(ehResponse);
3628 //-----------------------------------------------------------------------------
3629 // Private internal function definitions
3630 //-----------------------------------------------------------------------------
3631 static OCDoHandle GenerateInvocationHandle()
3633 OCDoHandle handle = NULL;
3634 // Generate token here, it will be deleted when the transaction is deleted
3635 handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3638 OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3644 #ifdef WITH_PRESENCE
3645 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3646 OCResourceProperty resourceProperties, uint8_t enable)
3650 return OC_STACK_INVALID_PARAM;
3652 if (resourceProperties
3653 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
3655 OC_LOG(ERROR, TAG, "Invalid property");
3656 return OC_STACK_INVALID_PARAM;
3660 *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3664 *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3670 OCStackResult initResources()
3672 OCStackResult result = OC_STACK_OK;
3674 headResource = NULL;
3675 tailResource = NULL;
3676 // Init Virtual Resources
3677 #ifdef WITH_PRESENCE
3678 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
3680 result = OCCreateResource(&presenceResource.handle,
3681 OC_RSRVD_RESOURCE_TYPE_PRESENCE,
3683 OC_RSRVD_PRESENCE_URI,
3687 //make resource inactive
3688 result = OCChangeResourceProperty(
3689 &(((OCResource *) presenceResource.handle)->resourceProperties),
3693 if (result == OC_STACK_OK)
3695 result = SRMInitSecureResources();
3701 void insertResource(OCResource *resource)
3705 headResource = resource;
3706 tailResource = resource;
3710 tailResource->next = resource;
3711 tailResource = resource;
3713 resource->next = NULL;
3716 OCResource *findResource(OCResource *resource)
3718 OCResource *pointer = headResource;
3722 if (pointer == resource)
3726 pointer = pointer->next;
3731 void deleteAllResources()
3733 OCResource *pointer = headResource;
3734 OCResource *temp = NULL;
3738 temp = pointer->next;
3739 #ifdef WITH_PRESENCE
3740 if (pointer != (OCResource *) presenceResource.handle)
3742 #endif // WITH_PRESENCE
3743 deleteResource(pointer);
3744 #ifdef WITH_PRESENCE
3746 #endif // WITH_PRESENCE
3750 SRMDeInitSecureResources();
3752 #ifdef WITH_PRESENCE
3753 // Ensure that the last resource to be deleted is the presence resource. This allows for all
3754 // presence notification attributed to their deletion to be processed.
3755 deleteResource((OCResource *) presenceResource.handle);
3756 #endif // WITH_PRESENCE
3759 OCStackResult deleteResource(OCResource *resource)
3761 OCResource *prev = NULL;
3762 OCResource *temp = NULL;
3765 OC_LOG(DEBUG,TAG,"resource is NULL");
3766 return OC_STACK_INVALID_PARAM;
3769 OC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
3771 temp = headResource;
3774 if (temp == resource)
3776 // Invalidate all Resource Properties.
3777 resource->resourceProperties = (OCResourceProperty) 0;
3778 #ifdef WITH_PRESENCE
3779 if(resource != (OCResource *) presenceResource.handle)
3781 #endif // WITH_PRESENCE
3782 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
3783 #ifdef WITH_PRESENCE
3786 if(presenceResource.handle)
3788 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3789 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
3792 // Only resource in list.
3793 if (temp == headResource && temp == tailResource)
3795 headResource = NULL;
3796 tailResource = NULL;
3799 else if (temp == headResource)
3801 headResource = temp->next;
3804 else if (temp == tailResource)
3806 tailResource = prev;
3807 tailResource->next = NULL;
3811 prev->next = temp->next;
3814 deleteResourceElements(temp);
3825 return OC_STACK_ERROR;
3828 void deleteResourceElements(OCResource *resource)
3835 OICFree(resource->uri);
3836 deleteResourceType(resource->rsrcType);
3837 deleteResourceInterface(resource->rsrcInterface);
3840 void deleteResourceType(OCResourceType *resourceType)
3842 OCResourceType *pointer = resourceType;
3843 OCResourceType *next = NULL;
3847 next = pointer->next;
3848 OICFree(pointer->resourcetypename);
3854 void deleteResourceInterface(OCResourceInterface *resourceInterface)
3856 OCResourceInterface *pointer = resourceInterface;
3857 OCResourceInterface *next = NULL;
3861 next = pointer->next;
3862 OICFree(pointer->name);
3868 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
3870 OCResourceType *pointer = NULL;
3871 OCResourceType *previous = NULL;
3872 if (!resource || !resourceType)
3876 // resource type list is empty.
3877 else if (!resource->rsrcType)
3879 resource->rsrcType = resourceType;
3883 pointer = resource->rsrcType;
3887 if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
3889 OC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
3890 OICFree(resourceType->resourcetypename);
3891 OICFree(resourceType);
3895 pointer = pointer->next;
3897 previous->next = resourceType;
3899 resourceType->next = NULL;
3901 OC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
3904 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
3906 OCResource *resource = NULL;
3907 OCResourceType *pointer = NULL;
3909 // Find the specified resource
3910 resource = findResource((OCResource *) handle);
3916 // Make sure a resource has a resourcetype
3917 if (!resource->rsrcType)
3922 // Iterate through the list
3923 pointer = resource->rsrcType;
3924 for(uint8_t i = 0; i< index && pointer; ++i)
3926 pointer = pointer->next;
3931 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
3933 if(resourceTypeList && resourceTypeName)
3935 OCResourceType * rtPointer = resourceTypeList;
3936 while(resourceTypeName && rtPointer)
3938 if(rtPointer->resourcetypename &&
3939 strcmp(resourceTypeName, (const char *)
3940 (rtPointer->resourcetypename)) == 0)
3944 rtPointer = rtPointer->next;
3952 * Insert a new interface into interface linked list only if not already present.
3953 * If alredy present, 2nd arg is free'd.
3954 * Default interface will always be first if present.
3956 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
3958 OCResourceInterface *pointer = NULL;
3959 OCResourceInterface *previous = NULL;
3961 newInterface->next = NULL;
3963 OCResourceInterface **firstInterface = &(resource->rsrcInterface);
3965 if (!*firstInterface)
3967 *firstInterface = newInterface;
3969 else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
3971 if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
3973 OICFree(newInterface->name);
3974 OICFree(newInterface);
3979 newInterface->next = *firstInterface;
3980 *firstInterface = newInterface;
3985 pointer = *firstInterface;
3988 if (strcmp(newInterface->name, pointer->name) == 0)
3990 OICFree(newInterface->name);
3991 OICFree(newInterface);
3995 pointer = pointer->next;
3997 previous->next = newInterface;
4001 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
4004 OCResource *resource = NULL;
4005 OCResourceInterface *pointer = NULL;
4007 // Find the specified resource
4008 resource = findResource((OCResource *) handle);
4014 // Make sure a resource has a resourceinterface
4015 if (!resource->rsrcInterface)
4020 // Iterate through the list
4021 pointer = resource->rsrcInterface;
4023 for (uint8_t i = 0; i < index && pointer; ++i)
4025 pointer = pointer->next;
4031 * This function splits the uri using the '?' delimiter.
4032 * "uriWithoutQuery" is the block of characters between the beginning
4033 * till the delimiter or '\0' which ever comes first.
4034 * "query" is whatever is to the right of the delimiter if present.
4035 * No delimiter sets the query to NULL.
4036 * If either are present, they will be malloc'ed into the params 2, 3.
4037 * The first param, *uri is left untouched.
4039 * NOTE: This function does not account for whitespace at the end of the uri NOR
4040 * malformed uri's with '??'. Whitespace at the end will be assumed to be
4041 * part of the query.
4043 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
4047 return OC_STACK_INVALID_URI;
4049 if(!query || !uriWithoutQuery)
4051 return OC_STACK_INVALID_PARAM;
4055 *uriWithoutQuery = NULL;
4057 size_t uriWithoutQueryLen = 0;
4058 size_t queryLen = 0;
4059 size_t uriLen = strlen(uri);
4061 char *pointerToDelimiter = strstr(uri, "?");
4063 uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : (size_t)(pointerToDelimiter - uri);
4064 queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
4066 if (uriWithoutQueryLen)
4068 *uriWithoutQuery = (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
4069 if (!*uriWithoutQuery)
4073 OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
4077 *query = (char *) OICCalloc(queryLen + 1, 1);
4080 OICFree(*uriWithoutQuery);
4081 *uriWithoutQuery = NULL;
4084 OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
4090 return OC_STACK_NO_MEMORY;
4093 const OicUuid_t* OCGetServerInstanceID(void)
4095 static bool generated = false;
4096 static OicUuid_t sid;
4102 if (GetDoxmDeviceID(&sid) != OC_STACK_OK)
4104 OC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
4111 const char* OCGetServerInstanceIDString(void)
4113 static bool generated = false;
4114 static char sidStr[UUID_STRING_SIZE];
4121 const OicUuid_t* sid = OCGetServerInstanceID();
4123 if(OCConvertUuidToString(sid->id, sidStr) != RAND_UUID_OK)
4125 OC_LOG(FATAL, TAG, "Generate UUID String for Server Instance failed!");
4133 CAResult_t OCSelectNetwork()
4135 CAResult_t retResult = CA_STATUS_FAILED;
4136 CAResult_t caResult = CA_STATUS_OK;
4138 CATransportAdapter_t connTypes[] = {
4140 CA_ADAPTER_RFCOMM_BTEDR,
4141 CA_ADAPTER_GATT_BTLE
4144 ,CA_ADAPTER_REMOTE_ACCESS
4147 int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
4149 for(int i = 0; i<numConnTypes; i++)
4151 // Ignore CA_NOT_SUPPORTED error. The CA Layer may have not compiled in the interface.
4152 if(caResult == CA_STATUS_OK || caResult == CA_NOT_SUPPORTED)
4154 caResult = CASelectNetwork(connTypes[i]);
4155 if(caResult == CA_STATUS_OK)
4157 retResult = CA_STATUS_OK;
4162 if(retResult != CA_STATUS_OK)
4164 return caResult; // Returns error of appropriate transport that failed fatally.
4170 OCStackResult CAResultToOCResult(CAResult_t caResult)
4176 case CA_STATUS_INVALID_PARAM:
4177 return OC_STACK_INVALID_PARAM;
4178 case CA_ADAPTER_NOT_ENABLED:
4179 return OC_STACK_ADAPTER_NOT_ENABLED;
4180 case CA_SERVER_STARTED_ALREADY:
4182 case CA_SERVER_NOT_STARTED:
4183 return OC_STACK_ERROR;
4184 case CA_DESTINATION_NOT_REACHABLE:
4185 return OC_STACK_COMM_ERROR;
4186 case CA_SOCKET_OPERATION_FAILED:
4187 return OC_STACK_COMM_ERROR;
4188 case CA_SEND_FAILED:
4189 return OC_STACK_COMM_ERROR;
4190 case CA_RECEIVE_FAILED:
4191 return OC_STACK_COMM_ERROR;
4192 case CA_MEMORY_ALLOC_FAILED:
4193 return OC_STACK_NO_MEMORY;
4194 case CA_REQUEST_TIMEOUT:
4195 return OC_STACK_TIMEOUT;
4196 case CA_DESTINATION_DISCONNECTED:
4197 return OC_STACK_COMM_ERROR;
4198 case CA_STATUS_FAILED:
4199 return OC_STACK_ERROR;
4200 case CA_NOT_SUPPORTED:
4201 return OC_STACK_NOTIMPL;
4203 return OC_STACK_ERROR;