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 "logger.h"
  30 const char *getResult(OCStackResult result);
  31 std::string getIPAddrTBServer(OCClientResponse * clientResponse);
  32 std::string getPortTBServer(OCClientResponse * clientResponse);
  33 std::string getQueryStrForGetPut(unsigned  const char * responsePayload);
  34
  35 #define TAG PCF("occlient")
  36 #define DEFAULT_CONTEXT_VALUE 0x99
  37 #ifndef MAX_LENGTH_IPv4_ADDR
  38 #define MAX_LENGTH_IPv4_ADDR 16
  39 #endif
  40
  41 typedef enum {
  42     TEST_INVALID = 0,
  43     TEST_GET_DEFAULT,
  44     TEST_GET_BATCH,
  45     TEST_GET_LINK_LIST,
  46     TEST_PUT_DEFAULT,
  47     TEST_PUT_BATCH,
  48     TEST_PUT_LINK_LIST,
  49     TEST_UNKNOWN_RESOURCE_GET_DEFAULT,
  50     TEST_UNKNOWN_RESOURCE_GET_BATCH,
  51     TEST_UNKNOWN_RESOURCE_GET_LINK_LIST,
  52     MAX_TESTS
  53 } CLIENT_TEST;
  54
  55 unsigned static int TEST = TEST_INVALID;
  56
  57 typedef struct
  58 {
  59     unsigned char text[30];
  60     CLIENT_TEST test;
  61 } testToTextMap;
  62
  63 testToTextMap queryInterface[] = {
  64         {"invalid", TEST_INVALID},
  65         {"?if=oc.mi.def", TEST_GET_DEFAULT},
  66         {"?if=oc.mi.b", TEST_GET_BATCH},
  67         {"?if=oc.mi.ll", TEST_GET_LINK_LIST},
  68         {"?if=oc.mi.def", TEST_UNKNOWN_RESOURCE_GET_DEFAULT},
  69         {"?if=oc.mi.b", TEST_UNKNOWN_RESOURCE_GET_BATCH},
  70         {"?if=oc.mi.ll", TEST_UNKNOWN_RESOURCE_GET_LINK_LIST},
  71         {"?if=oc.mi.def", TEST_PUT_DEFAULT},
  72         {"?if=oc.mi.b", TEST_PUT_BATCH},
  73         {"?if=oc.mi.ll", TEST_PUT_LINK_LIST},
  74 };
  75
  76 static std::string putPayload = "{\"state\":\"off\",\"power\":\"0\"}";
  77
  78 // The handle for the observe registration
  79 OCDoHandle gObserveDoHandle;
  80 // After this crosses a threshold client deregisters for further observations
  81 int gNumObserveNotifies = 1;
  82
  83 int gQuitFlag = 0;
  84 /* SIGINT handler: set gQuitFlag to 1 for graceful termination */
  85 void handleSigInt(int signum) {
  86     if (signum == SIGINT) {
  87         gQuitFlag = 1;
  88     }
  89 }
  90
  91 // Forward Declaration
  92 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse);
  93 int InitGetRequestToUnavailableResource(OCClientResponse * clientResponse);
  94 int InitObserveRequest(OCClientResponse * clientResponse);
  95 int InitPutRequest(OCClientResponse * clientResponse);
  96 int InitGetRequest(OCClientResponse * clientResponse);
  97 int InitDiscovery();
  98
  99 void PrintUsage()
 100 {
 101     OC_LOG(INFO, TAG, "Usage : occlientcoll -t <Test Case>");
 102     OC_LOG(INFO, TAG, "Test Case 1 : Discover Resources && Initiate GET Request on an"\
 103             "available resource using default interface.");
 104     OC_LOG(INFO, TAG, "Test Case 2 : Discover Resources && Initiate GET Request on an"\
 105                  "available resource using batch interface.");
 106     OC_LOG(INFO, TAG, "Test Case 3 : Discover Resources && Initiate GET Request on an"\
 107                  "available resource using link list interface.");
 108     OC_LOG(INFO, TAG, "Test Case 4 : Discover Resources && Initiate GET & PUT Request on an"\
 109                  "available resource using default interface.");
 110     OC_LOG(INFO, TAG, "Test Case 5 : Discover Resources && Initiate GET & PUT Request on an"\
 111                  "available resource using batch interface.");
 112     OC_LOG(INFO, TAG, "Test Case 6 : Discover Resources && Initiate GET & PUT Request on an"\
 113                  "available resource using link list interface.");
 114     OC_LOG(INFO, TAG, "Test Case 7 : Discover Resources && Initiate GET Request on an"\
 115                  "unavailable resource using default interface.");
 116     OC_LOG(INFO, TAG, "Test Case 8 : Discover Resources && Initiate GET Request on an"\
 117                  "unavailable resource using batch interface.");
 118     OC_LOG(INFO, TAG, "Test Case 9 : Discover Resources && Initiate GET Request on an"\
 119                  "unavailable resource using link list interface.");
 120 }
 121
 122 OCStackApplicationResult putReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse) {
 123     if(clientResponse) {}
 124     if(ctx == (void*)DEFAULT_CONTEXT_VALUE) {
 125         OC_LOG_V(INFO, TAG, "Callback Context for PUT query recvd successfully");
 126         OC_LOG_V(INFO, TAG, "JSON = %s =============> Discovered", clientResponse->resJSONPayload);
 127     }
 128
 129     return OC_STACK_KEEP_TRANSACTION;
 130 }
 131
 132 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse) {
 133     OC_LOG_V(INFO, TAG, "StackResult: %s",
 134             getResult(clientResponse->result));
 135     if(ctx == (void*)DEFAULT_CONTEXT_VALUE) {
 136         OC_LOG_V(INFO, TAG, "SEQUENCE NUMBER: %d", clientResponse->sequenceNumber);
 137         if(clientResponse->sequenceNumber == 0) {
 138             OC_LOG_V(INFO, TAG, "Callback Context for GET query recvd successfully");
 139             OC_LOG_V(INFO, TAG, "Fnd' Rsrc': %s", clientResponse->resJSONPayload);
 140         }
 141         else {
 142             OC_LOG_V(INFO, TAG, "Callback Context for Get recvd successfully %d", gNumObserveNotifies);
 143             OC_LOG_V(INFO, TAG, "Fnd' Rsrc': %s", clientResponse->resJSONPayload);
 144             gNumObserveNotifies++;
 145             if (gNumObserveNotifies == 3)
 146             {
 147                 if (OCCancel (gObserveDoHandle, OC_LOW_QOS, NULL, 0) != OC_STACK_OK){
 148                     OC_LOG(ERROR, TAG, "Observe cancel error");
 149                 }
 150             }
 151         }
 152     }
 153     if(TEST == TEST_PUT_DEFAULT || TEST == TEST_PUT_BATCH || TEST == TEST_PUT_LINK_LIST)
 154     {
 155         InitPutRequest(clientResponse);
 156     }
 157     return OC_STACK_KEEP_TRANSACTION;
 158 }
 159
 160
 161 // This is a function called back when a device is discovered
 162 OCStackApplicationResult discoveryReqCB(void* ctx, OCDoHandle handle,
 163         OCClientResponse * clientResponse) {
 164     uint8_t remoteIpAddr[4];
 165     uint16_t remotePortNu;
 166
 167     OC_LOG(INFO, TAG,
 168             "Entering discoveryReqCB (Application Layer CB)");
 169     OC_LOG_V(INFO, TAG, "StackResult: %s",
 170             getResult(clientResponse->result));
 171
 172     if (ctx == (void*) DEFAULT_CONTEXT_VALUE) {
 173         OC_LOG_V(INFO, TAG, "Callback Context recvd successfully");
 174     }
 175
 176     OCDevAddrToIPv4Addr((OCDevAddr *) clientResponse->addr, remoteIpAddr,
 177             remoteIpAddr + 1, remoteIpAddr + 2, remoteIpAddr + 3);
 178     OCDevAddrToPort((OCDevAddr *) clientResponse->addr, &remotePortNu);
 179
 180     OC_LOG_V(INFO, TAG,
 181             "Device =============> Discovered %s @ %d.%d.%d.%d:%d",
 182             clientResponse->resJSONPayload, remoteIpAddr[0], remoteIpAddr[1],
 183             remoteIpAddr[2], remoteIpAddr[3], remotePortNu);
 184
 185     if(TEST == TEST_UNKNOWN_RESOURCE_GET_DEFAULT || TEST == TEST_UNKNOWN_RESOURCE_GET_BATCH ||\
 186             TEST == TEST_UNKNOWN_RESOURCE_GET_LINK_LIST)
 187     {
 188         InitGetRequestToUnavailableResource(clientResponse);
 189     }
 190     else
 191     {
 192         InitGetRequest(clientResponse);
 193     }
 194     return OC_STACK_KEEP_TRANSACTION;
 195 }
 196
 197
 198 int InitGetRequestToUnavailableResource(OCClientResponse * clientResponse)
 199 {
 200     OCStackResult ret;
 201     OCCallbackData cbData;
 202     OCDoHandle handle;
 203     std::ostringstream getQuery;
 204     getQuery << "coap://" << getIPAddrTBServer(clientResponse) << ":" << getPortTBServer(clientResponse) << "/SomeUnknownResource";
 205     cbData.cb = getReqCB;
 206     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 207     cbData.cd = NULL;
 208
 209     ret = OCDoResource(&handle, OC_REST_GET, getQuery.str().c_str(), 0, 0, OC_LOW_QOS,
 210             &cbData, NULL, 0);
 211     if (ret != OC_STACK_OK)
 212     {
 213         OC_LOG(ERROR, TAG, "OCStack resource error");
 214     }
 215     return ret;
 216 }
 217
 218
 219 int InitObserveRequest(OCClientResponse * clientResponse)
 220 {
 221     OCStackResult ret;
 222     OCCallbackData cbData;
 223     OCDoHandle handle;
 224     std::ostringstream obsReg;
 225     obsReg << "coap://" << getIPAddrTBServer(clientResponse) << ":" << getPortTBServer(clientResponse) << getQueryStrForGetPut(clientResponse->resJSONPayload);
 226     cbData.cb = getReqCB;
 227     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 228     cbData.cd = NULL;
 229     OC_LOG_V(INFO, TAG, "OBSERVE payload from client = %s ", putPayload.c_str());
 230
 231     ret = OCDoResource(&handle, OC_REST_OBSERVE, obsReg.str().c_str(), 0, 0, OC_LOW_QOS,
 232             &cbData, NULL, 0);
 233     if (ret != OC_STACK_OK)
 234     {
 235         OC_LOG(ERROR, TAG, "OCStack resource error");
 236     }
 237     else
 238     {
 239         gObserveDoHandle = handle;
 240     }
 241     return ret;
 242 }
 243
 244
 245 int InitPutRequest(OCClientResponse * clientResponse)
 246 {
 247     OCStackResult ret;
 248     OCCallbackData cbData;
 249     OCDoHandle handle;
 250     //* Make a PUT query*/
 251     std::ostringstream getQuery;
 252     getQuery << "coap://" << getIPAddrTBServer(clientResponse) << ":" << getPortTBServer(clientResponse) <<
 253     "/a/room" << queryInterface[TEST].text;
 254     cbData.cb = putReqCB;
 255     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 256     cbData.cd = NULL;
 257     OC_LOG_V(INFO, TAG, "PUT payload from client = %s ", putPayload.c_str());
 258
 259     ret = OCDoResource(&handle, OC_REST_PUT, getQuery.str().c_str(), 0, putPayload.c_str(),
 260             OC_LOW_QOS, &cbData, NULL, 0);
 261     if (ret != OC_STACK_OK)
 262     {
 263         OC_LOG(ERROR, TAG, "OCStack resource error");
 264     }
 265     return ret;
 266 }
 267
 268
 269 int InitGetRequest(OCClientResponse * clientResponse)
 270 {
 271     OCStackResult ret;
 272     OCCallbackData cbData;
 273     OCDoHandle handle;
 274
 275     uint8_t remoteIpAddr[4];
 276     uint16_t remotePortNu;
 277
 278     OCDevAddrToIPv4Addr((OCDevAddr *) clientResponse->addr, remoteIpAddr,
 279             remoteIpAddr + 1, remoteIpAddr + 2, remoteIpAddr + 3);
 280     OCDevAddrToPort((OCDevAddr *) clientResponse->addr, &remotePortNu);
 281
 282     //* Make a GET query*/
 283     std::ostringstream getQuery;
 284     getQuery << "coap://" << getIPAddrTBServer(clientResponse) << ":" << getPortTBServer(clientResponse) <<
 285     "/a/room" << queryInterface[TEST].text;
 286
 287     std::cout << "Get Query: " << getQuery.str() << std::endl;
 288
 289     cbData.cb = getReqCB;
 290     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 291     cbData.cd = NULL;
 292     ret = OCDoResource(&handle, OC_REST_GET, getQuery.str().c_str(), 0, 0, OC_LOW_QOS,
 293             &cbData, NULL, 0);
 294     if (ret != OC_STACK_OK)
 295     {
 296         OC_LOG(ERROR, TAG, "OCStack resource error");
 297     }
 298     return ret;
 299 }
 300
 301 int InitDiscovery()
 302 {
 303     OCStackResult ret;
 304     OCCallbackData cbData;
 305     OCDoHandle handle;
 306     /* Start a discovery query*/
 307     char szQueryUri[64] = { 0 };
 308
 309     strcpy(szQueryUri, OC_WELL_KNOWN_QUERY);
 310
 311     cbData.cb = discoveryReqCB;
 312     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
 313     cbData.cd = NULL;
 314     ret = OCDoResource(&handle, OC_REST_GET, szQueryUri, 0, 0, OC_LOW_QOS,
 315             &cbData, NULL, 0);
 316     if (ret != OC_STACK_OK)
 317     {
 318         OC_LOG(ERROR, TAG, "OCStack resource error");
 319     }
 320     return ret;
 321 }
 322
 323 int main(int argc, char* argv[]) {
 324     uint8_t addr[20] = {0};
 325     uint8_t* paddr = NULL;
 326     uint16_t port = USE_RANDOM_PORT;
 327     uint8_t ifname[] = "eth0";
 328     int opt;
 329
 330     while ((opt = getopt(argc, argv, "t:")) != -1)
 331     {
 332         switch(opt)
 333         {
 334         case 't':
 335             TEST = atoi(optarg);
 336             break;
 337         default:
 338             PrintUsage();
 339             return -1;
 340         }
 341     }
 342     if(TEST <= TEST_INVALID || TEST >= MAX_TESTS){
 343         PrintUsage();
 344         return -1;
 345     }
 346
 347     /*Get Ip address on defined interface and initialize coap on it with random port number
 348      * this port number will be used as a source port in all coap communications*/
 349     if ( OCGetInterfaceAddress(ifname, sizeof(ifname), AF_INET, addr,
 350                                sizeof(addr)) == ERR_SUCCESS)
 351     {
 352         OC_LOG_V(INFO, TAG, "Starting occlient on address %s",addr);
 353         paddr = addr;
 354     }
 355
 356     /* Initialize OCStack*/
 357     if (OCInit((char *) paddr, port, OC_CLIENT) != OC_STACK_OK) {
 358         OC_LOG(ERROR, TAG, "OCStack init error");
 359         return 0;
 360     }
 361
 362     InitDiscovery();
 363
 364     // Break from loop with Ctrl+C
 365     OC_LOG(INFO, TAG, "Entering occlient main loop...");
 366     signal(SIGINT, handleSigInt);
 367     while (!gQuitFlag) {
 368
 369         if (OCProcess() != OC_STACK_OK) {
 370             OC_LOG(ERROR, TAG, "OCStack process error");
 371             return 0;
 372         }
 373
 374         sleep(2);
 375     }
 376     OC_LOG(INFO, TAG, "Exiting occlient main loop...");
 377
 378     if (OCStop() != OC_STACK_OK) {
 379         OC_LOG(ERROR, TAG, "OCStack stop error");
 380     }
 381
 382     return 0;
 383 }
 384
 385 std::string getIPAddrTBServer(OCClientResponse * clientResponse) {
 386     if(!clientResponse) return "";
 387     if(!clientResponse->addr) return "";
 388     uint8_t a, b, c, d = 0;
 389     if(0 != OCDevAddrToIPv4Addr(clientResponse->addr, &a, &b, &c, &d) ) return "";
 390
 391     char ipaddr[16] = {'\0'};
 392     snprintf(ipaddr,  sizeof(ipaddr), "%d.%d.%d.%d", a,b,c,d); // ostringstream not working correctly here, hence snprintf
 393     //printf("IP address string of the TB server = %s\n", *out_ipaddr);
 394     return std::string (ipaddr);
 395 }
 396
 397
 398 std::string getPortTBServer(OCClientResponse * clientResponse){
 399     if(!clientResponse) return "";
 400     if(!clientResponse->addr) return "";
 401     uint16_t p = 0;
 402     if(0 != OCDevAddrToPort(clientResponse->addr, &p) ) return "";
 403     std::ostringstream ss;
 404     ss << p;
 405     return ss.str();
 406 }
 407
 408 std::string getQueryStrForGetPut(unsigned  const char * responsePayload){
 409
 410     std::string jsonPayload(reinterpret_cast<char*>(const_cast<unsigned char*>(responsePayload)));
 411
 412     return "/a/room";
 413 }