resource/csdk/stack/src/ocserverrequest.c

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20 #include <string.h>
  21
  22 #include "ocstack.h"
  23 #include "ocserverrequest.h"
  24 #include "ocresourcehandler.h"
  25 #include "oic_malloc.h"
  26 #include "oic_string.h"
  27 #include "ocpayload.h"
  28 #include "ocpayloadcbor.h"
  29 #include "logger.h"
  30
  31 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
  32 #include "routingutility.h"
  33 #endif
  34
  35 #include "cacommon.h"
  36 #include "cainterface.h"
  37
  38 #include "utlist.h"
  39 #include "pdu.h"
  40
  41 // Module Name
  42 #define VERIFY_NON_NULL(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
  43
  44 #define TAG  "OIC_RI_SERVERREQUEST"
  45
  46 static struct OCServerRequest * serverRequestList = NULL;
  47 static struct OCServerResponse * serverResponseList = NULL;
  48
  49 //-------------------------------------------------------------------------------------------------
  50 // Local functions
  51 //-------------------------------------------------------------------------------------------------
  52
  53 /**
  54  * Add a server response to the server response list
  55  *
  56  * @param response initialized server response that is created by this function
  57  * @param requestHandle - handle of the response
  58  *
  59  * @return
  60  *     OCStackResult
  61  */
  62 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
  63 {
  64     if (!response)
  65     {
  66         return OC_STACK_INVALID_PARAM;
  67     }
  68
  69     OCServerResponse * serverResponse = NULL;
  70
  71     serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
  72     VERIFY_NON_NULL(serverResponse);
  73
  74     serverResponse->payload = NULL;
  75
  76     serverResponse->requestHandle = requestHandle;
  77
  78     *response = serverResponse;
  79     OIC_LOG(INFO, TAG, "Server Response Added!!");
  80     LL_APPEND (serverResponseList, serverResponse);
  81     return OC_STACK_OK;
  82
  83 exit:
  84     if (serverResponse)
  85     {
  86         OICFree(serverResponse);
  87         serverResponse = NULL;
  88     }
  89     *response = NULL;
  90     return OC_STACK_NO_MEMORY;
  91 }
  92
  93 /**
  94  * Delete a server request from the server request list
  95  *
  96  * @param serverRequest - server request to delete
  97  */
  98 static void DeleteServerRequest(OCServerRequest * serverRequest)
  99 {
 100     if(serverRequest)
 101     {
 102         LL_DELETE(serverRequestList, serverRequest);
 103         OICFree(serverRequest->requestToken);
 104         OICFree(serverRequest);
 105         serverRequest = NULL;
 106         OIC_LOG(INFO, TAG, "Server Request Removed!!");
 107     }
 108 }
 109
 110 /**
 111  * Delete a server response from the server response list
 112  *
 113  * @param serverResponse - server response to delete
 114  */
 115 static void DeleteServerResponse(OCServerResponse * serverResponse)
 116 {
 117     if(serverResponse)
 118     {
 119         LL_DELETE(serverResponseList, serverResponse);
 120         OCPayloadDestroy(serverResponse->payload);
 121         OICFree(serverResponse);
 122         OIC_LOG(INFO, TAG, "Server Response Removed!!");
 123     }
 124 }
 125
 126 /**
 127  * Find a server response and delete it from the server response list
 128  *
 129  * @param serverResponse - server response to find and delete
 130  */
 131 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
 132 {
 133     OCServerResponse* tmp;
 134     if(serverResponse)
 135     {
 136         LL_FOREACH(serverResponseList, tmp)
 137         {
 138             if (serverResponse == tmp)
 139             {
 140                 DeleteServerResponse(tmp);
 141                 return;
 142             }
 143         }
 144     }
 145 }
 146
 147 /**
 148  * Ensure no accept header option is included when sending responses and add routing info to
 149  * outgoing response.
 150  *
 151  * @param object CA remote endpoint.
 152  * @param requestInfo CA request info.
 153  *
 154  * @return ::OC_STACK_OK on success, some other value upon failure.
 155  */
 156 static OCStackResult OCSendResponse(const CAEndpoint_t *object, CAResponseInfo_t *responseInfo)
 157 {
 158 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
 159     // Add route info in RM option.
 160     OCStackResult rmResult = RMAddInfo(object->routeData, responseInfo, false, NULL);
 161     if(OC_STACK_OK != rmResult)
 162     {
 163         OIC_LOG(ERROR, TAG, "Add option failed");
 164         return rmResult;
 165     }
 166 #endif
 167
 168     // Do not include the accept header option
 169     responseInfo->info.acceptFormat = CA_FORMAT_UNDEFINED;
 170     CAResult_t result = CASendResponse(object, responseInfo);
 171     if(CA_STATUS_OK != result)
 172     {
 173         OIC_LOG_V(ERROR, TAG, "CASendResponse failed with CA error %u", result);
 174         return CAResultToOCResult(result);
 175     }
 176     return OC_STACK_OK;
 177 }
 178
 179 //-------------------------------------------------------------------------------------------------
 180 // Internal APIs
 181 //-------------------------------------------------------------------------------------------------
 182
 183 /**
 184  * Get a server request from the server request list using the specified token.
 185  *
 186  * @param token - token of server request
 187  * @param tokenLength - length of token
 188  *
 189  * @return
 190  *     OCServerRequest*
 191  */
 192 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
 193 {
 194     if(!token)
 195     {
 196         OIC_LOG(ERROR, TAG, "Invalid Parameter Token");
 197         return NULL;
 198     }
 199
 200     OCServerRequest * out = NULL;
 201     OIC_LOG(INFO, TAG,"Get server request with token");
 202     OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
 203
 204     OIC_LOG(INFO, TAG,"Found token");
 205     LL_FOREACH (serverRequestList, out)
 206     {
 207         OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
 208         if(memcmp(out->requestToken, token, tokenLength) == 0)
 209         {
 210             return out;
 211         }
 212     }
 213     OIC_LOG(ERROR, TAG, "Server Request not found!!");
 214     return NULL;
 215 }
 216
 217 /**
 218  * Get a server request from the server request list using the specified handle
 219  *
 220  * @param handle - handle of server request
 221  * @return
 222  *     OCServerRequest*
 223  */
 224 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
 225 {
 226     OCServerRequest * out = NULL;
 227     LL_FOREACH (serverRequestList, out)
 228     {
 229         if(out == handle)
 230         {
 231             return out;
 232         }
 233     }
 234     OIC_LOG(ERROR, TAG, "Server Request not found!!");
 235     return NULL;
 236 }
 237
 238 /**
 239  * Get a server response from the server response list using the specified handle
 240  *
 241  * @param handle - handle of server response
 242  *
 243  * @return
 244  *     OCServerResponse*
 245  */
 246 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
 247 {
 248     OCServerResponse * out = NULL;
 249     LL_FOREACH (serverResponseList, out)
 250     {
 251         if(out->requestHandle == handle)
 252         {
 253             return out;
 254         }
 255     }
 256     OIC_LOG(ERROR, TAG, "Server Response not found!!");
 257     return NULL;
 258 }
 259
 260 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
 261         uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
 262         uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
 263         OCQualityOfService qos, char * query,
 264         OCHeaderOption * rcvdVendorSpecificHeaderOptions,
 265         uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
 266         char * resourceUrl, size_t reqTotalSize, OCPayloadFormat acceptFormat,
 267         const OCDevAddr *devAddr)
 268 {
 269     if (!request)
 270     {
 271         return OC_STACK_INVALID_PARAM;
 272     }
 273
 274     OCServerRequest * serverRequest = NULL;
 275
 276     OIC_LOG_V(INFO, TAG, "addserverrequest entry!! [%s:%u]", devAddr->addr, devAddr->port);
 277
 278     serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
 279         (reqTotalSize ? reqTotalSize : 1) - 1);
 280     VERIFY_NON_NULL(devAddr);
 281     VERIFY_NON_NULL(serverRequest);
 282
 283     serverRequest->coapID = coapID;
 284     serverRequest->delayedResNeeded = delayedResNeeded;
 285     serverRequest->notificationFlag = notificationFlag;
 286
 287     serverRequest->method = method;
 288     serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
 289     serverRequest->observationOption = observationOption;
 290     serverRequest->observeResult = OC_STACK_ERROR;
 291     serverRequest->qos = qos;
 292     serverRequest->acceptFormat = acceptFormat;
 293     serverRequest->ehResponseHandler = HandleSingleResponse;
 294     serverRequest->numResponses = 1;
 295
 296     if(query)
 297     {
 298         OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
 299     }
 300
 301     if(rcvdVendorSpecificHeaderOptions)
 302     {
 303         memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
 304             MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
 305     }
 306     if(payload && reqTotalSize)
 307     {
 308        // destination is at least 1 greater than the source, so a NULL always exists in the
 309         // last character
 310         memcpy(serverRequest->payload, payload, reqTotalSize);
 311         serverRequest->payloadSize = reqTotalSize;
 312     }
 313
 314     serverRequest->requestComplete = 0;
 315     if(requestToken)
 316     {
 317         // If tokenLength is zero, the return value depends on the
 318         // particular library implementation (it may or may not be a null pointer).
 319         if (tokenLength)
 320         {
 321             serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
 322             VERIFY_NON_NULL(serverRequest->requestToken);
 323             memcpy(serverRequest->requestToken, requestToken, tokenLength);
 324         }
 325
 326     }
 327     serverRequest->tokenLength = tokenLength;
 328
 329     if(resourceUrl)
 330     {
 331         OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
 332             resourceUrl);
 333     }
 334
 335     serverRequest->devAddr = *devAddr;
 336
 337     *request = serverRequest;
 338     OIC_LOG(INFO, TAG, "Server Request Added!!");
 339     LL_APPEND (serverRequestList, serverRequest);
 340     return OC_STACK_OK;
 341
 342 exit:
 343     if (serverRequest)
 344     {
 345         OICFree(serverRequest);
 346         serverRequest = NULL;
 347     }
 348     *request = NULL;
 349     return OC_STACK_NO_MEMORY;
 350 }
 351
 352 OCStackResult FormOCEntityHandlerRequest(
 353         OCEntityHandlerRequest * entityHandlerRequest,
 354         OCRequestHandle request,
 355         OCMethod method,
 356         OCDevAddr *endpoint,
 357         OCResourceHandle resource,
 358         char * queryBuf,
 359         OCPayloadType payloadType,
 360         uint8_t * payload,
 361         size_t payloadSize,
 362         uint8_t numVendorOptions,
 363         OCHeaderOption * vendorOptions,
 364         OCObserveAction observeAction,
 365         OCObservationId observeID,
 366         uint16_t messageID)
 367 {
 368     if (entityHandlerRequest)
 369     {
 370         entityHandlerRequest->resource = (OCResourceHandle) resource;
 371         entityHandlerRequest->requestHandle = request;
 372         entityHandlerRequest->method = method;
 373         entityHandlerRequest->devAddr = *endpoint;
 374         entityHandlerRequest->query = queryBuf;
 375         entityHandlerRequest->obsInfo.action = observeAction;
 376         entityHandlerRequest->obsInfo.obsId = observeID;
 377         entityHandlerRequest->messageID = messageID;
 378
 379         if(payload && payloadSize)
 380         {
 381             if(OCParsePayload(&entityHandlerRequest->payload, payloadType,
 382                         payload, payloadSize) != OC_STACK_OK)
 383             {
 384                 return OC_STACK_ERROR;
 385             }
 386         }
 387         else
 388         {
 389             entityHandlerRequest->payload = NULL;
 390         }
 391
 392         entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
 393         entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
 394
 395         return OC_STACK_OK;
 396     }
 397
 398     return OC_STACK_INVALID_PARAM;
 399 }
 400
 401 /**
 402  * Find a server request in the server request list and delete
 403  *
 404  * @param serverRequest - server request to find and delete
 405  */
 406 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
 407 {
 408     OCServerRequest* tmp;
 409     if(serverRequest)
 410     {
 411         LL_FOREACH(serverRequestList, tmp)
 412         {
 413             if (serverRequest == tmp)
 414             {
 415                 DeleteServerRequest(tmp);
 416                 return;
 417             }
 418         }
 419     }
 420 }
 421
 422 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result, OCMethod method)
 423 {
 424     CAResponseResult_t caResult;
 425
 426     switch (result)
 427     {
 428         case OC_EH_OK:
 429            switch (method)
 430            {
 431                case OC_REST_PUT:
 432                case OC_REST_POST:
 433                    // This Response Code is like HTTP 204 "No Content" but only used in
 434                    // response to POST and PUT requests.
 435                    caResult = CA_CHANGED;
 436                    break;
 437                case OC_REST_GET:
 438                    // This Response Code is like HTTP 200 "OK" but only used in response to
 439                    // GET requests.
 440                    caResult = CA_CONTENT;
 441                    break;
 442                default:
 443                    // This should not happen but,
 444                    // give it a value just in case but output an error
 445                    caResult = CA_CONTENT;
 446                    OIC_LOG_V(ERROR, TAG, "Unexpected OC_EH_OK return code for method [%d].", method);
 447            }
 448             break;
 449         case OC_EH_ERROR:
 450             caResult = CA_BAD_REQ;
 451             break;
 452         case OC_EH_RESOURCE_CREATED:
 453             caResult = CA_CREATED;
 454             break;
 455         case OC_EH_RESOURCE_DELETED:
 456             caResult = CA_DELETED;
 457             break;
 458         case OC_EH_SLOW:
 459             caResult = CA_CONTENT;
 460             break;
 461         case OC_EH_FORBIDDEN:
 462             caResult = CA_UNAUTHORIZED_REQ;
 463             break;
 464         case OC_EH_RESOURCE_NOT_FOUND:
 465             caResult = CA_NOT_FOUND;
 466             break;
 467         default:
 468             caResult = CA_BAD_REQ;
 469             break;
 470     }
 471     return caResult;
 472 }
 473
 474
 475 /**
 476  * Handler function for sending a response from a single resource
 477  *
 478  * @param ehResponse - pointer to the response from the resource
 479  *
 480  * @return
 481  *     OCStackResult
 482  */
 483 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
 484 {
 485     OCStackResult result = OC_STACK_ERROR;
 486     CAEndpoint_t responseEndpoint = {.adapter = CA_DEFAULT_ADAPTER};
 487     CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
 488     CAHeaderOption_t* optionsPointer = NULL;
 489
 490     if(!ehResponse || !ehResponse->requestHandle)
 491     {
 492         OIC_LOG(ERROR, TAG, "ehResponse/requestHandle is NULL");
 493         return OC_STACK_ERROR;
 494     }
 495
 496     OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
 497
 498     CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
 499
 500     responseInfo.info.resourceUri = serverRequest->resourceUrl;
 501     responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult, serverRequest->method);
 502
 503     if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
 504     {
 505         responseInfo.info.type = CA_MSG_CONFIRM;
 506     }
 507     else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
 508     {
 509         responseInfo.info.type = CA_MSG_NONCONFIRM;
 510     }
 511     else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
 512             serverRequest->qos == OC_HIGH_QOS)
 513     {
 514         responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
 515     }
 516     else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
 517             serverRequest->qos == OC_HIGH_QOS)
 518     {
 519         responseInfo.info.type = CA_MSG_CONFIRM;
 520     }
 521     else if(!serverRequest->notificationFlag)
 522     {
 523         responseInfo.info.type = CA_MSG_NONCONFIRM;
 524     }
 525     else
 526     {
 527         OIC_LOG(ERROR, TAG, "default responseInfo type is NON");
 528         responseInfo.info.type = CA_MSG_NONCONFIRM;
 529     }
 530
 531     char rspToken[CA_MAX_TOKEN_LEN + 1] = {};
 532     responseInfo.info.messageId = serverRequest->coapID;
 533     responseInfo.info.token = (CAToken_t)rspToken;
 534
 535     memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
 536     responseInfo.info.tokenLength = serverRequest->tokenLength;
 537
 538     if(serverRequest->observeResult == OC_STACK_OK)
 539     {
 540         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
 541     }
 542     else
 543     {
 544         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
 545     }
 546
 547     if(responseInfo.info.numOptions > 0)
 548     {
 549         responseInfo.info.options = (CAHeaderOption_t *)
 550                                       OICCalloc(responseInfo.info.numOptions,
 551                                               sizeof(CAHeaderOption_t));
 552
 553         if(!responseInfo.info.options)
 554         {
 555             OIC_LOG(FATAL, TAG, "Memory alloc for options failed");
 556             return OC_STACK_NO_MEMORY;
 557         }
 558
 559         optionsPointer = responseInfo.info.options;
 560
 561         // TODO: This exposes CoAP specific details.  At some point, this should be
 562         // re-factored and handled in the CA layer.
 563         if(serverRequest->observeResult == OC_STACK_OK)
 564         {
 565             responseInfo.info.options[0].protocolID = CA_COAP_ID;
 566             responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
 567             responseInfo.info.options[0].optionLength = sizeof(uint32_t);
 568             uint8_t* observationData = (uint8_t*)responseInfo.info.options[0].optionData;
 569             uint32_t observationOption= serverRequest->observationOption;
 570
 571             for (size_t i=sizeof(uint32_t); i; --i)
 572             {
 573                 observationData[i-1] = observationOption & 0xFF;
 574                 observationOption >>=8;
 575             }
 576
 577             // Point to the next header option before copying vender specific header options
 578             optionsPointer += 1;
 579         }
 580
 581         if (ehResponse->numSendVendorSpecificHeaderOptions)
 582         {
 583             memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
 584                             sizeof(OCHeaderOption) *
 585                             ehResponse->numSendVendorSpecificHeaderOptions);
 586         }
 587     }
 588     else
 589     {
 590         responseInfo.info.options = NULL;
 591     }
 592
 593     responseInfo.isMulticast = false;
 594     responseInfo.info.payload = NULL;
 595     responseInfo.info.payloadSize = 0;
 596     responseInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
 597
 598     // Put the JSON prefix and suffix around the payload
 599     if(ehResponse->payload)
 600     {
 601         if (ehResponse->payload->type == PAYLOAD_TYPE_PRESENCE)
 602         {
 603             responseInfo.isMulticast = true;
 604         }
 605         else
 606         {
 607             responseInfo.isMulticast = false;
 608         }
 609
 610         switch(serverRequest->acceptFormat)
 611         {
 612             case OC_FORMAT_UNDEFINED:
 613                 // No preference set by the client, so default to CBOR then
 614             case OC_FORMAT_CBOR:
 615                 if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
 616                                 &responseInfo.info.payloadSize))
 617                         != OC_STACK_OK)
 618                 {
 619                     OIC_LOG(ERROR, TAG, "Error converting payload");
 620                     OICFree(responseInfo.info.options);
 621                     return result;
 622                 }
 623                 responseInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
 624                 break;
 625             default:
 626                 responseInfo.result = CA_NOT_ACCEPTABLE;
 627         }
 628     }
 629
 630 #ifdef WITH_PRESENCE
 631     CATransportAdapter_t CAConnTypes[] = {
 632                             CA_ADAPTER_IP,
 633                             CA_ADAPTER_GATT_BTLE,
 634                             CA_ADAPTER_RFCOMM_BTEDR,
 635                             CA_ADAPTER_NFC
 636 #ifdef RA_ADAPTER
 637                             , CA_ADAPTER_REMOTE_ACCESS
 638 #endif
 639                             , CA_ADAPTER_TCP
 640                         };
 641
 642     size_t size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
 643
 644     CATransportAdapter_t adapter = responseEndpoint.adapter;
 645     // Default adapter, try to send response out on all adapters.
 646     if (adapter == CA_DEFAULT_ADAPTER)
 647     {
 648         adapter =
 649             (CATransportAdapter_t)(
 650                 CA_ADAPTER_IP           |
 651                 CA_ADAPTER_GATT_BTLE    |
 652                 CA_ADAPTER_RFCOMM_BTEDR |
 653                 CA_ADAPTER_NFC
 654 #ifdef RA_ADAP
 655                 | CA_ADAPTER_REMOTE_ACCESS
 656 #endif
 657                 | CA_ADAPTER_TCP
 658             );
 659     }
 660
 661     result = OC_STACK_OK;
 662     OCStackResult tempResult = OC_STACK_OK;
 663
 664     for(size_t i = 0; i < size; i++ )
 665     {
 666         responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
 667         if(responseEndpoint.adapter)
 668         {
 669             //The result is set to OC_STACK_OK only if OCSendResponse succeeds in sending the
 670             //response on all the n/w interfaces else it is set to OC_STACK_ERROR
 671             tempResult = OCSendResponse(&responseEndpoint, &responseInfo);
 672         }
 673         if(OC_STACK_OK != tempResult)
 674         {
 675             result = tempResult;
 676         }
 677     }
 678 #else
 679
 680     OIC_LOG(INFO, TAG, "Calling OCSendResponse with:");
 681     OIC_LOG_V(INFO, TAG, "\tEndpoint address: %s", responseEndpoint.addr);
 682     OIC_LOG_V(INFO, TAG, "\tEndpoint adapter: %s", responseEndpoint.adapter);
 683     OIC_LOG_V(INFO, TAG, "\tResponse result : %s", responseInfo.result);
 684     OIC_LOG_V(INFO, TAG, "\tResponse for uri: %s", responseInfo.info.resourceUri);
 685
 686     result = OCSendResponse(&responseEndpoint, &responseInfo);
 687 #endif
 688
 689     OICFree(responseInfo.info.payload);
 690     OICFree(responseInfo.info.options);
 691     //Delete the request
 692     FindAndDeleteServerRequest(serverRequest);
 693     return result;
 694 }
 695
 696 /**
 697  * Handler function for sending a response from multiple resources, such as a collection.
 698  * Aggregates responses from multiple resource until all responses are received then sends the
 699  * concatenated response
 700  *
 701  * TODO: Need to add a timeout in case a (remote?) resource does not respond
 702  *
 703  * @param ehResponse - pointer to the response from the resource
 704  *
 705  * @return
 706  *     OCStackResult
 707  */
 708 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
 709 {
 710     if(!ehResponse || !ehResponse->payload)
 711     {
 712         OIC_LOG(ERROR, TAG, "HandleAggregateResponse invalid parameters");
 713         return OC_STACK_INVALID_PARAM;
 714     }
 715
 716     OIC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
 717
 718     OCServerRequest *serverRequest = GetServerRequestUsingHandle((OCServerRequest *)
 719                                                                  ehResponse->requestHandle);
 720     OCServerResponse *serverResponse = GetServerResponseUsingHandle((OCServerRequest *)
 721                                                                     ehResponse->requestHandle);
 722
 723     OCStackResult stackRet = OC_STACK_ERROR;
 724     if(serverRequest)
 725     {
 726         if(!serverResponse)
 727         {
 728             OIC_LOG(INFO, TAG, "This is the first response fragment");
 729             stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
 730             if (OC_STACK_OK != stackRet)
 731             {
 732                 OIC_LOG(ERROR, TAG, "Error adding server response");
 733                 return stackRet;
 734             }
 735             VERIFY_NON_NULL(serverResponse);
 736         }
 737
 738         if(ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
 739         {
 740             stackRet = OC_STACK_ERROR;
 741             OIC_LOG(ERROR, TAG, "Error adding payload, as it was the incorrect type");
 742             goto exit;
 743         }
 744
 745         OCRepPayload *newPayload = OCRepPayloadClone((OCRepPayload *)ehResponse->payload);
 746
 747         if(!serverResponse->payload)
 748         {
 749             serverResponse->payload = (OCPayload *)newPayload;
 750         }
 751         else
 752         {
 753             OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
 754                     (OCRepPayload*)newPayload);
 755         }
 756
 757
 758         (serverRequest->numResponses)--;
 759
 760         if(serverRequest->numResponses == 0)
 761         {
 762             OIC_LOG(INFO, TAG, "This is the last response fragment");
 763             ehResponse->payload = serverResponse->payload;
 764             stackRet = HandleSingleResponse(ehResponse);
 765             //Delete the request and response
 766             FindAndDeleteServerRequest(serverRequest);
 767             FindAndDeleteServerResponse(serverResponse);
 768         }
 769         else
 770         {
 771             OIC_LOG(INFO, TAG, "More response fragments to come");
 772             stackRet = OC_STACK_OK;
 773         }
 774     }
 775 exit:
 776     return stackRet;
 777 }
 778