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