examples: Add notice about using experimental API
[iotivity.git] / resource / csdk / stack / samples / linux / SimpleClientServer / occlientbasicops.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 //      http://www.apache.org/licenses/LICENSE-2.0
11 //
12 // Unless required by applicable law or agreed to in writing, software
13 // distributed under the License is distributed on an "AS IS" BASIS,
14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 // See the License for the specific language governing permissions and
16 // limitations under the License.
17 //
18 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
19
20 #include "iotivity_config.h"
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <signal.h>
25 #ifdef HAVE_UNISTD_H
26 #include <unistd.h>
27 #endif
28 #ifdef HAVE_WINDOWS_H
29 #include <windows.h>
30 #endif
31 #include <stdint.h>
32 #include <sstream>
33 #include <iostream>
34 #include <getopt.h>
35
36 #include "ocstack.h"
37 #include "occlientbasicops.h"
38 #include "ocpayload.h"
39 #include "oic_malloc.h"
40 #include "oic_string.h"
41 #include "common.h"
42
43 /// This example is using experimental API, so there is no guarantee of support for future release,
44 /// nor any there any guarantee that breaking changes will not occur across releases.
45 #include "experimental/logger.h"
46 #include "experimental/payload_logging.h"
47
48 #define MAX_IP_ADDR_ST_SZ  16 //string size of "155.255.255.255" (15 + 1)
49 #define MAX_PORT_ST_SZ  6     //string size of "65535" (5 + 1)
50
51 // Including the NULL terminator, length of UUID string of the form:
52 // "a62389f7-afde-00b6-cd3e-12b97d2fcf09"
53 #define UUID_STRING_LENGTH sizeof("a62389f7-afde-00b6-cd3e-12b97d2fcf09")
54
55 static int UnicastDiscovery = 0;
56 static int TestCase = 0;
57 static int Connectivity = 0;
58
59 //The following variable determines the interface protocol (IP, etc)
60 //to be used for sending unicast messages. Default set to IP.
61 static OCConnectivityType ConnType = CT_ADAPTER_IP;
62 static const char *RESOURCE_DISCOVERY_QUERY = "%s/oic/res";
63
64 int gQuitFlag = 0;
65
66 struct ResourceNode *resourceList;
67 /*
68  * SIGINT handler: set gQuitFlag to 1 for graceful termination
69  * */
70 void handleSigInt(int signum)
71 {
72     if (signum == SIGINT)
73     {
74         gQuitFlag = 1;
75     }
76 }
77
78 OCPayload* putPayload()
79 {
80     OCRepPayload* payload = OCRepPayloadCreate();
81
82     if(!payload)
83     {
84         std::cout << "Failed to create put payload object"<<std::endl;
85         std::exit(1);
86     }
87
88     OCRepPayloadSetPropInt(payload, "power", 15);
89     OCRepPayloadSetPropBool(payload, "state", true);
90
91     return (OCPayload*) payload;
92 }
93
94 static void PrintUsage()
95 {
96     OIC_LOG(INFO, TAG, "Usage : occlient -u <0|1> -t <1|2|3> -c <0|1>");
97     OIC_LOG(INFO, TAG, "-u <0|1> : Perform multicast/unicast discovery of resources");
98     OIC_LOG(INFO, TAG, "-t 1 : Discover Resources");
99     OIC_LOG(INFO, TAG, "-t 2 : Discover Resources and"
100             " Initiate Nonconfirmable Get/Put/Post Requests");
101     OIC_LOG(INFO, TAG, "-t 3 : Discover Resources and Initiate "
102             "Confirmable Get/Put/Post Requests");
103     OIC_LOG(INFO, TAG, "-c 0 : Default auto-selection");
104     OIC_LOG(INFO, TAG, "-c 1 : IP Connectivity Type");
105 }
106
107 /*
108  * Returns the first resource in the list
109  */
110 const ResourceNode * getResource()
111 {
112     return resourceList;
113 }
114
115 OCStackResult InvokeOCDoResource(std::ostringstream &query,
116                                  OCMethod method,
117                                  const OCDevAddr *dest,
118                                  OCQualityOfService qos,
119                                  OCClientResponseHandler cb,
120                                  OCHeaderOption * options, uint8_t numOptions)
121 {
122     OCStackResult ret;
123     OCCallbackData cbData;
124
125     cbData.cb = cb;
126     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
127     cbData.cd = NULL;
128
129     OCPayload* payload = (method == OC_REST_PUT || method == OC_REST_POST) ? putPayload() : NULL;
130
131     ret = OCDoRequest(NULL, method, query.str().c_str(), dest,
132                       payload, CT_DEFAULT, qos, &cbData, options, numOptions);
133
134     OCPayloadDestroy(payload);
135
136     if (ret != OC_STACK_OK)
137     {
138         OIC_LOG_V(ERROR, TAG, "OCDoResource returns error %d with method %d",
139                  ret, method);
140     }
141
142     return ret;
143 }
144
145 OCStackApplicationResult putReqCB(void* ctx, OCDoHandle /*handle*/,
146                                   OCClientResponse * clientResponse)
147 {
148     if(ctx == (void*)DEFAULT_CONTEXT_VALUE)
149     {
150         OIC_LOG(INFO, TAG, "<====Callback Context for PUT received successfully====>");
151     }
152     else
153     {
154         OIC_LOG(ERROR, TAG, "<====Callback Context for PUT fail====>");
155     }
156
157     if(clientResponse)
158     {
159         OIC_LOG_PAYLOAD(INFO, clientResponse->payload);
160         OIC_LOG(INFO, TAG, ("=============> Put Response"));
161     }
162     else
163     {
164         OIC_LOG(ERROR, TAG, "<====PUT Callback fail to receive clientResponse====>\n");
165     }
166     return OC_STACK_DELETE_TRANSACTION;
167 }
168
169 OCStackApplicationResult postReqCB(void *ctx, OCDoHandle /*handle*/,
170                                    OCClientResponse *clientResponse)
171 {
172     if(ctx == (void*)DEFAULT_CONTEXT_VALUE)
173     {
174         OIC_LOG(INFO, TAG, "<====Callback Context for POST received successfully====>");
175     }
176     else
177     {
178         OIC_LOG(ERROR, TAG, "<====Callback Context for POST fail====>");
179     }
180
181     if(clientResponse)
182     {
183         OIC_LOG_PAYLOAD(INFO, clientResponse->payload);
184         OIC_LOG(INFO, TAG, ("=============> Post Response"));
185     }
186     else
187     {
188         OIC_LOG(ERROR, TAG, "<====POST Callback fail to receive clientResponse====>\n");
189     }
190
191     return OC_STACK_DELETE_TRANSACTION;
192 }
193
194 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle /*handle*/,
195                                   OCClientResponse * clientResponse)
196 {
197     if (ctx == (void*) DEFAULT_CONTEXT_VALUE)
198     {
199         OIC_LOG(INFO, TAG, "<====Callback Context for GET received successfully====>");
200     }
201     else
202     {
203         OIC_LOG(ERROR, TAG, "<====Callback Context for GET fail====>");
204     }
205
206     if (clientResponse)
207     {
208         OIC_LOG_V(INFO, TAG, "StackResult: %s",  getResult(clientResponse->result));
209         OIC_LOG_V(INFO, TAG, "SEQUENCE NUMBER: %d", clientResponse->sequenceNumber);
210         OIC_LOG_PAYLOAD(INFO, clientResponse->payload);
211         OIC_LOG(INFO, TAG, ("=============> Get Response"));
212
213         if (clientResponse->numRcvdVendorSpecificHeaderOptions > 0 )
214         {
215             OIC_LOG (INFO, TAG, "Received vendor specific options");
216             uint8_t i = 0;
217             OCHeaderOption * rcvdOptions = clientResponse->rcvdVendorSpecificHeaderOptions;
218             for (i = 0; i < clientResponse->numRcvdVendorSpecificHeaderOptions; i++)
219             {
220                 if (((OCHeaderOption) rcvdOptions[i]).protocolID == OC_COAP_ID)
221                 {
222                     OIC_LOG_V(INFO, TAG, "Received option with OC_COAP_ID and ID %u with",
223                             ((OCHeaderOption)rcvdOptions[i]).optionID );
224
225                     OIC_LOG_BUFFER(INFO, TAG, ((OCHeaderOption)rcvdOptions[i]).optionData,
226                         MAX_HEADER_OPTION_DATA_LENGTH);
227                 }
228             }
229         }
230     }
231     else
232     {
233         OIC_LOG(ERROR, TAG, "<====GET Callback fail to receive clientResponse====>\n");
234     }
235     return OC_STACK_DELETE_TRANSACTION;
236 }
237
238 /*
239  * This is a function called back when a device is discovered
240  */
241 OCStackApplicationResult discoveryReqCB(void* ctx, OCDoHandle /*handle*/,
242                                         OCClientResponse * clientResponse)
243 {
244     if (ctx == (void*)DEFAULT_CONTEXT_VALUE)
245     {
246         OIC_LOG(INFO, TAG, "\n<====Callback Context for DISCOVERY query "
247                "received successfully====>");
248     }
249     else
250     {
251         OIC_LOG(ERROR, TAG, "\n<====Callback Context for DISCOVERY fail====>");
252     }
253
254     if (clientResponse && clientResponse->result == OC_STACK_OK)
255     {
256         OIC_LOG_V(INFO, TAG,
257                 "Device =============> Discovered @ %s:%d",
258                 clientResponse->devAddr.addr,
259                 clientResponse->devAddr.port);
260         OIC_LOG_PAYLOAD(INFO, clientResponse->payload);
261
262         collectUniqueResource(clientResponse);
263     }
264     else
265     {
266         OIC_LOG(ERROR, TAG, "<====DISCOVERY Callback fail to receive clientResponse====>\n");
267     }
268     return (UnicastDiscovery) ?
269            OC_STACK_DELETE_TRANSACTION : OC_STACK_KEEP_TRANSACTION ;
270 }
271
272 int InitPutRequest(OCQualityOfService qos)
273 {
274     std::ostringstream query;
275     //Get most recently inserted resource
276     const ResourceNode * resource  = getResource();
277
278     if(!resource)
279     {
280         OIC_LOG_V(ERROR, TAG, "Resource null, can't do PUT request\n");
281         return -1;
282     }
283     query << resource->uri;
284     OIC_LOG_V(INFO, TAG,"Executing InitPutRequest, Query: %s", query.str().c_str());
285
286     return (InvokeOCDoResource(query, OC_REST_PUT, &resource->endpoint,
287            ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
288             putReqCB, NULL, 0));
289 }
290
291 int InitPostRequest(OCQualityOfService qos)
292 {
293     OCStackResult result;
294     std::ostringstream query;
295     //Get most recently inserted resource
296     const ResourceNode *resource  = getResource();
297
298     if(!resource)
299     {
300         OIC_LOG_V(ERROR, TAG, "Resource null, can't do POST request\n");
301         return -1;
302     }
303
304     query << resource->uri;
305     OIC_LOG_V(INFO, TAG,"Executing InitPostRequest, Query: %s", query.str().c_str());
306
307     // First PUT operation (to create an LED instance)
308     result = InvokeOCDoResource(query, OC_REST_PUT, &resource->endpoint,
309             ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
310             putReqCB, NULL, 0);
311     if (OC_STACK_OK != result)
312     {
313         // Error can happen if for example, network connectivity is down
314         OIC_LOG(ERROR, TAG, "First POST call did not succeed");
315     }
316
317     // Second PUT operation (to create an LED instance)
318     result = InvokeOCDoResource(query, OC_REST_PUT, &resource->endpoint,
319             ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
320             putReqCB, NULL, 0);
321     if (OC_STACK_OK != result)
322     {
323         OIC_LOG(ERROR, TAG, "Second POST call did not succeed");
324     }
325
326     // This POST operation will update the original resourced /a/led
327     return (InvokeOCDoResource(query, OC_REST_POST, &resource->endpoint,
328                 ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
329                 postReqCB, NULL, 0));
330 }
331
332 int InitGetRequest(OCQualityOfService qos)
333 {
334     std::ostringstream query;
335     //Get most recently inserted resource
336     const ResourceNode * resource  = getResource();
337
338     if(!resource)
339     {
340         OIC_LOG_V(ERROR, TAG, "Resource null, can't do GET request\n");
341         return -1;
342     }
343     query << resource->uri;
344     OIC_LOG_V(INFO, TAG,"Executing InitGetRequest, Query: %s", query.str().c_str());
345
346     return (InvokeOCDoResource(query, OC_REST_GET, &resource->endpoint,
347             (qos == OC_HIGH_QOS)?OC_HIGH_QOS:OC_LOW_QOS, getReqCB, NULL, 0));
348 }
349
350 int InitDiscovery()
351 {
352     OCStackResult ret;
353     OCCallbackData cbData;
354     char queryUri[200];
355     char ipaddr[100] = { '\0' };
356
357     if (UnicastDiscovery)
358     {
359         OIC_LOG(INFO, TAG, "Enter IP address (with optional port) of the Server hosting resource\n");
360         OIC_LOG(INFO, TAG, "IPv4: 192.168.0.15:45454\n");
361         OIC_LOG(INFO, TAG, "IPv6: [fe80::20c:29ff:fe1b:9c5]:45454\n");
362
363         if (fgets(ipaddr, sizeof (ipaddr), stdin))
364         {
365             StripNewLineChar(ipaddr); //Strip newline char from ipaddr
366         }
367         else
368         {
369             OIC_LOG(ERROR, TAG, "!! Bad input for IP address. !!");
370             return OC_STACK_INVALID_PARAM;
371         }
372     }
373
374     snprintf(queryUri, sizeof (queryUri), RESOURCE_DISCOVERY_QUERY, ipaddr);
375
376     cbData.cb = discoveryReqCB;
377     cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
378     cbData.cd = NULL;
379
380     ret = OCDoRequest(NULL, OC_REST_DISCOVER, queryUri, 0, 0, CT_DEFAULT,
381                       OC_LOW_QOS, &cbData, NULL, 0);
382     if (ret != OC_STACK_OK)
383     {
384         OIC_LOG(ERROR, TAG, "OCStack resource error");
385     }
386     return ret;
387 }
388
389 void queryResource()
390 {
391     switch(TestCase)
392     {
393         case TEST_DISCOVER_REQ:
394             break;
395         case TEST_NON_CON_OP:
396             InitGetRequest(OC_LOW_QOS);
397             InitPutRequest(OC_LOW_QOS);
398             InitPostRequest(OC_LOW_QOS);
399             break;
400         case TEST_CON_OP:
401             InitGetRequest(OC_HIGH_QOS);
402             InitPutRequest(OC_HIGH_QOS);
403             InitPostRequest(OC_HIGH_QOS);
404             break;
405         default:
406             PrintUsage();
407             break;
408     }
409 }
410
411
412 void collectUniqueResource(const OCClientResponse * clientResponse)
413 {
414     OCDiscoveryPayload* pay = (OCDiscoveryPayload*) clientResponse->payload;
415     OCResourcePayload* res = pay->resources;
416
417     char sidStr[UUID_STRING_LENGTH];
418
419     while(res) {
420
421         int ret = snprintf(sidStr, UUID_STRING_LENGTH,
422                 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
423                 pay->sid[0], pay->sid[1], pay->sid[2], pay->sid[3],
424                 pay->sid[4], pay->sid[5], pay->sid[6], pay->sid[7],
425                 pay->sid[8], pay->sid[9], pay->sid[10], pay->sid[11],
426                 pay->sid[12], pay->sid[13], pay->sid[14], pay->sid[15]
427                 );
428
429         if (ret == (UUID_STRING_LENGTH - 1))
430         {
431             if(insertResource(sidStr, res->uri, clientResponse) == 1)
432             {
433                 OIC_LOG_V(INFO,TAG,"%s%s%s%s\n",sidStr, ":", res->uri, " is new");
434                 printResourceList();
435                 queryResource();
436             }
437             else {
438                 OIC_LOG_V(INFO,TAG,"%s%s%s%s\n",sidStr, ":", res->uri, " is old");
439             }
440         }
441         else
442         {
443             OIC_LOG(ERROR, TAG, "Could Not Retrieve the Server ID");
444         }
445
446         res = res->next;
447     }
448 }
449
450 /* This function searches for the resource(sid:uri) in the ResourceList.
451  * If the Resource is found in the list then it returns 0 else insert
452  * the resource to front of the list and returns 1.
453  */
454 int insertResource(const char * sid, char const * uri,
455             const OCClientResponse * clientResponse)
456 {
457     ResourceNode * iter = resourceList;
458     char * sid_cpy =  OICStrdup(sid);
459     char * uri_cpy = OICStrdup(uri);
460
461     //Checking if the resource(sid:uri) is new
462     while(iter)
463     {
464         if((strcmp(iter->sid, sid) == 0) && (strcmp(iter->uri, uri) == 0))
465         {
466             OICFree(sid_cpy);
467             OICFree(uri_cpy);
468             return 0;
469         }
470         else
471         {
472             iter = iter->next;
473         }
474     }
475
476     //Creating new ResourceNode
477     if((iter = (ResourceNode *) OICMalloc(sizeof(ResourceNode))))
478     {
479         iter->sid = sid_cpy;
480         iter->uri = uri_cpy;
481         iter->endpoint = clientResponse->devAddr;
482         iter->next = NULL;
483     }
484     else
485     {
486         OIC_LOG(ERROR, TAG, "Memory not allocated to ResourceNode");
487         OICFree(sid_cpy);
488         OICFree(uri_cpy);
489         return -1;
490     }
491
492     //Adding new ResourceNode to front of the ResourceList
493     if(!resourceList)
494     {
495         resourceList = iter;
496     }
497     else
498     {
499         iter->next = resourceList;
500         resourceList = iter;
501     }
502     return 1;
503 }
504
505 void printResourceList()
506 {
507     ResourceNode * iter;
508     iter = resourceList;
509     OIC_LOG(INFO, TAG, "Resource List: ");
510     while(iter)
511     {
512         OIC_LOG(INFO, TAG, "*****************************************************");
513         OIC_LOG_V(INFO, TAG, "sid = %s",iter->sid);
514         OIC_LOG_V(INFO, TAG, "uri = %s", iter->uri);
515         OIC_LOG_V(INFO, TAG, "ip = %s", iter->endpoint.addr);
516         OIC_LOG_V(INFO, TAG, "port = %d", iter->endpoint.port);
517         switch (iter->endpoint.adapter)
518         {
519             case OC_ADAPTER_IP:
520                 OIC_LOG(INFO, TAG, "connType = Default (IPv4)");
521                 break;
522             case OC_ADAPTER_GATT_BTLE:
523                 OIC_LOG(INFO, TAG, "connType = BLE");
524                 break;
525             case OC_ADAPTER_RFCOMM_BTEDR:
526                 OIC_LOG(INFO, TAG, "connType = BT");
527                 break;
528             default:
529                 OIC_LOG(INFO, TAG, "connType = Invalid connType");
530                 break;
531         }
532         OIC_LOG(INFO, TAG, "*****************************************************");
533         iter = iter->next;
534     }
535 }
536
537 void freeResourceList()
538 {
539     OIC_LOG(INFO, TAG, "Freeing ResourceNode List");
540     ResourceNode * temp;
541     while(resourceList)
542     {
543
544         temp = resourceList;
545         resourceList = resourceList->next;
546         OICFree((void *)temp->sid);
547         OICFree((void *)temp->uri);
548         OICFree(temp);
549     }
550     resourceList = NULL;
551 }
552
553 int main(int argc, char* argv[])
554 {
555     int opt;
556     resourceList = NULL;
557     while ((opt = getopt(argc, argv, "u:t:c:")) != -1)
558     {
559         switch(opt)
560         {
561             case 'u':
562                 UnicastDiscovery = atoi(optarg);
563                 break;
564             case 't':
565                 TestCase = atoi(optarg);
566                 break;
567             case 'c':
568                 Connectivity = atoi(optarg);
569                 break;
570             default:
571                 PrintUsage();
572                 return -1;
573         }
574     }
575
576     if ((UnicastDiscovery != 0 && UnicastDiscovery != 1) ||
577         (TestCase < TEST_DISCOVER_REQ || TestCase >= MAX_TESTS) ||
578         (Connectivity < CT_ADAPTER_DEFAULT || Connectivity >= MAX_CT))
579     {
580         PrintUsage();
581         return -1;
582     }
583
584     /* Initialize OCStack*/
585     if (OCInit1(OC_CLIENT, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS) != OC_STACK_OK)
586     {
587         OIC_LOG(ERROR, TAG, "OCStack init error");
588         return 0;
589     }
590
591     if(Connectivity == CT_ADAPTER_DEFAULT || Connectivity ==  CT_IP)
592     {
593         ConnType =  CT_ADAPTER_IP;//CT_DEFAULT;
594     }
595     else
596     {
597         OIC_LOG(INFO, TAG, "Default Connectivity type selected");
598         PrintUsage();
599     }
600
601     InitDiscovery();
602
603     // Break from loop with Ctrl+C
604     signal(SIGINT, handleSigInt);
605
606     while (!gQuitFlag)
607     {
608         if (OCProcess() != OC_STACK_OK)
609         {
610             OIC_LOG(ERROR, TAG, "OCStack process error");
611             return 0;
612         }
613         sleep(2);
614     }
615
616     freeResourceList();
617     OIC_LOG(INFO, TAG, "Exiting occlient main loop...");
618     if (OCStop() != OC_STACK_OK)
619     {
620         OIC_LOG(ERROR, TAG, "OCStack stop error");
621     }
622     return 0;
623 }
624
625