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 //-----------------------------------------------------------------------------
25 #define _POSIX_C_SOURCE 200112L
29 #include "ocstackinternal.h"
30 #include "ocresourcehandler.h"
31 #include "occlientcb.h"
32 #include "ocobserve.h"
37 #include "ocserverrequest.h"
41 #include "cainterface.h"
44 //-----------------------------------------------------------------------------
46 //-----------------------------------------------------------------------------
48 OC_STACK_UNINITIALIZED = 0, OC_STACK_INITIALIZED, OC_STACK_UNINIT_IN_PROGRESS
53 OC_PRESENCE_UNINITIALIZED = 0, OC_PRESENCE_INITIALIZED
57 //-----------------------------------------------------------------------------
59 //-----------------------------------------------------------------------------
60 static OCStackState stackState = OC_STACK_UNINITIALIZED;
62 OCResource *headResource = NULL;
64 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
65 static PresenceResource presenceResource;
66 uint8_t PresenceTimeOutSize = 0;
67 uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
71 OCDeviceEntityHandler defaultDeviceHandler;
72 OCStackResult getQueryFromUri(const char * uri, unsigned char** resourceType, char ** newURI);
74 //-----------------------------------------------------------------------------
76 //-----------------------------------------------------------------------------
77 #define TAG PCF("OCStack")
78 #define VERIFY_SUCCESS(op, successCode) { if (op != successCode) \
79 {OC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
80 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OC_LOG((logLevel), \
81 TAG, PCF(#arg " is NULL")); return (retVal); } }
82 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OC_LOG_V(FATAL, TAG, "%s is NULL", #arg);\
85 //TODO: we should allow the server to define this
86 #define MAX_OBSERVE_AGE (0x2FFFFUL)
88 //-----------------------------------------------------------------------------
90 //-----------------------------------------------------------------------------
91 extern void DeinitOCSecurityInfo();
93 //-----------------------------------------------------------------------------
94 // Internal API function
95 //-----------------------------------------------------------------------------
97 // This internal function is called to update the stack with the status of
98 // observers and communication failures
99 OCStackResult OCStackFeedBack(OCCoAPToken * token, uint8_t status)
101 OCStackResult result = OC_STACK_ERROR;
102 ResourceObserver * observer = NULL;
103 OCEntityHandlerRequest ehRequest = {0};
107 case OC_OBSERVER_NOT_INTERESTED:
108 OC_LOG(DEBUG, TAG, PCF("observer is not interested in our notifications anymore"));
110 observer = GetObserverUsingToken (token->token);
112 observer = GetObserverUsingToken (token);
116 result = FormOCEntityHandlerRequest(&ehRequest, (OCRequestHandle) NULL,
117 OC_REST_NOMETHOD, (OCResourceHandle) NULL, NULL, NULL, 0,
118 NULL, OC_OBSERVE_DEREGISTER, observer->observeId);
119 if(result != OC_STACK_OK)
123 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest);
125 //observer is not observing anymore
127 result = DeleteObserverUsingToken (token->token);
129 result = DeleteObserverUsingToken (token);
131 if(result == OC_STACK_OK)
133 OC_LOG(DEBUG, TAG, PCF("Removed observer successfully"));
137 result = OC_STACK_OK;
138 OC_LOG(DEBUG, TAG, PCF("Observer Removal failed"));
141 case OC_OBSERVER_STILL_INTERESTED:
142 //observer is still interested
143 OC_LOG(DEBUG, TAG, PCF("observer is interested in our \
144 notifications, reset the failedCount"));
146 observer = GetObserverUsingToken (token->token);
148 observer = GetObserverUsingToken (token);
152 observer->forceHighQos = 0;
153 observer->failedCommCount = 0;
154 result = OC_STACK_OK;
158 result = OC_STACK_OBSERVER_NOT_FOUND;
161 case OC_OBSERVER_FAILED_COMM:
162 //observer is not reachable
163 OC_LOG(DEBUG, TAG, PCF("observer is unreachable"));
165 observer = GetObserverUsingToken (token->token);
167 observer = GetObserverUsingToken (token);
171 if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
173 result = FormOCEntityHandlerRequest(&ehRequest, (OCRequestHandle) NULL,
174 OC_REST_NOMETHOD, (OCResourceHandle) NULL, NULL, NULL, 0,
175 NULL, OC_OBSERVE_DEREGISTER, observer->observeId);
176 if(result != OC_STACK_OK)
178 return OC_STACK_ERROR;
180 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest);
181 //observer is unreachable
182 result = DeleteObserverUsingToken (token);
183 if(result == OC_STACK_OK)
185 OC_LOG(DEBUG, TAG, PCF("Removed observer successfully"));
189 result = OC_STACK_OK;
190 OC_LOG(DEBUG, TAG, PCF("Observer Removal failed"));
195 observer->failedCommCount++;
196 result = OC_STACK_CONTINUE;
198 observer->forceHighQos = 1;
199 OC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",observer->failedCommCount);
203 OC_LOG(ERROR, TAG, PCF("Unknown status"));
204 result = OC_STACK_ERROR;
211 OCStackResult CAToOCStackResult(CAResponseResult_t caCode)
213 OCStackResult ret = OC_STACK_ERROR;
221 ret = OC_STACK_RESOURCE_CREATED;
224 ret = OC_STACK_RESOURCE_DELETED;
227 ret = OC_STACK_INVALID_QUERY;
230 ret = OC_STACK_INVALID_OPTION;
233 ret = OC_STACK_NO_RESOURCE;
241 OCStackResult OCToCAConnectivityType(OCConnectivityType ocConType, CAConnectivityType_t* caConType)
243 OCStackResult ret = OC_STACK_OK;
248 *caConType = CA_ETHERNET;
251 *caConType = CA_WIFI;
260 //TODO-CA Add other connectivity types as they are enabled
261 *caConType = (CA_WIFI|CA_ETHERNET);
264 ret = OC_STACK_INVALID_PARAM;
270 OCStackResult CAToOCConnectivityType(CAConnectivityType_t caConType, OCConnectivityType *ocConType)
272 OCStackResult ret = OC_STACK_OK;
277 *ocConType = OC_ETHERNET;
280 *ocConType = OC_WIFI;
289 ret = OC_STACK_INVALID_PARAM;
295 // update response.addr appropriately from endPoint.addressInfo
296 OCStackResult UpdateResponseAddr(OCClientResponse *response, const CARemoteEndpoint_t* endPoint)
298 struct sockaddr_in sa;
299 OCStackResult ret = OC_STACK_INVALID_PARAM;
300 //TODO-CA Check validity of the endPoint pointer
301 inet_pton(AF_INET, endPoint->addressInfo.IP.ipAddress, &(sa.sin_addr));
302 sa.sin_port = htons(endPoint->addressInfo.IP.port);
303 static OCDevAddr address;
304 memcpy((void*)&address.addr, &(sa), sizeof(sa));
307 response->addr = &address;
308 ret = CAToOCConnectivityType(endPoint->connectivityType, &(response->connType));
313 void parsePresencePayload(char* payload, uint32_t* seqNum, uint32_t* maxAge, char** resType)
317 // The format of the payload is {"oc":[%u:%u:%s]}
318 // %u : sequence number,
320 // %s : Resource Type (Optional)
321 tok = strtok(payload, "[:]}");
322 payload[strlen(payload)] = ':';
323 tok = strtok(NULL, "[:]}");
324 payload[strlen((char *)payload)] = ':';
325 *seqNum = (uint32_t) atoi(tok);
326 tok = strtok(NULL, "[:]}");
327 *maxAge = (uint32_t) atoi(tok);
328 tok = strtok(NULL, "[:]}");
332 *resType = (char *)OCMalloc(strlen(tok));
337 payload[strlen((char *)payload)] = ':';
338 strcpy(*resType, tok);
339 OC_LOG_V(DEBUG, TAG, "----------------resourceTypeName %s", *resType);
341 payload[strlen((char *)payload)] = ']';
344 OCStackResult HandlePresenceResponse(const CARemoteEndpoint_t* endPoint,
345 const CAResponseInfo_t* responseInfo)
347 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
348 ClientCB * cbNode = NULL;
349 char *resourceTypeName = NULL;
350 OCClientResponse response;
351 OCStackResult result = OC_STACK_ERROR;
352 uint32_t lowerBound = 0;
353 uint32_t higherBound = 0;
356 char *fullUri = NULL;
357 char *ipAddress = NULL;
358 int presenceSubscribe = 0;
359 int multicastPresenceSubscribe = 0;
361 fullUri = (char *) OCMalloc(MAX_URI_LENGTH );
365 OC_LOG(INFO, TAG, PCF("Memory could not be abllocated for fullUri"));
366 result = OC_STACK_NO_MEMORY;
370 ipAddress = (char *) OCMalloc(strlen(endPoint->addressInfo.IP.ipAddress) + 1);
372 if(NULL == ipAddress)
374 OC_LOG(INFO, TAG, PCF("Memory could not be abllocated for ipAddress"));
375 result = OC_STACK_NO_MEMORY;
379 strncpy(ipAddress, endPoint->addressInfo.IP.ipAddress,
380 strlen(endPoint->addressInfo.IP.ipAddress));
381 ipAddress[strlen(endPoint->addressInfo.IP.ipAddress)] = '\0';
383 snprintf(fullUri, MAX_URI_LENGTH, "coap://%s:%u%s", ipAddress, endPoint->addressInfo.IP.port,
386 cbNode = GetClientCB(NULL, NULL, fullUri);
390 presenceSubscribe = 1;
394 snprintf(fullUri, MAX_URI_LENGTH, "%s%s", OC_MULTICAST_IP, endPoint->resourceUri);
395 cbNode = GetClientCB(NULL, NULL, fullUri);
398 multicastPresenceSubscribe = 1;
402 if(!presenceSubscribe && !multicastPresenceSubscribe)
404 OC_LOG(INFO, TAG, PCF("Received a presence notification, but I do not have callback \
405 ------------ ignoring"));
409 // No payload to the application in case of presence
410 response.resJSONPayload = NULL;
411 response.result = OC_STACK_OK;
413 UpdateResponseAddr(&response, endPoint);
415 if(responseInfo->info.payload)
417 parsePresencePayload(responseInfo->info.payload,
418 &(response.sequenceNumber),
425 OC_LOG(INFO, TAG, PCF("===============Stopping presence"));
426 response.result = OC_STACK_PRESENCE_STOPPED;
429 OCFree(cbNode->presence->timeOut);
430 OCFree(cbNode->presence);
431 cbNode->presence = NULL;
434 else if(presenceSubscribe)
436 if(!cbNode->presence)
438 cbNode->presence = (OCPresence *) OCMalloc(sizeof(OCPresence));
439 VERIFY_NON_NULL_V(cbNode->presence);
440 cbNode->presence->timeOut = NULL;
441 cbNode->presence->timeOut = (uint32_t *)
442 OCMalloc(PresenceTimeOutSize * sizeof(uint32_t));
443 if(!(cbNode->presence->timeOut)){
444 OCFree(cbNode->presence);
445 result = OC_STACK_NO_MEMORY;
449 OC_LOG_V(INFO, TAG, "===============Update presence TTL, now time is %u", GetTime(0));
450 cbNode->presence->TTL = maxAge;
451 for(int index = 0; index < PresenceTimeOutSize; index++)
453 lowerBound = GetTime(((float)(PresenceTimeOut[index])
454 /(float)100)*(float)cbNode->presence->TTL);
455 higherBound = GetTime(((float)(PresenceTimeOut[index + 1])
456 /(float)100)*(float)cbNode->presence->TTL);
457 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
458 OC_LOG_V(DEBUG, TAG, "----------------lowerBound timeout %d", lowerBound);
459 OC_LOG_V(DEBUG, TAG, "----------------higherBound timeout %d", higherBound);
460 OC_LOG_V(DEBUG, TAG, "----------------timeOut entry %d",
461 cbNode->presence->timeOut[index]);
463 cbNode->presence->TTLlevel = 0;
464 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
465 if(cbNode->sequenceNumber == response.sequenceNumber)
467 OC_LOG(INFO, TAG, PCF("===============No presence change"));
470 OC_LOG(INFO, TAG, PCF("===============Presence changed, calling up the stack"));
471 cbNode->sequenceNumber = response.sequenceNumber;
473 // Ensure that a filter is actually applied.
474 if(resourceTypeName && cbNode->filterResourceType)
476 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
484 // This is the multicast case
486 OCMulticastNode* mcNode = NULL;
487 mcNode = GetMCPresenceNode((const unsigned char *)fullUri);
491 if(mcNode->nonce == response.sequenceNumber)
493 OC_LOG(INFO, TAG, PCF("===============No presence change (Multicast)"));
496 mcNode->nonce = response.sequenceNumber;
500 uint32_t uriLen = strlen((char*)fullUri);
501 unsigned char* uri = (unsigned char *) OCMalloc(uriLen + 1);
504 memcpy(uri, fullUri, (uriLen + 1));
509 PCF("===============No Memory for URI to store in the presence node"));
510 result = OC_STACK_NO_MEMORY;
513 result = AddMCPresenceNode(&mcNode, (unsigned char*) uri, response.sequenceNumber);
514 if(result == OC_STACK_NO_MEMORY)
517 PCF("===============No Memory for Multicast Presence Node"));
518 result = OC_STACK_NO_MEMORY;
523 // Ensure that a filter is actually applied.
524 if(resourceTypeName && cbNode->filterResourceType)
526 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
533 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
535 if (cbResult == OC_STACK_DELETE_TRANSACTION)
537 FindAndDeleteClientCB(cbNode);
543 OCFree(resourceTypeName);
548 //This function will be called back by CA layer when a response is received
549 void HandleCAResponses(const CARemoteEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
551 OC_LOG(INFO, TAG, PCF("Enter HandleCAResponses"));
555 OC_LOG(ERROR, TAG, PCF("endPoint is NULL"));
559 if(NULL == responseInfo)
561 OC_LOG(ERROR, TAG, PCF("responseInfo is NULL"));
565 if(strcmp(endPoint->resourceUri, OC_PRESENCE_URI) == 0)
567 HandlePresenceResponse(endPoint, responseInfo);
571 ClientCB *cbNode = GetClientCB((CAToken_t *)&responseInfo->info.token, NULL, NULL);
575 OC_LOG(INFO, TAG, PCF("Calling into application address space"));
576 OCClientResponse response;
578 OCStackResult result = UpdateResponseAddr(&response, endPoint);
579 if(result != OC_STACK_OK)
581 OC_LOG(ERROR, TAG, PCF("Invalid connectivity type in endpoint"));
585 response.result = CAToOCStackResult(responseInfo->result);
586 response.resJSONPayload = (unsigned char*)responseInfo->info.payload;
587 response.numRcvdVendorSpecificHeaderOptions = 0;
588 if(responseInfo->info.numOptions > 0)
591 //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
592 if(responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
594 memcpy (&(response.sequenceNumber),
595 &(responseInfo->info.options[0].optionData), sizeof(uint32_t));
596 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
601 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
604 if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
606 OC_LOG(ERROR, TAG, PCF("#header options are more than MAX_HEADER_OPTIONS"));
610 for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
612 memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
613 &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
616 result = cbNode->callBack(cbNode->context,
617 cbNode->handle, &response);
618 if (result == OC_STACK_DELETE_TRANSACTION)
620 FindAndDeleteClientCB(cbNode);
623 OC_LOG_V(INFO, TAG, PCF("Received payload: %s\n"), (char*)responseInfo->info.payload);
624 OC_LOG(INFO, TAG, PCF("Exit HandleCAResponses"));
627 //This function will be called back by CA layer when a request is received
628 void HandleCARequests(const CARemoteEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
630 OC_LOG(INFO, TAG, PCF("Enter HandleCARequests"));
633 if(myStackMode == OC_CLIENT)
635 //TODO: should the client be responding to requests?
639 OCServerProtocolRequest serverRequest;
641 memset (&serverRequest, 0, sizeof(OCServerProtocolRequest));
642 OC_LOG_V(INFO, TAG, PCF("***** Endpoint URI ***** : %s\n"), (char*)endPoint->resourceUri);
644 char * newUri = (char *)endPoint->resourceUri;
645 unsigned char * query = NULL;
646 getQueryFromUri(endPoint->resourceUri, &query, &newUri);
647 OC_LOG_V(INFO, TAG, PCF("**********URI without query ****: %s\n"), newUri);
648 OC_LOG_V(INFO, TAG, PCF("**********Query ****: %s\n"), query);
650 memcpy (&(serverRequest.resourceUrl), newUri, strlen(newUri));
654 memcpy (&(serverRequest.query), query, strlen((char*)query));
656 //copy request payload
657 if (requestInfo->info.payload)
659 serverRequest.reqTotalSize = strlen(requestInfo->info.payload) + 1;
660 memcpy (&(serverRequest.reqJSONPayload), requestInfo->info.payload,
661 strlen(requestInfo->info.payload));
662 serverRequest.reqTotalSize = strlen((const char *)requestInfo->info.payload) + 1;
666 serverRequest.reqTotalSize = 1;
669 switch (requestInfo->method)
673 serverRequest.method = OC_REST_GET;
678 serverRequest.method = OC_REST_PUT;
683 serverRequest.method = OC_REST_POST;
688 serverRequest.method = OC_REST_DELETE;
693 OC_LOG(ERROR, TAG, PCF("Received CA method %d not supported"));
699 OC_LOG_V(INFO, TAG, "HandleCARequests: CA token length = %d", strlen(requestInfo->info.token));
700 OC_LOG_BUFFER(INFO, TAG, requestInfo->info.token, strlen(requestInfo->info.token));
701 // TODO-CA: For CA integration currently copying CAToken to OCCoapToken:
702 // Need to remove OCCoapToken
703 memcpy (&(serverRequest.requestToken.token), requestInfo->info.token,
705 serverRequest.requestToken.tokenLength = MAX_TOKEN_LENGTH;
707 if (requestInfo->info.type == CA_MSG_CONFIRM)
709 serverRequest.qos = OC_HIGH_QOS;
711 else if (requestInfo->info.type == CA_MSG_NONCONFIRM)
713 serverRequest.qos = OC_LOW_QOS;
715 else if (requestInfo->info.type == CA_MSG_ACKNOWLEDGE)
717 // TODO-CA: Need to handle this
719 else if (requestInfo->info.type == CA_MSG_RESET)
721 // TODO-CA: Need to handle this
723 // CA does not need the following 3 fields
724 serverRequest.coapID = 0;
725 serverRequest.delayedResNeeded = 0;
726 serverRequest.secured = endPoint->isSecured;
729 serverRequest.addressInfo = endPoint->addressInfo;
730 serverRequest.connectivityType = endPoint->connectivityType;
731 if (requestInfo->info.token)
733 strncpy(serverRequest.token, requestInfo->info.token, sizeof(serverRequest.token) - 1);
736 // copy vendor specific header options
737 // TODO-CA: CA is including non-vendor header options as well, like observe.
738 // Need to filter those out
739 GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &(requestInfo->info.numOptions));
740 if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
742 // TODO-CA: Need to send an error indicating the num of options is incorrect
745 serverRequest.numRcvdVendorSpecificHeaderOptions = requestInfo->info.numOptions;
746 if (serverRequest.numRcvdVendorSpecificHeaderOptions)
748 memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
749 sizeof(CAHeaderOption_t)*requestInfo->info.numOptions);
752 if(HandleStackRequests (&serverRequest) != OC_STACK_OK)
754 OC_LOG(INFO, TAG, PCF("HandleStackRequests failed"));
758 OC_LOG(INFO, TAG, PCF("Exit HandleCARequests"));
763 //This function will be called back by occoap layer when a request is received
764 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
766 OC_LOG(INFO, TAG, PCF("Entering HandleStackRequests (OCStack Layer)"));
767 OCStackResult result = OC_STACK_ERROR;
768 ResourceHandling resHandling;
769 OCResource *resource;
771 OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken);
774 OC_LOG(INFO, TAG, PCF("This is a new Server Request"));
776 result = AddServerCARequest(&request, protocolRequest->coapID,
777 protocolRequest->delayedResNeeded, protocolRequest->secured, 0,
778 protocolRequest->method, protocolRequest->numRcvdVendorSpecificHeaderOptions,
779 protocolRequest->observationOption, protocolRequest->qos,
780 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
781 protocolRequest->reqJSONPayload, &protocolRequest->requestToken,
782 &protocolRequest->requesterAddr, protocolRequest->resourceUrl,
783 protocolRequest->reqTotalSize,
784 &protocolRequest->addressInfo, protocolRequest->connectivityType, protocolRequest->token);
786 result = AddServerRequest(&request, protocolRequest->coapID,
787 protocolRequest->delayedResNeeded, protocolRequest->secured, 0,
788 protocolRequest->method, protocolRequest->numRcvdVendorSpecificHeaderOptions,
789 protocolRequest->observationOption, protocolRequest->qos,
790 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
791 protocolRequest->reqJSONPayload, &protocolRequest->requestToken,
792 &protocolRequest->requesterAddr, protocolRequest->resourceUrl,
793 protocolRequest->reqTotalSize);
795 if (OC_STACK_OK != result)
797 OC_LOG(ERROR, TAG, PCF("Error adding server request"));
800 VERIFY_NON_NULL(request, ERROR, OC_STACK_NO_MEMORY);
802 if(!protocolRequest->reqMorePacket)
804 request->requestComplete = 1;
809 OC_LOG(INFO, TAG, PCF("This is either a repeated Server Request or blocked Server Request"));
812 if(request->requestComplete)
814 OC_LOG(INFO, TAG, PCF("This Server Request is complete"));
815 result = DetermineResourceHandling (request, &resHandling, &resource);
816 if (result == OC_STACK_OK)
818 result = ProcessRequest(resHandling, resource, request);
822 result = OC_STACK_ERROR;
827 OC_LOG(INFO, TAG, PCF("This Server Request is incomplete"));
828 result = OC_STACK_CONTINUE;
833 //This function will be called back by occoap layer when a response is received
834 OCStackResult HandleStackResponses(OCResponse * response)
836 OC_LOG(INFO, TAG, PCF("Entering HandleStackResponses (OCStack Layer)"));
837 OCStackResult result = OC_STACK_OK;
838 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
839 uint8_t isObserveNotification = 0;
840 ClientCB * cbNode = NULL;
842 uint8_t isPresenceNotification = 0;
843 uint8_t isMulticastPresence = 0;
844 char * resourceTypeName = NULL;
845 uint32_t lowerBound = 0;
846 uint32_t higherBound = 0;
848 unsigned char * bufRes = response->bufRes;
849 #endif // WITH_PRESENCE
851 cbNode = response->cbNode;
854 cbNode = GetClientCB(response->rcvdToken, NULL, NULL);
857 if(response->clientResponse->sequenceNumber >= OC_OFFSET_SEQUENCE_NUMBER)
859 isObserveNotification = 1;
860 OC_LOG(INFO, TAG, PCF("Received an observe notification"));
863 OC_LOG_V(DEBUG, TAG, "The sequenceNumber/NONCE of this response %u",
864 response->clientResponse->sequenceNumber);
865 OC_LOG_V(DEBUG, TAG, "The maxAge/TTL of this response %u", response->maxAge);
866 OC_LOG_V(DEBUG, TAG, "The response received is %s", bufRes);
869 if(!strcmp((char *)response->rcvdUri, (char *)OC_PRESENCE_URI)){
870 isPresenceNotification = 1;
873 result = OC_STACK_INVALID_PARAM;
876 tok = strtok((char *)bufRes, "[:]}");
877 bufRes[strlen((char *)bufRes)] = ':';
878 tok = strtok(NULL, "[:]}");
879 bufRes[strlen((char *)bufRes)] = ':';
880 response->clientResponse->sequenceNumber = (uint32_t )atoi(tok);
881 OC_LOG_V(DEBUG, TAG, "The received NONCE is %u", response->clientResponse->sequenceNumber);
882 tok = strtok(NULL, "[:]}");
883 response->maxAge = (uint32_t )atoi(tok);
884 OC_LOG_V(DEBUG, TAG, "The received TTL is %u", response->maxAge);
885 tok = strtok(NULL, "[:]}");
888 resourceTypeName = (char *)OCMalloc(strlen(tok));
889 if(!resourceTypeName)
893 bufRes[strlen((char *)bufRes)] = ':';
894 strcpy(resourceTypeName, tok);
895 OC_LOG_V(DEBUG, TAG, "----------------resourceTypeName %s",
898 bufRes[strlen((char *)bufRes)] = ']';
901 // Check if the application subcribed for presence
904 cbNode = GetClientCB(NULL, NULL, response->fullUri);
907 // Check if application subscribed for multicast presence
910 snprintf((char *)response->fullUri, MAX_URI_LENGTH, "%s%s",
911 OC_MULTICAST_IP, response->rcvdUri);
912 cbNode = GetClientCB(NULL, NULL, response->fullUri);
915 isMulticastPresence = 1;
916 isPresenceNotification = 0;
920 if(cbNode && isPresenceNotification)
922 OC_LOG(INFO, TAG, PCF("Received a presence notification"));
923 if(!cbNode->presence)
925 cbNode->presence = (OCPresence *) OCMalloc(sizeof(OCPresence));
926 VERIFY_NON_NULL_V(cbNode->presence);
927 cbNode->presence->timeOut = NULL;
928 cbNode->presence->timeOut = (uint32_t *)
929 OCMalloc(PresenceTimeOutSize * sizeof(uint32_t));
930 if(!(cbNode->presence->timeOut)){
931 OCFree(cbNode->presence);
932 result = OC_STACK_NO_MEMORY;
935 if(response->maxAge == 0)
937 OC_LOG(INFO, TAG, PCF("===============Stopping presence"));
938 response->clientResponse->result = OC_STACK_PRESENCE_STOPPED;
941 OCFree(cbNode->presence->timeOut);
942 OCFree(cbNode->presence);
943 cbNode->presence = NULL;
948 OC_LOG_V(INFO, TAG, "===============Update presence TTL, now time is %d", GetTime(0));
949 cbNode->presence->TTL = response->maxAge;
950 for(int index = 0; index < PresenceTimeOutSize; index++)
952 lowerBound = GetTime(((float)(PresenceTimeOut[index])
953 /(float)100)*(float)cbNode->presence->TTL);
954 higherBound = GetTime(((float)(PresenceTimeOut[index + 1])
955 /(float)100)*(float)cbNode->presence->TTL);
956 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
957 OC_LOG_V(DEBUG, TAG, "----------------lowerBound timeout %d", lowerBound);
958 OC_LOG_V(DEBUG, TAG, "----------------higherBound timeout %d", higherBound);
959 OC_LOG_V(DEBUG, TAG, "----------------timeOut entry %d",
960 cbNode->presence->timeOut[index]);
962 cbNode->presence->TTLlevel = 0;
963 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
964 if(cbNode->sequenceNumber == response->clientResponse->sequenceNumber)
966 OC_LOG(INFO, TAG, PCF("===============No presence change"));
969 OC_LOG(INFO, TAG, PCF("===============Presence changed, calling up the stack"));
970 cbNode->sequenceNumber = response->clientResponse->sequenceNumber;;
973 // Ensure that a filter is actually applied.
974 if(resourceTypeName && cbNode->filterResourceType)
976 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
982 else if(cbNode && isMulticastPresence)
984 // Check if the same nonce for a given host
985 OCMulticastNode* mcNode = NULL;
986 mcNode = GetMCPresenceNode(response->fullUri);
988 if(response->maxAge == 0)
990 OC_LOG(INFO, TAG, PCF("===============Stopping presence"));
991 response->clientResponse->result = OC_STACK_PRESENCE_STOPPED;
994 OCFree(cbNode->presence->timeOut);
995 OCFree(cbNode->presence);
996 cbNode->presence = NULL;
999 else if(mcNode != NULL)
1001 if(mcNode->nonce == response->clientResponse->sequenceNumber)
1003 OC_LOG(INFO, TAG, PCF("===============No presence change (Multicast)"));
1004 result = OC_STACK_NO_MEMORY;
1007 mcNode->nonce = response->clientResponse->sequenceNumber;
1011 uint32_t uriLen = strlen((char*)response->fullUri);
1012 unsigned char* uri = (unsigned char *) OCMalloc(uriLen + 1);
1015 memcpy(uri, response->fullUri, (uriLen + 1));
1020 PCF("===============No Memory for URI to store in the presence node"));
1021 result = OC_STACK_NO_MEMORY;
1024 result = AddMCPresenceNode(&mcNode, (unsigned char*) uri,
1025 response->clientResponse->sequenceNumber);
1026 if(result == OC_STACK_NO_MEMORY)
1029 PCF("===============No Memory for Multicast Presence Node"));
1030 result = OC_STACK_NO_MEMORY;
1035 // Ensure that a filter is actually applied.
1036 if(resourceTypeName && cbNode->filterResourceType)
1038 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1045 else if(!cbNode && isPresenceNotification)
1047 OC_LOG(INFO, TAG, PCF("Received a presence notification, but I do not have callback \
1048 ------------ ignoring"));
1050 #endif // WITH_PRESENCE
1054 if(isObserveNotification)
1056 OC_LOG(INFO, TAG, PCF("Received an observe notification"));
1057 //TODO: check the standard for methods to detect wrap around condition
1058 if(cbNode->method == OC_REST_OBSERVE &&
1059 (response->clientResponse->sequenceNumber <= cbNode->sequenceNumber ||
1060 (response->clientResponse->sequenceNumber > cbNode->sequenceNumber &&
1061 response->clientResponse->sequenceNumber ==
1062 MAX_SEQUENCE_NUMBER)))
1064 OC_LOG_V(DEBUG, TAG, "Observe notification came out of order. \
1065 Ignoring Incoming:%d Against Current:%d.",
1066 response->clientResponse->sequenceNumber, cbNode->sequenceNumber);
1069 if(response->clientResponse->sequenceNumber > cbNode->sequenceNumber){
1070 cbNode->sequenceNumber = response->clientResponse->sequenceNumber;
1074 response->clientResponse->resJSONPayload = bufRes;
1076 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, response->clientResponse);
1078 if (cbResult == OC_STACK_DELETE_TRANSACTION ||
1079 response->clientResponse->result == OC_STACK_COMM_ERROR ||
1080 (response->clientResponse->result == OC_STACK_RESOURCE_DELETED &&
1081 !isPresenceNotification && !isMulticastPresence))
1083 FindAndDeleteClientCB(cbNode);
1088 result = OC_STACK_ERROR;
1092 #ifdef WITH_PRESENCE
1093 OCFree(resourceTypeName);
1098 int ParseIPv4Address(unsigned char * ipAddrStr, uint8_t * ipAddr, uint16_t * port)
1101 unsigned char *itr, *coap;
1102 uint8_t dotCount = 0;
1106 /* search for scheme */
1108 if (!isdigit((unsigned char) *ipAddrStr))
1110 coap = (unsigned char *) OC_COAP_SCHEME;
1111 while (*coap && tolower(*itr) == *coap)
1119 while (*ipAddrStr) {
1120 if (isdigit((unsigned char) *ipAddrStr))
1122 ipAddr[index] *= 10;
1123 ipAddr[index] += *ipAddrStr - '0';
1125 else if ((unsigned char) *ipAddrStr == '.')
1137 if(*ipAddrStr == ':')
1141 if (isdigit((unsigned char) *ipAddrStr))
1144 *port += *ipAddrStr - '0';
1155 if (ipAddr[0] < 255 && ipAddr[1] < 255 && ipAddr[2] < 255 && ipAddr[3] < 255
1166 //-----------------------------------------------------------------------------
1167 // Private internal function prototypes
1168 //-----------------------------------------------------------------------------
1170 static OCDoHandle GenerateInvocationHandle();
1171 static OCStackResult initResources();
1172 static void insertResource(OCResource *resource);
1173 static OCResource *findResource(OCResource *resource);
1174 static void insertResourceType(OCResource *resource,
1175 OCResourceType *resourceType);
1176 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
1178 static void insertResourceInterface(OCResource *resource,
1179 OCResourceInterface *resourceInterface);
1180 static OCResourceInterface *findResourceInterfaceAtIndex(
1181 OCResourceHandle handle, uint8_t index);
1182 static void deleteResourceType(OCResourceType *resourceType);
1183 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
1184 static void deleteResourceElements(OCResource *resource);
1185 static int deleteResource(OCResource *resource);
1186 static void deleteAllResources();
1187 static void incrementSequenceNumber(OCResource * resPtr);
1188 static OCStackResult verifyUriQueryLength(const char * inputUri,
1190 static uint8_t OCIsPacketTransferRequired(const char *request, const char *response, uint16_t size);
1191 OCStackResult getResourceType(const char * query, unsigned char** resourceType);
1193 //-----------------------------------------------------------------------------
1195 //-----------------------------------------------------------------------------
1198 * Initialize the OC Stack. Must be called prior to starting the stack.
1201 * IP Address of host device
1203 * Port of host device
1205 * Host device is client, server, or client-server
1208 * OC_STACK_OK - no errors
1209 * OC_STACK_ERROR - stack init error
1211 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1213 OCStackResult result = OC_STACK_ERROR;
1214 OC_LOG(INFO, TAG, PCF("Entering OCInit"));
1218 OC_LOG_V(INFO, TAG, "IP Address = %s", ipAddr);
1224 //It is ok to select network to CA_WIFI for now
1225 CAResult_t caResult = CASelectNetwork(CA_WIFI|CA_ETHERNET);
1226 if(caResult == CA_STATUS_OK)
1228 OC_LOG(INFO, TAG, PCF("CASelectNetwork to WIFI"));
1229 CARegisterHandler(HandleCARequests, HandleCAResponses);
1231 OC_LOG(INFO, TAG, PCF("CARegisterHandler..."));
1232 stackState = OC_STACK_INITIALIZED;
1233 result = OC_STACK_OK;
1237 caResult = CAStartDiscoveryServer();
1238 OC_LOG(INFO, TAG, PCF("Client mode: CAStartDiscoveryServer"));
1241 caResult = CAStartListeningServer();
1242 OC_LOG(INFO, TAG, PCF("Server mode: CAStartListeningServer"));
1244 case OC_CLIENT_SERVER:
1245 caResult = CAStartListeningServer();
1246 if(caResult == CA_STATUS_OK)
1248 caResult = CAStartDiscoveryServer();
1250 OC_LOG(INFO, TAG, PCF("Client-server mode"));
1253 OC_LOG(ERROR, TAG, PCF("Invalid mode"));
1254 return OC_STACK_ERROR;
1259 if (caResult == CA_STATUS_OK)
1261 result = OC_STACK_OK;
1265 result = OC_STACK_ERROR;
1272 OC_LOG(INFO, TAG, PCF("Client mode"));
1275 OC_LOG(INFO, TAG, PCF("Server mode"));
1277 case OC_CLIENT_SERVER:
1278 OC_LOG(INFO, TAG, PCF("Client-server mode"));
1281 OC_LOG(ERROR, TAG, PCF("Invalid mode"));
1282 return OC_STACK_ERROR;
1286 // Make call to OCCoAP layer
1287 result = OCInitCoAP(ipAddr, (uint16_t) port, myStackMode);
1291 defaultDeviceHandler = NULL;
1293 #ifdef WITH_PRESENCE
1294 PresenceTimeOutSize = sizeof(PresenceTimeOut)/sizeof(PresenceTimeOut[0]) - 1;
1295 #endif // WITH_PRESENCE
1297 if (result == OC_STACK_OK)
1299 stackState = OC_STACK_INITIALIZED;
1301 // Initialize resource
1302 if(result == OC_STACK_OK && myStackMode != OC_CLIENT)
1304 result = initResources();
1306 if(result != OC_STACK_OK)
1308 OC_LOG(ERROR, TAG, PCF("Stack initialization error"));
1314 * Stop the OC stack. Use for a controlled shutdown.
1316 * OC_STACK_OK - no errors
1317 * OC_STACK_ERROR - stack not initialized
1319 OCStackResult OCStop()
1321 OCStackResult result = OC_STACK_ERROR;
1323 OC_LOG(INFO, TAG, PCF("Entering OCStop"));
1325 if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
1327 OC_LOG(DEBUG, TAG, PCF("Stack already stopping, exiting"));
1330 else if (stackState != OC_STACK_INITIALIZED)
1332 OC_LOG(ERROR, TAG, PCF("Stack not initialized"));
1333 return OC_STACK_ERROR;
1336 stackState = OC_STACK_UNINIT_IN_PROGRESS;
1338 #ifdef WITH_PRESENCE
1339 // Ensure that the TTL associated with ANY and ALL presence notifications originating from
1340 // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
1341 presenceResource.presenceTTL = 0;
1342 #endif // WITH_PRESENCE
1344 // Free memory dynamically allocated for resources
1345 deleteAllResources();
1349 //CATerminate does not return any error code. It is OK to assign result to OC_STACK_OK.
1350 result = OC_STACK_OK;
1352 result = OCStopCoAP();
1355 if (result == OC_STACK_OK)
1357 // Remove all observers
1358 DeleteObserverList();
1359 // Remove all the client callbacks
1360 DeleteClientCBList();
1361 stackState = OC_STACK_UNINITIALIZED;
1362 result = OC_STACK_OK;
1364 stackState = OC_STACK_INITIALIZED;
1365 result = OC_STACK_ERROR;
1368 // Deinit security blob
1369 DeinitOCSecurityInfo();
1371 if (result != OC_STACK_OK) {
1372 OC_LOG(ERROR, TAG, PCF("Stack stop error"));
1379 * Map OCQualityOfService to CAMessageType
1381 * @param OCQualityOfService - Input qos.
1383 * Returns CA message type for a given qos.
1385 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
1390 return CA_MSG_CONFIRM;
1395 return CA_MSG_NONCONFIRM;
1400 * Verify the lengths of the URI and the query separately
1402 * @param inputUri - Input URI and query.
1403 * @param uriLen - The length of the initial URI with query.
1405 * Note: The '?' that appears after the URI is not considered as
1406 * a part of the query.
1408 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
1412 query = strchr (inputUri, '?');
1416 if((query - inputUri) > MAX_URI_LENGTH)
1418 return OC_STACK_INVALID_URI;
1421 if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
1423 return OC_STACK_INVALID_QUERY;
1426 else if(uriLen > MAX_URI_LENGTH)
1428 return OC_STACK_INVALID_URI;
1434 * Discover or Perform requests on a specified resource (specified by that Resource's respective URI).
1436 * @param handle - @ref OCDoHandle to refer to the request sent out on behalf of calling this API.
1437 * @param method - @ref OCMethod to perform on the resource
1438 * @param requiredUri - URI of the resource to interact with
1439 * @param referenceUri - URI of the reference resource
1440 * @param request - JSON encoded request
1441 * @param qos - quality of service
1442 * @param cbData - struct that contains asynchronous callback function that is invoked
1443 * by the stack when discovery or resource interaction is complete
1444 * @param options - The address of an array containing the vendor specific header
1445 * header options to be sent with the request
1446 * @param numOptions - Number of vendor specific header options to be included
1449 * OC_STACK_OK - no errors
1450 * OC_STACK_INVALID_CALLBACK - invalid callback function pointer
1451 * OC_STACK_INVALID_METHOD - invalid resource method
1452 * OC_STACK_INVALID_URI - invalid required or reference URI
1454 * Note: IN case of CA, when using multicast, the required URI should not contain IP address.
1455 * Instead, it just contains the URI to the resource such as "/oc/core".
1458 OCStackResult OCDoResource(OCDoHandle *handle, OCMethod method, const char *requiredUri,
1459 const char *referenceUri, const char *request, uint8_t conType,
1460 OCQualityOfService qos, OCCallbackData *cbData,
1461 OCHeaderOption * options, uint8_t numOptions)
1463 OCStackResult OCDoResource(OCDoHandle *handle, OCMethod method, const char *requiredUri,
1464 const char *referenceUri, const char *request,
1465 OCQualityOfService qos, OCCallbackData *cbData,
1466 OCHeaderOption * options, uint8_t numOptions)
1469 OCStackResult result = OC_STACK_ERROR;
1471 ClientCB *clientCB = NULL;
1472 unsigned char * requestUri = NULL;
1473 unsigned char * resourceType = NULL;
1474 unsigned char * query = NULL;
1475 char * newUri = (char *)requiredUri;
1476 (void) referenceUri;
1478 CARemoteEndpoint_t* endpoint = NULL;
1479 CAResult_t caResult;
1480 CAToken_t caToken = NULL;
1481 CAInfo_t requestData;
1482 CARequestInfo_t requestInfo;
1483 CAGroupEndpoint_t grpEnd;
1485 // To track if memory is allocated for additional header options
1486 uint8_t hdrOptionMemAlloc = 0;
1489 OC_LOG(INFO, TAG, PCF("Entering OCDoResource"));
1491 // Validate input parameters
1492 VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
1493 VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
1495 TODO ("Need to form the final query by concatenating require and reference URI's");
1496 VERIFY_NON_NULL(requiredUri, FATAL, OC_STACK_INVALID_URI);
1498 uint16_t uriLen = strlen(requiredUri);
1500 // ToDo: We should also check if the requiredUri has a mutlicast address, then qos has to be OC_Low_QOS
1506 case OC_REST_DELETE:
1507 case OC_REST_OBSERVE:
1508 case OC_REST_OBSERVE_ALL:
1509 case OC_REST_CANCEL_OBSERVE:
1511 #ifdef WITH_PRESENCE
1512 case OC_REST_PRESENCE:
1516 result = OC_STACK_INVALID_METHOD;
1520 if((result = verifyUriQueryLength(requiredUri, uriLen)) != OC_STACK_OK)
1525 if((request) && (strlen(request) > MAX_REQUEST_LENGTH))
1527 result = OC_STACK_INVALID_PARAM;
1531 #ifdef WITH_PRESENCE
1532 if(method == OC_REST_PRESENCE)
1534 result = getQueryFromUri(requiredUri, &query, &newUri);
1537 result = getResourceType((char *) query, &resourceType);
1540 OC_LOG_V(DEBUG, TAG, "Got Resource Type: %s", resourceType);
1544 OC_LOG(DEBUG, TAG, PCF("Resource type is NULL."));
1549 OC_LOG(DEBUG, TAG, PCF("Query string is NULL."));
1551 if(result != OC_STACK_OK)
1556 #endif // WITH_PRESENCE
1558 requestUri = (unsigned char *) OCMalloc(uriLen + 1);
1561 memcpy(requestUri, newUri, (uriLen + 1));
1565 result = OC_STACK_NO_MEMORY;
1569 *handle = GenerateInvocationHandle();
1572 result = OC_STACK_NO_MEMORY;
1577 memset(&requestData, 0, sizeof(CAInfo_t));
1578 memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1579 memset(&grpEnd, 0, sizeof(CAGroupEndpoint_t));
1583 case OC_REST_OBSERVE:
1584 case OC_REST_OBSERVE_ALL:
1585 case OC_REST_CANCEL_OBSERVE:
1587 requestInfo.method = CA_GET;
1592 requestInfo.method = CA_PUT;
1597 requestInfo.method = CA_POST;
1600 case OC_REST_DELETE:
1602 requestInfo.method = CA_DELETE;
1605 #ifdef WITH_PRESENCE
1606 case OC_REST_PRESENCE:
1608 // Replacing method type with GET because "presence"
1609 // is a stack layer only implementation.
1610 requestInfo.method = CA_GET;
1615 result = OC_STACK_INVALID_METHOD;
1619 //High QoS is not supported
1620 if(qos == OC_HIGH_QOS)
1622 result = OC_STACK_INVALID_PARAM;
1627 caResult = CAGenerateToken(&caToken);
1629 //TODO-CA Remove this temporary fix (for some reason same token is being generated)
1630 static int count = 0;
1632 caToken[0] += count;
1634 if (caResult != CA_STATUS_OK)
1636 OC_LOG(ERROR, TAG, PCF("CAGenerateToken error"));
1641 requestData.type = qualityOfServiceToMessageType(qos);
1642 requestData.token = caToken;
1643 if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
1645 result = CreateObserveHeaderOption (&(requestData.options), options,
1646 numOptions, OC_OBSERVE_REGISTER);
1647 if (result != OC_STACK_OK)
1651 hdrOptionMemAlloc = 1;
1652 requestData.numOptions = numOptions + 1;
1656 requestData.options = (CAHeaderOption_t*)options;
1657 requestData.numOptions = numOptions;
1659 requestData.payload = (char *)request;
1661 requestInfo.info = requestData;
1663 CAConnectivityType_t caConType;
1665 result = OCToCAConnectivityType(conType, &caConType);
1666 if (result != OC_STACK_OK)
1668 OC_LOG(ERROR, TAG, PCF("Invalid Connectivity Type"));
1673 if(conType == OC_ALL)
1675 grpEnd.connectivityType = caConType;
1677 grpEnd.resourceUri = (CAURI_t) OCMalloc(uriLen + 1);
1678 strncpy(grpEnd.resourceUri, requiredUri, (uriLen + 1));
1680 caResult = CASendRequestToAll(&grpEnd, &requestInfo);
1684 caResult = CACreateRemoteEndpoint(newUri, caConType, &endpoint);
1686 if (caResult != CA_STATUS_OK)
1688 OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1692 caResult = CASendRequest(endpoint, &requestInfo);
1695 if (caResult != CA_STATUS_OK)
1697 OC_LOG(ERROR, TAG, PCF("CASendRequest"));
1701 if((result = AddClientCB(&clientCB, cbData, &caToken, handle, method,
1702 requestUri, resourceType)) != OC_STACK_OK)
1704 result = OC_STACK_NO_MEMORY;
1710 // Generate token which will be used by OCStack to match responses received
1712 OCGenerateCoAPToken(&token);
1714 if((result = AddClientCB(&clientCB, cbData, &token, handle, method, requestUri, resourceType))
1717 result = OC_STACK_NO_MEMORY;
1721 // Make call to OCCoAP layer
1722 result = OCDoCoAPResource(method, qos, &token, newUri, request, options, numOptions);
1726 if(newUri != requiredUri)
1730 if (result != OC_STACK_OK)
1732 OC_LOG(ERROR, TAG, PCF("OCDoResource error"));
1733 FindAndDeleteClientCB(clientCB);
1736 CADestroyRemoteEndpoint(endpoint);
1737 OCFree(grpEnd.resourceUri);
1738 if (hdrOptionMemAlloc)
1740 OCFree(requestData.options);
1747 * Cancel a request associated with a specific @ref OCDoResource invocation.
1749 * @param handle - Used to identify a specific OCDoResource invocation.
1750 * @param qos - used to specify Quality of Service (read below for more info)
1751 * @param options- used to specify vendor specific header options when sending
1752 * explicit observe cancellation
1753 * @param numOptions- Number of header options to be included
1756 * OC_STACK_OK - No errors; Success
1757 * OC_STACK_INVALID_PARAM - The handle provided is invalid.
1759 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
1763 * This ftn is implemented one of two ways in the case of observation:
1765 * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
1766 * Remove the callback associated on client side.
1767 * When the next notification comes in from server,
1768 * reply with RESET message to server.
1769 * Keep in mind that the server will react to RESET only
1770 * if the last notification was sent ans CON
1772 * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
1773 * and it is associated with an observe request
1774 * (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
1775 * Send CON Observe request to server with
1776 * observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
1777 * Remove the callback associated on client side.
1779 OCStackResult ret = OC_STACK_OK;
1781 CARemoteEndpoint_t* endpoint = NULL;
1782 CAResult_t caResult;
1783 CAInfo_t requestData;
1784 CARequestInfo_t requestInfo;
1785 // Track if memory is allocated for additional header options
1786 uint8_t hdrOptionMemAlloc = 0;
1790 return OC_STACK_INVALID_PARAM;
1793 OC_LOG(INFO, TAG, PCF("Entering OCCancel"));
1795 ClientCB *clientCB = GetClientCB(NULL, handle, NULL);
1798 switch (clientCB->method)
1800 case OC_REST_OBSERVE:
1801 case OC_REST_OBSERVE_ALL:
1803 //TODO-CA : Why CA_WIFI alone?
1804 caResult = CACreateRemoteEndpoint((char *)clientCB->requestUri, CA_WIFI,
1806 if (caResult != CA_STATUS_OK)
1808 OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1809 return OC_STACK_ERROR;
1812 memset(&requestData, 0, sizeof(CAInfo_t));
1813 requestData.type = qualityOfServiceToMessageType(qos);
1814 requestData.token = clientCB->token;
1815 if (CreateObserveHeaderOption (&(requestData.options),
1816 options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
1818 return OC_STACK_ERROR;
1820 hdrOptionMemAlloc = 1;
1821 requestData.numOptions = numOptions + 1;
1822 memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1823 requestInfo.method = CA_GET;
1824 requestInfo.info = requestData;
1826 caResult = CASendRequest(endpoint, &requestInfo);
1827 if (caResult != CA_STATUS_OK)
1829 OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
1831 if(caResult == CA_STATUS_OK)
1836 if(qos == OC_HIGH_QOS)
1838 ret = OCDoCoAPResource(OC_REST_CANCEL_OBSERVE, qos,
1839 &(clientCB->token), (const char *) clientCB->requestUri, NULL, options,
1844 FindAndDeleteClientCB(clientCB);
1848 #ifdef WITH_PRESENCE
1849 case OC_REST_PRESENCE:
1850 FindAndDeleteClientCB(clientCB);
1854 return OC_STACK_INVALID_METHOD;
1858 CADestroyRemoteEndpoint(endpoint);
1859 if (hdrOptionMemAlloc)
1861 OCFree(requestData.options);
1868 #ifdef WITH_PRESENCE
1870 OCStackResult OCProcessPresence()
1872 OCStackResult result = OC_STACK_OK;
1873 uint8_t ipAddr[4] = { 0 };
1876 OC_LOG(INFO, TAG, PCF("Entering RequestPresence"));
1877 ClientCB* cbNode = NULL;
1879 OCClientResponse clientResponse;
1880 OCResponse * response = NULL;
1881 OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
1883 LL_FOREACH(cbList, cbNode) {
1884 if(OC_REST_PRESENCE == cbNode->method)
1886 if(cbNode->presence)
1888 uint32_t now = GetTime(0);
1889 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d",
1890 cbNode->presence->TTLlevel);
1891 OC_LOG_V(DEBUG, TAG, "----------------current ticks %d", now);
1894 if(cbNode->presence->TTLlevel >= (PresenceTimeOutSize + 1))
1899 if(cbNode->presence->TTLlevel < PresenceTimeOutSize){
1900 OC_LOG_V(DEBUG, TAG, "----------------timeout ticks %d",
1901 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
1904 if(cbNode->presence->TTLlevel >= PresenceTimeOutSize)
1906 OC_LOG(DEBUG, TAG, PCF("----------------No more timeout ticks"));
1907 if (ParseIPv4Address( cbNode->requestUri, ipAddr, &port))
1909 OCBuildIPv4Address(ipAddr[0], ipAddr[1], ipAddr[2], ipAddr[3], port,
1911 result = FormOCClientResponse(&clientResponse, OC_STACK_PRESENCE_TIMEOUT,
1912 (OCDevAddr *) &dst, 0, NULL);
1913 if(result != OC_STACK_OK)
1917 result = FormOCResponse(&response, cbNode, 0, NULL, NULL,
1918 &cbNode->token, &clientResponse, NULL);
1919 if(result != OC_STACK_OK)
1924 // Increment the TTLLevel (going to a next state), so we don't keep
1925 // sending presence notification to client.
1926 cbNode->presence->TTLlevel++;
1927 OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
1928 cbNode->presence->TTLlevel);
1932 result = OC_STACK_INVALID_IP;
1936 cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
1937 if (cbResult == OC_STACK_DELETE_TRANSACTION)
1939 FindAndDeleteClientCB(cbNode);
1943 if(now >= cbNode->presence->timeOut[cbNode->presence->TTLlevel])
1945 CAResult_t caResult;
1946 CARemoteEndpoint_t* endpoint = NULL;
1947 CAInfo_t requestData;
1948 CARequestInfo_t requestInfo;
1950 OC_LOG(DEBUG, TAG, PCF("time to test server presence =========="));
1952 //TODO-CA : Why CA_WIFI alone?
1953 caResult = CACreateRemoteEndpoint((char *)cbNode->requestUri, CA_WIFI,
1956 if (caResult != CA_STATUS_OK)
1958 OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1962 memset(&requestData, 0, sizeof(CAInfo_t));
1963 requestData.type = CA_MSG_NONCONFIRM;
1964 requestData.token = cbNode->token;
1966 memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1967 requestInfo.method = CA_GET;
1968 requestInfo.info = requestData;
1970 caResult = CASendRequest(endpoint, &requestInfo);
1972 if (caResult != CA_STATUS_OK)
1974 OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
1978 cbNode->presence->TTLlevel++;
1979 OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
1980 cbNode->presence->TTLlevel);
1986 if (result != OC_STACK_OK)
1988 OC_LOG(ERROR, TAG, PCF("OCProcessPresence error"));
1993 OCStackResult OCProcessPresence()
1995 OCStackResult result = OC_STACK_OK;
1996 uint8_t ipAddr[4] = { 0 };
1999 ClientCB* cbNode = NULL;
2001 OCClientResponse clientResponse;
2002 OCResponse * response = NULL;
2004 LL_FOREACH(cbList, cbNode) {
2005 if(OC_REST_PRESENCE == cbNode->method)
2007 if(cbNode->presence)
2009 uint32_t now = GetTime(0);
2010 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
2011 OC_LOG_V(DEBUG, TAG, "----------------current ticks %d", now);
2014 if(cbNode->presence->TTLlevel >= (PresenceTimeOutSize + 1))
2019 if(cbNode->presence->TTLlevel < PresenceTimeOutSize){
2020 OC_LOG_V(DEBUG, TAG, "----------------timeout ticks %d",
2021 cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2024 if(cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2026 OC_LOG(DEBUG, TAG, PCF("----------------No more timeout ticks"));
2027 if (ParseIPv4Address( cbNode->requestUri, ipAddr, &port))
2029 OCBuildIPv4Address(ipAddr[0], ipAddr[1], ipAddr[2], ipAddr[3], port,
2031 result = FormOCClientResponse(&clientResponse, OC_STACK_PRESENCE_TIMEOUT,
2032 (OCDevAddr *) &dst, 0, NULL);
2033 if(result != OC_STACK_OK)
2037 result = FormOCResponse(&response, cbNode, 0, NULL, NULL,
2038 &cbNode->token, &clientResponse, NULL);
2039 if(result != OC_STACK_OK)
2044 // Increment the TTLLevel (going to a next state), so we don't keep
2045 // sending presence notification to client.
2046 cbNode->presence->TTLlevel++;
2047 OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
2048 cbNode->presence->TTLlevel);
2052 result = OC_STACK_INVALID_IP;
2055 HandleStackResponses(response);
2057 if(now >= cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2059 OC_LOG(DEBUG, TAG, PCF("time to test server presence =========="));
2062 OCGenerateCoAPToken(&token);
2063 result = OCDoCoAPResource(OC_REST_GET, OC_LOW_QOS,
2064 &token, (const char *)cbNode->requestUri, NULL, NULL, 0);
2066 if(result != OC_STACK_OK)
2070 cbNode->presence->TTLlevel++;
2071 OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d", cbNode->presence->TTLlevel);
2077 if (result != OC_STACK_OK)
2079 OC_LOG(ERROR, TAG, PCF("OCProcessPresence error"));
2084 #endif // WITH_PRESENCE
2087 * Called in main loop of OC client or server. Allows low-level processing of
2091 * OC_STACK_OK - no errors
2092 * OC_STACK_ERROR - stack process error
2094 OCStackResult OCProcess()
2096 #ifdef WITH_PRESENCE
2097 OCProcessPresence();
2100 CAHandleRequestResponse();
2108 #ifdef WITH_PRESENCE
2110 * When operating in @ref OCServer or @ref OCClientServer mode, this API will start sending out
2111 * presence notifications to clients via multicast. Once this API has been called with a success,
2112 * clients may query for this server's presence and this server's stack will respond via multicast.
2114 * Server can call this function when it comes online for the first time, or when it comes back
2115 * online from offline mode, or when it re enters network.
2117 * @param ttl - Time To Live in seconds
2118 * Note: If ttl is '0', then the default stack value will be used (60 Seconds).
2121 * OC_STACK_OK - No errors; Success
2123 OCStackResult OCStartPresence(const uint32_t ttl)
2125 OCChangeResourceProperty(
2126 &(((OCResource *)presenceResource.handle)->resourceProperties),
2131 presenceResource.presenceTTL = ttl;
2134 if(OC_PRESENCE_UNINITIALIZED == presenceState)
2136 OCDevAddr multiCastAddr;
2139 presenceState = OC_PRESENCE_INITIALIZED;
2140 OCGenerateCoAPToken(&token);
2141 OCBuildIPv4Address(224, 0, 1, 187, 5683, &multiCastAddr);
2143 CAAddress_t addressInfo;
2144 strncpy(addressInfo.IP.ipAddress, "224.0.1.187", CA_IPADDR_SIZE);
2145 addressInfo.IP.port = 5298;
2147 CAToken_t caToken = NULL;
2148 CAGenerateToken(&caToken);
2150 AddCAObserver(OC_PRESENCE_URI, NULL, 0, &token,
2151 &multiCastAddr, (OCResource *)presenceResource.handle, OC_LOW_QOS,
2152 &addressInfo, CA_WIFI, caToken);
2154 //add the presence observer
2155 AddObserver(OC_PRESENCE_URI, NULL, 0, &token, &multiCastAddr,
2156 (OCResource *)presenceResource.handle, OC_LOW_QOS);
2160 // Each time OCStartPresence is called
2161 // a different random 32-bit integer number is used
2162 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2164 return SendPresenceNotification(NULL);
2168 * When operating in @ref OCServer or @ref OCClientServer mode, this API will stop sending out
2169 * presence notifications to clients via multicast. Once this API has been called with a success,
2170 * this server's stack will not respond to clients querying for this server's presence.
2172 * Server can call this function when it is terminating, going offline, or when going
2173 * away from network.
2176 * OC_STACK_OK - No errors; Success
2178 OCStackResult OCStopPresence()
2180 OCStackResult result = OC_STACK_ERROR;
2181 //make resource inactive
2182 result = OCChangeResourceProperty(
2183 &(((OCResource *) presenceResource.handle)->resourceProperties),
2185 result = SendPresenceNotification(NULL);
2192 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler)
2194 defaultDeviceHandler = entityHandler;
2199 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
2201 OC_LOG(INFO, TAG, PCF("Entering OCSetDeviceInfo"));
2203 if(myStackMode == OC_CLIENT)
2205 return OC_STACK_ERROR;
2208 return SaveDeviceInfo(deviceInfo);
2214 * @param handle - pointer to handle to newly created resource. Set by ocstack. Used to refer to resource
2215 * @param resourceTypeName - name of resource type. Example: "core.led"
2216 * @param resourceInterfaceName - name of resource interface. Example: "core.rw"
2217 * @param uri - URI of the resource. Example: "/a/led"
2218 * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2219 * NULL for default entity handler
2220 * @param resourceProperties - properties supported by resource. Example: OC_DISCOVERABLE|OC_OBSERVABLE
2223 * OC_STACK_OK - no errors
2224 * OC_STACK_ERROR - stack process error
2226 OCStackResult OCCreateResource(OCResourceHandle *handle,
2227 const char *resourceTypeName,
2228 const char *resourceInterfaceName,
2229 const char *uri, OCEntityHandler entityHandler,
2230 uint8_t resourceProperties) {
2232 OCResource *pointer = NULL;
2235 OCStackResult result = OC_STACK_ERROR;
2237 OC_LOG(INFO, TAG, PCF("Entering OCCreateResource"));
2239 if(myStackMode == OC_CLIENT)
2243 // Validate parameters
2244 if(!uri || (strlen(uri) == 0))
2246 OC_LOG(ERROR, TAG, PCF("URI is invalid"));
2247 return OC_STACK_INVALID_URI;
2249 // Is it presented during resource discovery?
2250 if (!handle || !resourceTypeName) {
2251 OC_LOG(ERROR, TAG, PCF("Input parameter is NULL"));
2252 return OC_STACK_INVALID_PARAM;
2255 if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0) {
2256 resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
2259 // Make sure resourceProperties bitmask has allowed properties specified
2260 if (resourceProperties
2261 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE)) {
2262 OC_LOG(ERROR, TAG, PCF("Invalid property"));
2263 return OC_STACK_INVALID_PARAM;
2266 // If the headResource is NULL, then no resources have been created...
2267 pointer = headResource;
2269 // At least one resources is in the resource list, so we need to search for
2270 // repeated URLs, which are not allowed. If a repeat is found, exit with an error
2272 if (strcmp(uri, pointer->uri) == 0) {
2273 OC_LOG(ERROR, TAG, PCF("URI already in use"));
2274 return OC_STACK_INVALID_PARAM;
2276 pointer = pointer->next;
2279 // Create the pointer and insert it into the resource list
2280 pointer = (OCResource *) OCCalloc(1, sizeof(OCResource));
2284 pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
2286 insertResource(pointer);
2289 size = strlen(uri) + 1;
2290 str = (char *) OCMalloc(size);
2294 strncpy(str, uri, size);
2297 // Set properties. Set OC_ACTIVE
2298 pointer->resourceProperties = (OCResourceProperty) (resourceProperties
2301 // Add the resourcetype to the resource
2302 result = BindResourceTypeToResource(pointer, resourceTypeName);
2303 if (result != OC_STACK_OK) {
2304 OC_LOG(ERROR, TAG, PCF("Error adding resourcetype"));
2308 // Add the resourceinterface to the resource
2309 result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
2310 if (result != OC_STACK_OK) {
2311 OC_LOG(ERROR, TAG, PCF("Error adding resourceinterface"));
2315 // If an entity handler has been passed, attach it to the newly created
2316 // resource. Otherwise, set the default entity handler.
2319 pointer->entityHandler = entityHandler;
2323 pointer->entityHandler = defaultResourceEHandler;
2327 result = OC_STACK_OK;
2329 #ifdef WITH_PRESENCE
2330 if(presenceResource.handle)
2332 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2333 SendPresenceNotification(pointer->rsrcType);
2337 if (result != OC_STACK_OK)
2339 // Deep delete of resource and other dynamic elements that it contains
2340 deleteResource(pointer);
2349 * Create a resource. with host ip address for remote resource
2351 * @param handle - pointer to handle to newly created resource. Set by ocstack.
2352 * Used to refer to resource
2353 * @param resourceTypeName - name of resource type. Example: "core.led"
2354 * @param resourceInterfaceName - name of resource interface. Example: "core.rw"
2355 * @param host - HOST address of the remote resource. Example: "coap://xxx.xxx.xxx.xxx:xxxxx"
2356 * @param uri - URI of the resource. Example: "/a/led"
2357 * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2358 * NULL for default entity handler
2359 * @param resourceProperties - properties supported by resource.
2360 * Example: OC_DISCOVERABLE|OC_OBSERVABLE
2363 * OC_STACK_OK - no errors
2364 * OC_STACK_ERROR - stack process error
2367 OCStackResult OCCreateResourceWithHost(OCResourceHandle *handle,
2368 const char *resourceTypeName,
2369 const char *resourceInterfaceName,
2372 OCEntityHandler entityHandler,
2373 uint8_t resourceProperties)
2377 OCStackResult result = OC_STACK_ERROR;
2379 result = OCCreateResource(handle, resourceTypeName, resourceInterfaceName,
2380 uri, entityHandler, resourceProperties);
2382 if (result != OC_STACK_ERROR)
2385 size = strlen(host) + 1;
2386 str = (char *) OCMalloc(size);
2389 return OC_STACK_ERROR;
2391 strncpy(str, host, size);
2392 ((OCResource *) *handle)->host = str;
2399 * Add a resource to a collection resource.
2401 * @param collectionHandle - handle to the collection resource
2402 * @param resourceHandle - handle to resource to be added to the collection resource
2405 * OC_STACK_OK - no errors
2406 * OC_STACK_ERROR - stack process error
2407 * OC_STACK_INVALID_PARAM - invalid collectionhandle
2409 OCStackResult OCBindResource(
2410 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle) {
2411 OCResource *resource;
2414 OC_LOG(INFO, TAG, PCF("Entering OCBindResource"));
2416 // Validate parameters
2417 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
2418 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
2419 // Container cannot contain itself
2420 if (collectionHandle == resourceHandle) {
2421 OC_LOG(ERROR, TAG, PCF("Added handle equals collection handle"));
2422 return OC_STACK_INVALID_PARAM;
2425 // Use the handle to find the resource in the resource linked list
2426 resource = findResource((OCResource *) collectionHandle);
2428 OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
2429 return OC_STACK_INVALID_PARAM;
2432 // Look for an open slot to add add the child resource.
2433 // If found, add it and return success
2434 for (i = 0; i < MAX_CONTAINED_RESOURCES; i++) {
2435 if (!resource->rsrcResources[i]) {
2436 resource->rsrcResources[i] = (OCResource *) resourceHandle;
2437 OC_LOG(INFO, TAG, PCF("resource bound"));
2442 #ifdef WITH_PRESENCE
2443 if(presenceResource.handle)
2445 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2446 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType);
2450 // Unable to add resourceHandle, so return error
2451 return OC_STACK_ERROR;
2455 * Remove a resource from a collection resource.
2457 * @param collectionHandle - handle to the collection resource
2458 * @param resourceHandle - handle to resource to be added to the collection resource
2461 * OC_STACK_OK - no errors
2462 * OC_STACK_ERROR - stack process error
2463 * OC_STACK_INVALID_PARAM - invalid collectionHandle
2465 OCStackResult OCUnBindResource(
2466 OCResourceHandle collectionHandle, OCResourceHandle resourceHandle) {
2467 OCResource *resource;
2470 OC_LOG(INFO, TAG, PCF("Entering OCUnBindResource"));
2472 // Validate parameters
2473 VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
2474 VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
2475 // Container cannot contain itself
2476 if (collectionHandle == resourceHandle) {
2477 OC_LOG(ERROR, TAG, PCF("removing handle equals collection handle"));
2478 return OC_STACK_INVALID_PARAM;
2481 // Use the handle to find the resource in the resource linked list
2482 resource = findResource((OCResource *) collectionHandle);
2484 OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
2485 return OC_STACK_INVALID_PARAM;
2488 // Look for an open slot to add add the child resource.
2489 // If found, add it and return success
2490 for (i = 0; i < MAX_CONTAINED_RESOURCES; i++) {
2491 if (resourceHandle == resource->rsrcResources[i]) {
2492 resource->rsrcResources[i] = (OCResource *) NULL;
2493 OC_LOG(INFO, TAG, PCF("resource unbound"));
2498 OC_LOG(INFO, TAG, PCF("resource not found in collection"));
2500 #ifdef WITH_PRESENCE
2501 if(presenceResource.handle)
2503 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2504 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType);
2508 // Unable to add resourceHandle, so return error
2509 return OC_STACK_ERROR;
2512 OCStackResult BindResourceTypeToResource(OCResource* resource,
2513 const char *resourceTypeName)
2515 OCResourceType *pointer = NULL;
2518 OCStackResult result = OC_STACK_ERROR;
2520 OC_LOG(INFO, TAG, PCF("Entering BindResourceTypeToResource"));
2522 // Validate parameters
2523 VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
2524 // TODO: Does resource attribute resentation really have to be maintained in stack?
2525 // Is it presented during resource discovery?
2527 TODO ("Make sure that the resourcetypename doesn't already exist in the resource");
2529 // Create the resourcetype and insert it into the resource list
2530 pointer = (OCResourceType *) OCCalloc(1, sizeof(OCResourceType));
2535 // Set the resourceTypeName
2536 size = strlen(resourceTypeName) + 1;
2537 str = (char *) OCMalloc(size);
2541 strncpy(str, resourceTypeName, size);
2542 pointer->resourcetypename = str;
2544 insertResourceType(resource, pointer);
2545 result = OC_STACK_OK;
2547 exit: if (result != OC_STACK_OK) {
2555 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
2556 const char *resourceInterfaceName)
2558 OCResourceInterface *pointer = NULL;
2561 OCStackResult result = OC_STACK_ERROR;
2563 OC_LOG(INFO, TAG, PCF("Entering BindResourceInterfaceToResource"));
2565 // Validate parameters
2566 VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
2568 TODO ("Make sure that the resourceinterface name doesn't already exist in the resource");
2570 // Create the resourceinterface and insert it into the resource list
2571 pointer = (OCResourceInterface *) OCCalloc(1, sizeof(OCResourceInterface));
2576 // Set the resourceinterface name
2577 size = strlen(resourceInterfaceName) + 1;
2578 str = (char *) OCMalloc(size);
2582 strncpy(str, resourceInterfaceName, size);
2583 pointer->name = str;
2585 // Bind the resourceinterface to the resource
2586 insertResourceInterface(resource, pointer);
2588 result = OC_STACK_OK;
2590 exit: if (result != OC_STACK_OK) {
2599 * Bind a resourcetype to a resource.
2601 * @param handle - handle to the resource
2602 * @param resourceTypeName - name of resource type. Example: "core.led"
2605 * OC_STACK_OK - no errors
2606 * OC_STACK_ERROR - stack process error
2608 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
2609 const char *resourceTypeName) {
2611 OCStackResult result = OC_STACK_ERROR;
2612 OCResource *resource;
2614 // Make sure resource exists
2615 resource = findResource((OCResource *) handle);
2617 OC_LOG(ERROR, TAG, PCF("Resource not found"));
2618 return OC_STACK_ERROR;
2621 // call internal function
2622 result = BindResourceTypeToResource(resource, resourceTypeName);
2624 #ifdef WITH_PRESENCE
2625 if(presenceResource.handle)
2627 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2628 SendPresenceNotification(resource->rsrcType);
2636 * Bind a resourceinterface to a resource.
2638 * @param handle - handle to the resource
2639 * @param resourceInterfaceName - name of resource interface. Example: "oc.mi.b"
2642 * OC_STACK_OK - no errors
2643 * OC_STACK_ERROR - stack process error
2646 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
2647 const char *resourceInterfaceName) {
2649 OCStackResult result = OC_STACK_ERROR;
2650 OCResource *resource;
2652 // Make sure resource exists
2653 resource = findResource((OCResource *) handle);
2655 OC_LOG(ERROR, TAG, PCF("Resource not found"));
2656 return OC_STACK_ERROR;
2659 // call internal function
2660 result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
2662 #ifdef WITH_PRESENCE
2663 if(presenceResource.handle)
2665 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2666 SendPresenceNotification(resource->rsrcType);
2674 * Get the number of resources that have been created in the stack.
2676 * @param numResources - pointer to count variable
2679 * OC_STACK_OK - no errors
2680 * OC_STACK_ERROR - stack process error
2683 OCStackResult OCGetNumberOfResources(uint8_t *numResources) {
2684 OCResource *pointer = headResource;
2686 OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResources"));
2687 VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
2690 *numResources = *numResources + 1;
2691 pointer = pointer->next;
2697 * Get a resource handle by index.
2699 * @param index - index of resource, 0 to Count - 1
2702 * Resource handle - if found
2703 * NULL - if not found
2705 OCResourceHandle OCGetResourceHandle(uint8_t index) {
2706 OCResource *pointer = headResource;
2709 OC_LOG(INFO, TAG, PCF("Entering OCGetResourceHandle"));
2711 // Iterate through the list
2712 while ((i < index) && pointer) {
2714 pointer = pointer->next;
2716 return (OCResourceHandle) pointer;
2720 * Delete resource specified by handle. Deletes resource and all resourcetype and resourceinterface
2723 * @param handle - handle of resource to be deleted
2726 * OC_STACK_OK - no errors
2727 * OC_STACK_ERROR - stack process error
2728 * OC_STACK_NO_RESOURCE - resource not found
2729 * OC_STACK_INVALID_PARAM - invalid param
2731 OCStackResult OCDeleteResource(OCResourceHandle handle) {
2732 OC_LOG(INFO, TAG, PCF("Entering OCDeleteResource"));
2735 OC_LOG(ERROR, TAG, PCF("Invalid param"));
2736 return OC_STACK_INVALID_PARAM;
2739 OCResource *resource = findResource((OCResource *) handle);
2740 if (resource == NULL) {
2741 OC_LOG(ERROR, TAG, PCF("Resource not found"));
2742 return OC_STACK_NO_RESOURCE;
2745 if (deleteResource((OCResource *) handle) == 0) {
2746 OC_LOG(ERROR, TAG, PCF("Error deleting resource"));
2747 return OC_STACK_ERROR;
2754 * Get the URI of the resource specified by handle.
2756 * @param handle - handle of resource
2758 * URI string - if resource found
2759 * NULL - resource not found
2761 const char *OCGetResourceUri(OCResourceHandle handle) {
2762 OCResource *resource;
2763 OC_LOG(INFO, TAG, PCF("Entering OCGetResourceUri"));
2765 resource = findResource((OCResource *) handle);
2767 return resource->uri;
2769 return (const char *) NULL;
2773 * Get the properties of the resource specified by handle.
2774 * NOTE: that after a resource is created, the OC_ACTIVE property is set
2775 * for the resource by the stack.
2777 * @param handle - handle of resource
2779 * property bitmap - if resource found
2780 * NULL - resource not found
2782 uint8_t OCGetResourceProperties(OCResourceHandle handle) {
2783 OCResource *resource;
2784 OC_LOG(INFO, TAG, PCF("Entering OCGetResourceProperties"));
2786 resource = findResource((OCResource *) handle);
2788 return resource->resourceProperties;
2794 * Get the number of resource types of the resource.
2796 * @param handle - handle of resource
2797 * @param numResourceTypes - pointer to count variable
2800 * OC_STACK_OK - no errors
2801 * OC_STACK_ERROR - stack process error
2803 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
2804 uint8_t *numResourceTypes) {
2805 OCResource *resource;
2806 OCResourceType *pointer;
2808 OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResourceTypes"));
2809 VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
2810 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2812 *numResourceTypes = 0;
2814 resource = findResource((OCResource *) handle);
2816 pointer = resource->rsrcType;
2818 *numResourceTypes = *numResourceTypes + 1;
2819 pointer = pointer->next;
2826 * Get name of resource type of the resource.
2828 * @param handle - handle of resource
2829 * @param index - index of resource, 0 to Count - 1
2832 * resource type name - if resource found
2833 * NULL - resource not found
2835 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index) {
2836 OCResourceType *resourceType;
2838 OC_LOG(INFO, TAG, PCF("Entering OCGetResourceTypeName"));
2840 resourceType = findResourceTypeAtIndex(handle, index);
2842 return resourceType->resourcetypename;
2844 return (const char *) NULL;
2850 * Get the number of resource interfaces of the resource.
2852 * @param handle - handle of resource
2853 * @param numResources - pointer to count variable
2856 * OC_STACK_OK - no errors
2857 * OC_STACK_ERROR - stack process error
2859 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
2860 uint8_t *numResourceInterfaces) {
2861 OCResourceInterface *pointer;
2862 OCResource *resource;
2864 OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResourceInterfaces"));
2866 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2867 VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
2869 *numResourceInterfaces = 0;
2870 resource = findResource((OCResource *) handle);
2872 pointer = resource->rsrcInterface;
2874 *numResourceInterfaces = *numResourceInterfaces + 1;
2875 pointer = pointer->next;
2882 * Get name of resource interface of the resource.
2884 * @param handle - handle of resource
2885 * @param index - index of resource, 0 to Count - 1
2888 * resource interface name - if resource found
2889 * NULL - resource not found
2891 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index) {
2892 OCResourceInterface *resourceInterface;
2894 OC_LOG(INFO, TAG, PCF("Entering OCGetResourceInterfaceName"));
2896 resourceInterface = findResourceInterfaceAtIndex(handle, index);
2897 if (resourceInterface) {
2898 return resourceInterface->name;
2900 return (const char *) NULL;
2904 * Get resource handle from the collection resource by index.
2906 * @param collectionHandle - handle of collection resource
2907 * @param index - index of contained resource, 0 to Count - 1
2910 * handle to resource - if resource found
2911 * NULL - resource not found
2913 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
2915 OCResource *resource;
2917 OC_LOG(INFO, TAG, PCF("Entering OCGetContainedResource"));
2919 if (index >= MAX_CONTAINED_RESOURCES) {
2923 resource = findResource((OCResource *) collectionHandle);
2928 return resource->rsrcResources[index];
2932 * Bind an entity handler to the resource.
2934 * @param handle - handle to the resource that the contained resource is to be bound
2935 * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2937 * OC_STACK_OK - no errors
2938 * OC_STACK_ERROR - stack process error
2940 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
2941 OCEntityHandler entityHandler) {
2942 OCResource *resource;
2944 OC_LOG(INFO, TAG, PCF("Entering OCBindResourceHandler"));
2946 // Validate parameters
2947 VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2948 //VERIFY_NON_NULL(entityHandler, ERROR, OC_STACK_INVALID_PARAM);
2950 // Use the handle to find the resource in the resource linked list
2951 resource = findResource((OCResource *)handle);
2953 OC_LOG(ERROR, TAG, PCF("Resource not found"));
2954 return OC_STACK_ERROR;
2958 resource->entityHandler = entityHandler;
2960 #ifdef WITH_PRESENCE
2961 if(presenceResource.handle)
2963 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2964 SendPresenceNotification(resource->rsrcType);
2972 * Get the entity handler for a resource.
2974 * @param handle - handle of resource
2977 * entity handler - if resource found
2978 * NULL - resource not found
2980 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle) {
2981 OCResource *resource;
2983 OC_LOG(INFO, TAG, PCF("Entering OCGetResourceHandler"));
2985 // Use the handle to find the resource in the resource linked list
2986 resource = findResource((OCResource *)handle);
2988 OC_LOG(ERROR, TAG, PCF("Resource not found"));
2993 return resource->entityHandler;
2996 void incrementSequenceNumber(OCResource * resPtr)
2998 // Increment the sequence number
2999 resPtr->sequenceNum += 1;
3000 if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3002 resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3008 * Notify Presence subscribers that a resource has been modified
3010 * @param resourceType - Handle to the resourceType linked list of resource
3011 * that was modified.
3012 * @param qos - Quality Of Service
3015 #ifdef WITH_PRESENCE
3016 OCStackResult SendPresenceNotification(OCResourceType *resourceType)
3018 OCResource *resPtr = NULL;
3019 OCStackResult result;
3020 OCMethod method = OC_REST_PRESENCE;
3021 uint32_t maxAge = 0;
3022 resPtr = findResource((OCResource *) presenceResource.handle);
3025 return OC_STACK_NO_RESOURCE;
3027 if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3029 maxAge = presenceResource.presenceTTL;
3036 result = SendAllObserverNotification(method, resPtr, maxAge, resourceType, OC_LOW_QOS);
3040 #endif // WITH_PRESENCE
3042 * Notify observers that an observed value has changed.
3044 * @param handle - handle of resource
3047 * OC_STACK_OK - no errors
3048 * OC_STACK_NO_RESOURCE - invalid resource handle
3049 * OC_STACK_NO_OBSERVERS - no more observers intrested in resource
3051 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos) {
3053 OC_LOG(INFO, TAG, PCF("Entering OCNotifyAllObservers"));
3055 OCResource *resPtr = NULL;
3056 OCStackResult result;
3057 OCMethod method = OC_REST_NOMETHOD;
3058 uint32_t maxAge = 0;
3060 OC_LOG(INFO, TAG, PCF("Entering OCNotifyAllObservers"));
3061 #ifdef WITH_PRESENCE
3062 if(handle == presenceResource.handle)
3066 #endif // WITH_PRESENCE
3067 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3069 // Verify that the resource exists
3070 resPtr = findResource ((OCResource *) handle);
3073 return OC_STACK_NO_RESOURCE;
3077 //only increment in the case of regular observing (not presence)
3078 incrementSequenceNumber(resPtr);
3079 method = OC_REST_OBSERVE;
3080 maxAge = MAX_OBSERVE_AGE;
3081 #ifdef WITH_PRESENCE
3082 result = SendAllObserverNotification (method, resPtr, maxAge, NULL, qos);
3084 result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3091 OCNotifyListOfObservers (OCResourceHandle handle,
3092 OCObservationId *obsIdList,
3093 uint8_t numberOfIds,
3094 unsigned char *notificationJSONPayload,
3095 OCQualityOfService qos)
3097 OC_LOG(INFO, TAG, PCF("Entering OCNotifyListOfObservers"));
3099 OCResource *resPtr = NULL;
3100 //TODO: we should allow the server to define this
3101 uint32_t maxAge = MAX_OBSERVE_AGE;
3103 VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3104 VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3105 VERIFY_NON_NULL(notificationJSONPayload, ERROR, OC_STACK_ERROR);
3107 // Verify that the resource exists
3108 resPtr = findResource ((OCResource *) handle);
3109 if (NULL == resPtr || myStackMode == OC_CLIENT)
3111 return OC_STACK_NO_RESOURCE;
3115 incrementSequenceNumber(resPtr);
3117 return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3118 notificationJSONPayload, maxAge, qos));
3122 * Send a response to a request.
3123 * The response can be a regular, slow, or block (i.e. a response that
3124 * is too large to be sent in a single PDU and must span multiple transmissions)
3126 * @param response - pointer to structure that contains response parameters
3129 * OC_STACK_OK - No errors; Success
3130 * OC_STACK_INVALID_PARAM - Invalid pointer to OCServerResponse
3131 * OC_STACK_INVALID_REQUEST_HANDLE - Request handle not found
3132 * OC_STACK_PERSISTENT_BUFFER_REQUIRED - Block transfer needed for response, so a
3133 * persistent response buffer is necessary
3135 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3137 OCStackResult result = OC_STACK_ERROR;
3138 OCServerRequest *serverRequest = NULL;
3140 OC_LOG(INFO, TAG, PCF("Entering OCDoResponse"));
3142 // Validate input parameters
3143 VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3144 VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3146 // TODO: Placeholder for creating a response entry when implementing
3147 // block transfer feature
3149 // If a response payload is present, check if block transfer is required
3150 if (ehResponse->payload && OCIsPacketTransferRequired(NULL,
3151 (const char *)ehResponse->payload, ehResponse->payloadSize))
3153 OC_LOG(INFO, TAG, PCF("Block transfer required"));
3155 // Persistent response buffer is needed for block transfer
3156 if (!ehResponse->persistentBufferFlag)
3158 OC_LOG(WARNING, TAG, PCF("Persistent response buffer required"));
3159 return OC_STACK_PERSISTENT_BUFFER_REQUIRED;
3161 // TODO: Placeholder for block transfer handling
3162 // TODO: Placeholder for setting the the response handle in the OCServerResponse struct
3163 // when implementing the block transfer feature
3168 // Get pointer to request info
3169 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3172 result = serverRequest->ehResponseHandler(ehResponse);
3179 * Cancel a response. Applies to a block response
3181 * @param responseHandle - response handle set by stack in OCServerResponse after
3182 * OCDoResponse is called
3185 * OC_STACK_OK - No errors; Success
3186 * OC_STACK_INVALID_PARAM - The handle provided is invalid.
3188 OCStackResult OCCancelResponse(OCResponseHandle responseHandle)
3190 OCStackResult result = OC_STACK_NOTIMPL;
3192 OC_LOG(INFO, TAG, PCF("Entering OCCancelResponse"));
3194 // TODO: validate response handle
3199 //-----------------------------------------------------------------------------
3200 // Private internal function definitions
3201 //-----------------------------------------------------------------------------
3203 * Generate handle of OCDoResource invocation for callback management.
3205 static OCDoHandle GenerateInvocationHandle()
3207 OCDoHandle handle = NULL;
3208 // Generate token here, it will be deleted when the transaction is deleted
3209 handle = (OCDoHandle) OCMalloc(sizeof(uint8_t[MAX_TOKEN_LENGTH]));
3212 OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[MAX_TOKEN_LENGTH]));
3217 #ifdef WITH_PRESENCE
3218 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3219 OCResourceProperty resourceProperties, uint8_t enable)
3221 if (resourceProperties
3222 > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW)) {
3223 OC_LOG(ERROR, TAG, PCF("Invalid property"));
3224 return OC_STACK_INVALID_PARAM;
3228 *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3232 *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3239 * Initialize resource data structures, variables, etc.
3241 OCStackResult initResources() {
3242 OCStackResult result = OC_STACK_OK;
3243 // Init application resource vars
3244 headResource = NULL;
3245 // Init Virtual Resources
3246 #ifdef WITH_PRESENCE
3247 presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL;
3248 //presenceResource.token = OCGenerateCoAPToken();
3249 result = OCCreateResource(&presenceResource.handle,
3250 OC_RSRVD_RESOURCE_TYPE_PRESENCE,
3255 //make resource inactive
3256 result = OCChangeResourceProperty(
3257 &(((OCResource *) presenceResource.handle)->resourceProperties),
3264 * Add a resource to the end of the linked list of resources.
3266 * @param resource - resource to be added
3268 void insertResource(OCResource *resource) {
3269 OCResource *pointer;
3271 if (!headResource) {
3272 headResource = resource;
3274 pointer = headResource;
3276 while (pointer->next) {
3277 pointer = pointer->next;
3279 pointer->next = resource;
3281 resource->next = NULL;
3285 * Find a resource in the linked list of resources.
3287 * @param resource - resource to be found
3289 * NULL - resource not found
3290 * pointer to resource - pointer to resource that was found in the linked list
3292 OCResource *findResource(OCResource *resource) {
3293 OCResource *pointer = headResource;
3296 if (pointer == resource) {
3299 pointer = pointer->next;
3304 void deleteAllResources()
3306 OCResource *pointer = headResource;
3311 temp = pointer->next;
3312 #ifdef WITH_PRESENCE
3313 if(pointer != (OCResource *) presenceResource.handle)
3315 #endif // WITH_PRESENCE
3316 deleteResource(pointer);
3317 #ifdef WITH_PRESENCE
3319 #endif // WITH_PRESENCE
3323 #ifdef WITH_PRESENCE
3324 // Ensure that the last resource to be deleted is the presence resource. This allows for all
3325 // presence notification attributed to their deletion to be processed.
3326 deleteResource((OCResource *) presenceResource.handle);
3327 #endif // WITH_PRESENCE
3331 * Delete the resource from the linked list.
3333 * @param resource - resource to be deleted
3338 int deleteResource(OCResource *resource) {
3339 OCResource *prev = NULL;
3342 temp = headResource;
3344 if (temp == resource) {
3345 // Invalidate all Resource Properties.
3346 resource->resourceProperties = (OCResourceProperty) 0;
3347 #ifdef WITH_PRESENCE
3348 if(resource != (OCResource *) presenceResource.handle)
3350 #endif // WITH_PRESENCE
3351 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
3352 #ifdef WITH_PRESENCE
3355 if(presenceResource.handle)
3357 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3358 if(resource != (OCResource *) presenceResource.handle)
3360 SendPresenceNotification(resource->rsrcType);
3364 SendPresenceNotification(NULL);
3369 if (temp == headResource) {
3370 headResource = temp->next;
3372 prev->next = temp->next;
3375 deleteResourceElements(temp);
3388 * Delete all of the dynamically allocated elements that were created for the resource.
3390 * @param resource - specified resource
3392 void deleteResourceElements(OCResource *resource) {
3398 OCFree(resource->uri);
3400 // Delete resourcetype linked list
3401 deleteResourceType(resource->rsrcType);
3403 // Delete resourceinterface linked list
3404 deleteResourceInterface(resource->rsrcInterface);
3408 * Delete all of the dynamically allocated elements that were created for the resource type.
3410 * @param resourceType - specified resource type
3412 void deleteResourceType(OCResourceType *resourceType) {
3413 OCResourceType *pointer = resourceType;
3414 OCResourceType *next;
3417 next = pointer->next;
3418 OCFree(pointer->resourcetypename);
3425 * Delete all of the dynamically allocated elements that were created for the resource interface.
3427 * @param resourceInterface - specified resource interface
3429 void deleteResourceInterface(OCResourceInterface *resourceInterface) {
3430 OCResourceInterface *pointer = resourceInterface;
3431 OCResourceInterface *next;
3434 next = pointer->next;
3435 OCFree(pointer->name);
3442 * Insert a resource type into a resource's resource type linked list.
3444 * @param resource - resource where resource type is to be inserted
3445 * @param resourceType - resource type to be inserted
3447 void insertResourceType(OCResource *resource, OCResourceType *resourceType) {
3448 OCResourceType *pointer;
3450 if (resource && !resource->rsrcType) {
3451 resource->rsrcType = resourceType;
3455 pointer = resource->rsrcType;
3459 pointer = resourceType;
3461 while (pointer->next) {
3462 pointer = pointer->next;
3464 pointer->next = resourceType;
3466 resourceType->next = NULL;
3470 * Get a resource type at the specified index within a resource.
3472 * @param handle - handle of resource
3473 * @param index - index of resource type
3476 * resourcetype - if found
3479 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index) {
3480 OCResource *resource;
3481 OCResourceType *pointer;
3484 // Find the specified resource
3485 resource = findResource((OCResource *) handle);
3490 // Make sure a resource has a resourcetype
3491 if (!resource->rsrcType) {
3495 // Iterate through the list
3496 pointer = resource->rsrcType;
3498 while ((i < index) && pointer) {
3500 pointer = pointer->next;
3506 * Finds a resource type in an OCResourceType link-list.
3508 * @param resourceTypeList - the link-list to be searched through
3509 * @param resourceTypeName - the key to search for
3512 * resourceType that matches the key (ie. resourceTypeName)
3513 * NULL - either an invalid parameter or this function was unable to find the key.
3515 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
3517 if(resourceTypeList && resourceTypeName)
3519 OCResourceType * rtPointer = resourceTypeList;
3520 while(resourceTypeName && rtPointer)
3522 if(rtPointer->resourcetypename &&
3523 strcmp(resourceTypeName, (const char *)
3524 (rtPointer->resourcetypename)) == 0)
3528 rtPointer = rtPointer->next;
3535 * Insert a resource interface into a resource's resource interface linked list.
3537 * @param resource - resource where resource interface is to be inserted
3538 * @param resourceInterface - resource interface to be inserted
3540 void insertResourceInterface(OCResource *resource,
3541 OCResourceInterface *resourceInterface) {
3542 OCResourceInterface *pointer;
3544 if (!resource->rsrcInterface) {
3545 resource->rsrcInterface = resourceInterface;
3547 pointer = resource->rsrcInterface;
3548 while (pointer->next) {
3549 pointer = pointer->next;
3551 pointer->next = resourceInterface;
3553 resourceInterface->next = NULL;
3557 * Get a resource interface at the specified index within a resource.
3559 * @param handle - handle of resource
3560 * @param index - index of resource interface
3563 * resourceinterface - if found
3566 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
3568 OCResource *resource;
3569 OCResourceInterface *pointer;
3572 // Find the specified resource
3573 resource = findResource((OCResource *) handle);
3578 // Make sure a resource has a resourceinterface
3579 if (!resource->rsrcInterface) {
3583 // Iterate through the list
3584 pointer = resource->rsrcInterface;
3586 while ((i < index) && pointer) {
3588 pointer = pointer->next;
3594 * Determine if a request/response must be sent in a block transfer because it is too large to be
3595 * sent in a single PDU. This function can be used for either a request or a response
3597 * @param request - NULL or pointer to request
3598 * @param response - NULL or pointer to response
3599 * @param size - 0 or size of the request/response. If 0, strlen is used for determining
3600 * the length of the request/response
3603 * 0 - packet transfer NOT required (i.e. normal request/response)
3604 * 1 - packet transfer required (i.e. block transfer needed)
3606 uint8_t OCIsPacketTransferRequired(const char *request, const char *response, uint16_t size)
3610 // Determine if we are checking a request or a response
3613 // If size is greater than 0, use it for the request size value, otherwise
3614 // assume request is null terminated and use strlen for size value
3615 if ((size > MAX_REQUEST_LENGTH) || (strlen(request) > MAX_REQUEST_LENGTH))
3622 // If size is greater than 0, use it for the response size value, otherwise
3623 // assume response is null terminated and use strlen for size value
3624 if ((size > MAX_RESPONSE_LENGTH) || (strlen(response) > MAX_RESPONSE_LENGTH))
3633 * Retrieves a resource type based upon a query ontains only just one
3634 * resource attribute (and that has to be of type "rt").
3636 * @remark This API malloc's memory for the resource type. Do not malloc resourceType
3637 * before passing in.
3639 * @param query - The quert part of the URI
3640 * @param resourceType - The resource type to be populated; pass by reference.
3643 * OC_STACK_INVALID_PARAM - Returns this if the resourceType parameter is invalid/NULL.
3644 * OC_STACK_OK - Success
3646 OCStackResult getResourceType(const char * query, unsigned char** resourceType)
3650 return OC_STACK_INVALID_PARAM;
3653 OCStackResult result = OC_STACK_ERROR;
3655 if(strncmp(query, "rt=", 3) == 0)
3657 *resourceType = (unsigned char *) OCMalloc(strlen(query)-3);
3660 result = OC_STACK_NO_MEMORY;
3663 strcpy((char *)*resourceType, ((const char *)&query[3]));
3664 result = OC_STACK_OK;
3670 OCStackResult getQueryFromUri(const char * uri, unsigned char** query, char ** newURI)
3674 return OC_STACK_INVALID_URI;
3676 if(!query || !newURI)
3678 return OC_STACK_INVALID_PARAM;
3680 char * leftToken = NULL;
3681 char * tempURI = (char *) OCMalloc(strlen(uri) + 1);
3686 strcpy(tempURI, uri);
3688 leftToken = strtok_r((char *)tempURI, "?", &strTokPtr);
3690 //TODO-CA: This could be simplified. Clean up required.
3691 while(leftToken != NULL)
3693 if(strncmp(leftToken, "rt=", 3) == 0 || strncmp(leftToken, "if=", 3) == 0)
3695 *query = (unsigned char *) OCMalloc(strlen(leftToken));
3701 strcpy((char *)*query, ((const char *)&leftToken[0]));
3704 leftToken = strtok_r(NULL, "?", &strTokPtr);
3712 return OC_STACK_NO_MEMORY;
3715 const ServerID OCGetServerInstanceID(void)
3717 static bool generated = false;
3718 static ServerID sid;
3725 sid = OCGetRandom();
3730 const char* OCGetServerInstanceIDString(void)
3732 // max printed length of a base 10
3733 // uint32 is 10 characters, so 11 includes null.
3734 // This will change as the representation gets switched
3736 static char buffer[11];
3737 int n = sprintf(buffer, "%u", OCGetServerInstanceID());