resource/csdk/stack/samples/linux/SimpleClientServer/occlientcoll.cpp

   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
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <signal.h>
  25 #include <unistd.h>
  26 #include <ocstack.h>
  27 #include <iostream>
  28 #include <sstream>
  29 #include "ocpayload.h"
  30 #include "logger.h"
  31 const char *getResult(OCStackResult result);
  32 std::string getIPAddrTBServer(OCClientResponse * clientResponse);
  33 std::string getPortTBServer(OCClientResponse * clientResponse);
  34 std::string getQueryStrForGetPut();
  35
  36 #define TAG PCF("occlient")
  37 #define DEFAULT_CONTEXT_VALUE 0x99
  38 #ifndef MAX_LENGTH_IPv4_ADDR
  39 #define MAX_LENGTH_IPv4_ADDR 16
  40 #endif
  41
  42 typedef enum
  43 {
  44     TEST_INVALID = 0,
  45     TEST_GET_DEFAULT,
  46     TEST_GET_BATCH,
  47     TEST_GET_LINK_LIST,
  48     TEST_PUT_DEFAULT,
  49     TEST_PUT_BATCH,
  50     TEST_PUT_LINK_LIST,
  51     TEST_UNKNOWN_RESOURCE_GET_DEFAULT,
  52     TEST_UNKNOWN_RESOURCE_GET_BATCH,
  53     TEST_UNKNOWN_RESOURCE_GET_LINK_LIST,
  54     MAX_TESTS
  55 } CLIENT_TEST;
  56
  57 /**
  58  * List of connectivity types that can be initiated from the client
  59  * Required for user input validation
  60  */
  61 typedef enum {
  62     CT_ADAPTER_DEFAULT = 0,
  63     CT_IP,
  64     MAX_CT
  65 } CLIENT_CONNECTIVITY_TYPE;
  66
  67 unsigned static int TEST = TEST_INVALID;
  68 unsigned static int CONNECTIVITY = 0;
  69
  70 typedef struct
  71 {
  72     char text[30];
  73     CLIENT_TEST test;
  74 } testToTextMap;
  75
  76 testToTextMap queryInterface[] = {
  77         {"invalid", TEST_INVALID},
  78         {"?if=oic.if.baseline", TEST_GET_DEFAULT},
  79         {"?if=oic.if.b", TEST_GET_BATCH},
  80         {"?if=oic.if.ll", TEST_GET_LINK_LIST},
  81         {"?if=oic.if.baseline", TEST_UNKNOWN_RESOURCE_GET_DEFAULT},
  82         {"?if=oic.if.b", TEST_UNKNOWN_RESOURCE_GET_BATCH},
  83         {"?if=oic.if.ll", TEST_UNKNOWN_RESOURCE_GET_LINK_LIST},
  84         {"?if=oic.if.baseline", TEST_PUT_DEFAULT},
  85         {"?if=oic.if.b", TEST_PUT_BATCH},
  86         {"?if=oic.if.ll", TEST_PUT_LINK_LIST},
  87 };
  88
  89
  90 //The following variable determines the interface protocol (IP, etc)
  91 //to be used for sending unicast messages. Default set to IP.
  92 static OCConnectivityType OC_CONNTYPE = CT_ADAPTER_IP;
  93 static const char * MULTICAST_RESOURCE_DISCOVERY_QUERY = "/oic/res";
  94
  95 // The handle for the observe registration
  96 OCDoHandle gObserveDoHandle;
  97 // After this crosses a threshold client deregisters for further observations
  98 int gNumObserveNotifies = 1;
  99
 100 int gQuitFlag = 0;
 101 /* SIGINT handler: set gQuitFlag to 1 for graceful termination */
 102 void handleSigInt(int signum)
 103 {
 104     if (signum == SIGINT)
 105     {
 106         gQuitFlag = 1;
 107     }
 108 }
 109
 110 // Forward Declaration
 111 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse);
 112 int InitGetRequestToUnavailableResource(OCClientResponse * clientResponse);
 113 int InitObserveRequest(OCClientResponse * clientResponse);
 114 int InitPutRequest(OCClientResponse * clientResponse);
 115 int InitGetRequest(OCClientResponse * clientResponse);
 116 int InitDiscovery();
 117
 118 OCPayload* putPayload()
 119 {
 120     OCRepPayload* payload = OCRepPayloadCreate();
 121
 122     if(!payload)
 123     {
 124         std::cout << "Failed to create put payload object"<<std::endl;
 125         std::exit(1);
 126     }
 127
 128     OCRepPayloadSetPropInt(payload, "power", 15);
 129     OCRepPayloadSetPropBool(payload, "state", true);
 130
 131     return (OCPayload*) payload;
 132 }
 133
 134 void PrintUsage()
 135 {
 136     OC_LOG(INFO, TAG, "Usage : occlientcoll -t <Test Case> -c <CA connectivity Type>");
 137     OC_LOG(INFO, TAG, "-c 0 : Default auto-selection");
 138     OC_LOG(INFO, TAG, "-c 1 : IP Connectivity Type");
 139     OC_LOG(INFO, TAG, "Test Case 1 : Discover Resources && Initiate GET Request on an "\
 140             "available resource using default interface.");
 141     OC_LOG(INFO, TAG, "Test Case 2 : Discover Resources && Initiate GET Request on an "\
 142                  "available resource using batch interface.");
 143     OC_LOG(INFO, TAG, "Test Case 3 : Discover Resources && Initiate GET Request on an "\
 144                  "available resource using link list interface.");
 145     OC_LOG(INFO, TAG, "Test Case 4 : Discover Resources && Initiate GET & PUT Request on an "\
 146                  "available resource using default interface.");
 147     OC_LOG(INFO, TAG, "Test Case 5 : Discover Resources && Initiate GET & PUT Request on an "\
 148                  "available resource using batch interface.");
 149     OC_LOG(INFO, TAG, "Test Case 6 : Discover Resources && Initiate GET & PUT Request on an "\
 150                  "available resource using link list interface.");
 151     OC_LOG(INFO, TAG, "Test Case 7 : Discover Resources && Initiate GET Request on an "\
 152                  "unavailable resource using default interface.");
 153     OC_LOG(INFO, TAG, "Test Case 8 : Discover Resources && Initiate GET Request on an "\
 154                  "unavailable resource using batch interface.");
 155     OC_LOG(INFO, TAG, "Test Case 9 : Discover Resources && Initiate GET Request on an "\
 156                  "unavailable resource using link list interface.");
 157 }
 158
 159 OCStackApplicationResult putReqCB(void* ctx, OCDoHandle /*handle*/,
 160                                   OCClientResponse * clientResponse)
 161 {
 162     if(clientResponse == NULL)
 163     {
 164         OC_LOG(INFO, TAG, "The clientResponse is NULL");
 165         return   OC_STACK_DELETE_TRANSACTION;
 166     }
 167     if(ctx == (void*)DEFAULT_CONTEXT_VALUE)
 168     {
 169         OC_LOG_V(INFO, TAG, "Callback Context for PUT query recvd successfully");
 170         OC_LOG_PAYLOAD(INFO, TAG, clientResponse->payload);
 171     }
 172
 173     return OC_STACK_KEEP_TRANSACTION;
 174 }
 175
 176 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle /*handle*/,
 177                                   OCClientResponse * clientResponse)
 178 {
 179     OC_LOG_V(INFO, TAG, "StackResult: %s",
 180             getResult(clientResponse->result));
 181     if(ctx == (void*)DEFAULT_CONTEXT_VALUE)
 182     {
 183         OC_LOG_V(INFO, TAG, "SEQUENCE NUMBER: %d", clientResponse->sequenceNumber);
 184         if(clientResponse->sequenceNumber == 0)
 185         {
 186             OC_LOG_V(INFO, TAG, "Callback Context for GET query recvd successfully");
 187             OC_LOG_PAYLOAD(INFO, TAG, clientResponse->payload);
 188         }
 189         else
 190         {
 191             OC_LOG_V(INFO, TAG, "Callback Context for Get recvd successfully %d",
 192                     gNumObserveNotifies);
 193             OC_LOG_PAYLOAD(INFO, TAG, clientResponse->payload);;
 194             gNumObserveNotifies++;
 195             if (gNumObserveNotifies == 3)
 196             {
 197                 if (OCCancel (gObserveDoHandle, OC_LOW_QOS, NULL, 0) != OC_STACK_OK)
 198                 {
 199                     OC_LOG(ERROR, TAG, "Observe cancel error");
 200                 }
 201             }
 202         }
 203     }
 204     if(TEST == TEST_PUT_DEFAULT || TEST == TEST_PUT_BATCH || TEST == TEST_PUT_LINK_LIST)
 205     {
 206         InitPutRequest(clientResponse);
 207     }
 208     return OC_STACK_KEEP_TRANSACTION;
 209 }
 210
 211
 212 // This is a function called back when a device is discovered
 213 OCStackApplicationResult discoveryReqCB(void* ctx, OCDoHandle /*handle*/,
 214         OCClientResponse * clientResponse)
 215 {
 216     OC_LOG(INFO, TAG,
 217             "Entering discoveryReqCB (Application Layer CB)");
 218     OC_LOG_V(INFO, TAG, "StackResult: %s",
 219             getResult(clientResponse->result));
 220
 221     if (ctx == (void*) DEFAULT_CONTEXT_VALUE)
 222     {
 223         OC_LOG_V(INFO, TAG, "Callback Context recvd successfully");
 224     }
 225
 226     OC_LOG_V(INFO, TAG,
 227             "Device =============> Discovered @ %s:%d",
 228             clientResponse->devAddr.addr,
 229             clientResponse->devAddr.port);
 230     OC_LOG_PAYLOAD(INFO, TAG, clientResponse->payload);
 231
 232     OC_CONNTYPE = clientResponse->connType;
 233
 234     if(TEST == TEST_UNKNOWN_RESOURCE_GET_DEFAULT || TEST == TEST_UNKNOWN_RESOURCE_GET_BATCH ||\
 235             TEST == TEST_UNKNOWN_RESOURCE_GET_LINK_LIST)
 236     {
 237         InitGetRequestToUnavailableResource(clientResponse);
 238     }
 239     else
 240     {
 241         InitGetRequest(clientResponse);
 242     }
 243     return OC_STACK_KEEP_TRANSACTION;
 244 }
 245
 246
 247 int InitGetRequestToUnavailableResource(OCClientResponse * clientResponse)
 248 {
 249     OCStackResult ret;
 250     OCCallbackData cbData;
 251     std::ostringstream getQuery;
 252     getQuery << "coap://" << clientResponse->devAddr.addr << ":" <<
 253             clientResponse->devAddr.port << "/SomeUnknownResource";
 254     cbData.cb = getReqCB;
 255     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 256     cbData.cd = NULL;
 257
 258     ret = OCDoResource(NULL, OC_REST_GET, getQuery.str().c_str(), 0, 0, OC_CONNTYPE, OC_LOW_QOS,
 259             &cbData, NULL, 0);
 260     if (ret != OC_STACK_OK)
 261     {
 262         OC_LOG(ERROR, TAG, "OCStack resource error");
 263     }
 264     return ret;
 265 }
 266
 267
 268 int InitObserveRequest(OCClientResponse * clientResponse)
 269 {
 270     OCStackResult ret;
 271     OCCallbackData cbData;
 272     OCDoHandle handle;
 273     std::ostringstream obsReg;
 274     obsReg << "coap://" << clientResponse->devAddr.addr << ":" <<
 275             clientResponse->devAddr.addr <<
 276             getQueryStrForGetPut();
 277     cbData.cb = getReqCB;
 278     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 279     cbData.cd = NULL;
 280     OC_LOG_V(INFO, TAG, "OBSERVE payload from client =");
 281     OCPayload* payload = putPayload();
 282     OC_LOG_PAYLOAD(INFO, TAG, payload);
 283     OCPayloadDestroy(payload);
 284
 285     ret = OCDoResource(&handle, OC_REST_OBSERVE, obsReg.str().c_str(), 0, 0, OC_CONNTYPE,
 286             OC_LOW_QOS, &cbData, NULL, 0);
 287     if (ret != OC_STACK_OK)
 288     {
 289         OC_LOG(ERROR, TAG, "OCStack resource error");
 290     }
 291     else
 292     {
 293         gObserveDoHandle = handle;
 294     }
 295     return ret;
 296 }
 297
 298
 299 int InitPutRequest(OCClientResponse * clientResponse)
 300 {
 301     OCStackResult ret;
 302     OCCallbackData cbData;
 303     //* Make a PUT query*/
 304     std::ostringstream getQuery;
 305     getQuery << "coap://" << clientResponse->devAddr.addr << ":" <<
 306             clientResponse->devAddr.port <<
 307             "/a/room" << queryInterface[TEST].text;
 308     cbData.cb = putReqCB;
 309     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 310     cbData.cd = NULL;
 311     OC_LOG_V(INFO, TAG, "PUT payload from client = ");
 312     OCPayload* payload = putPayload();
 313     OC_LOG_PAYLOAD(INFO, TAG, payload);
 314     OCPayloadDestroy(payload);
 315
 316     ret = OCDoResource(NULL, OC_REST_PUT, getQuery.str().c_str(), 0, putPayload(),
 317                         OC_CONNTYPE, OC_LOW_QOS, &cbData, NULL, 0);
 318     if (ret != OC_STACK_OK)
 319     {
 320         OC_LOG(ERROR, TAG, "OCStack resource error");
 321     }
 322     return ret;
 323 }
 324
 325
 326 int InitGetRequest(OCClientResponse * clientResponse)
 327 {
 328     OCStackResult ret;
 329     OCCallbackData cbData;
 330
 331     //* Make a GET query*/
 332     std::ostringstream getQuery;
 333     getQuery << "coap://" << clientResponse->devAddr.addr << ":" <<
 334             clientResponse->devAddr.port <<
 335             "/a/room" << queryInterface[TEST].text;
 336
 337     std::cout << "Get Query: " << getQuery.str() << std::endl;
 338
 339     cbData.cb = getReqCB;
 340     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 341     cbData.cd = NULL;
 342     ret = OCDoResource(NULL, OC_REST_GET,
 343             getQuery.str().c_str(), 0, 0, OC_CONNTYPE, OC_LOW_QOS,
 344             &cbData, NULL, 0);
 345     if (ret != OC_STACK_OK)
 346     {
 347         OC_LOG(ERROR, TAG, "OCStack resource error");
 348     }
 349     return ret;
 350 }
 351
 352 int InitDiscovery()
 353 {
 354     OCStackResult ret;
 355     OCCallbackData cbData;
 356     /* Start a discovery query*/
 357     char szQueryUri[64] = { 0 };
 358
 359     strcpy(szQueryUri, MULTICAST_RESOURCE_DISCOVERY_QUERY);
 360
 361     cbData.cb = discoveryReqCB;
 362     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 363     cbData.cd = NULL;
 364     ret = OCDoResource(NULL, OC_REST_DISCOVER, szQueryUri, 0, 0, OC_CONNTYPE,
 365                         OC_LOW_QOS,
 366             &cbData, NULL, 0);
 367     if (ret != OC_STACK_OK)
 368     {
 369         OC_LOG(ERROR, TAG, "OCStack resource error");
 370     }
 371     return ret;
 372 }
 373
 374 int main(int argc, char* argv[])
 375 {
 376     int opt;
 377
 378     while ((opt = getopt(argc, argv, "t:c:")) != -1)
 379     {
 380         switch (opt)
 381         {
 382             case 't':
 383                 TEST = atoi(optarg);
 384                 break;
 385             case 'c':
 386                 CONNECTIVITY = atoi(optarg);
 387                 break;
 388             default:
 389                 PrintUsage();
 390                 return -1;
 391         }
 392     }
 393     if ((TEST <= TEST_INVALID || TEST >= MAX_TESTS) ||
 394         CONNECTIVITY >= MAX_CT)
 395     {
 396         PrintUsage();
 397         return -1;
 398     }
 399
 400     /* Initialize OCStack*/
 401     if (OCInit(NULL, 0, OC_CLIENT) != OC_STACK_OK)
 402     {
 403         OC_LOG(ERROR, TAG, "OCStack init error");
 404         return 0;
 405     }
 406
 407     if(CONNECTIVITY == CT_ADAPTER_DEFAULT || CONNECTIVITY == CT_IP)
 408     {
 409         OC_CONNTYPE = CT_ADAPTER_IP;
 410     }
 411     else
 412     {
 413         OC_LOG(INFO, TAG, "Default Connectivity type selected...");
 414         OC_CONNTYPE = CT_ADAPTER_IP;
 415     }
 416
 417     InitDiscovery();
 418
 419     // Break from loop with Ctrl+C
 420     OC_LOG(INFO, TAG, "Entering occlient main loop...");
 421     signal(SIGINT, handleSigInt);
 422     while (!gQuitFlag)
 423     {
 424
 425         if (OCProcess() != OC_STACK_OK)
 426         {
 427             OC_LOG(ERROR, TAG, "OCStack process error");
 428             return 0;
 429         }
 430
 431         sleep(2);
 432     } OC_LOG(INFO, TAG, "Exiting occlient main loop...");
 433
 434     if (OCStop() != OC_STACK_OK)
 435     {
 436         OC_LOG(ERROR, TAG, "OCStack stop error");
 437     }
 438
 439     return 0;
 440 }
 441
 442 std::string getQueryStrForGetPut()
 443 {
 444     return "/a/room";
 445 }
 446