1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
30 const char *getResult(OCStackResult result);
31 std::string getIPAddrTBServer(OCClientResponse * clientResponse);
32 std::string getPortTBServer(OCClientResponse * clientResponse);
33 std::string getQueryStrForGetPut(const char * responsePayload);
35 #define TAG PCF("occlient")
36 #define DEFAULT_CONTEXT_VALUE 0x99
37 #ifndef MAX_LENGTH_IPv4_ADDR
38 #define MAX_LENGTH_IPv4_ADDR 16
50 TEST_UNKNOWN_RESOURCE_GET_DEFAULT,
51 TEST_UNKNOWN_RESOURCE_GET_BATCH,
52 TEST_UNKNOWN_RESOURCE_GET_LINK_LIST,
56 unsigned static int TEST = TEST_INVALID;
64 testToTextMap queryInterface[] = {
65 {"invalid", TEST_INVALID},
66 {"?if=oc.mi.def", TEST_GET_DEFAULT},
67 {"?if=oc.mi.b", TEST_GET_BATCH},
68 {"?if=oc.mi.ll", TEST_GET_LINK_LIST},
69 {"?if=oc.mi.def", TEST_UNKNOWN_RESOURCE_GET_DEFAULT},
70 {"?if=oc.mi.b", TEST_UNKNOWN_RESOURCE_GET_BATCH},
71 {"?if=oc.mi.ll", TEST_UNKNOWN_RESOURCE_GET_LINK_LIST},
72 {"?if=oc.mi.def", TEST_PUT_DEFAULT},
73 {"?if=oc.mi.b", TEST_PUT_BATCH},
74 {"?if=oc.mi.ll", TEST_PUT_LINK_LIST},
77 static std::string putPayload = "{\"state\":\"off\",\"power\":\"0\"}";
79 //The following variable determines the interface (wifi, ethernet etc.)
80 //to be used for sending unicast messages. Default set to WIFI.
81 static OCConnectivityType OC_CONNTYPE = OC_WIFI;
82 static const char * MULTICAST_RESOURCE_DISCOVERY_QUERY = "/oc/core";
84 // The handle for the observe registration
85 OCDoHandle gObserveDoHandle;
86 // After this crosses a threshold client deregisters for further observations
87 int gNumObserveNotifies = 1;
90 /* SIGINT handler: set gQuitFlag to 1 for graceful termination */
91 void handleSigInt(int signum)
99 // Forward Declaration
100 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse);
101 int InitGetRequestToUnavailableResource(OCClientResponse * clientResponse);
102 int InitObserveRequest(OCClientResponse * clientResponse);
103 int InitPutRequest(OCClientResponse * clientResponse);
104 int InitGetRequest(OCClientResponse * clientResponse);
109 OC_LOG(INFO, TAG, "Usage : occlientcoll -t <Test Case> -c <CA connectivity Type>");
110 OC_LOG(INFO, TAG, "-c <0|1> : Send messages over Ethernet or WIFI");
111 OC_LOG(INFO, TAG, "Test Case 1 : Discover Resources && Initiate GET Request on an"\
112 "available resource using default interface.");
113 OC_LOG(INFO, TAG, "Test Case 2 : Discover Resources && Initiate GET Request on an"\
114 "available resource using batch interface.");
115 OC_LOG(INFO, TAG, "Test Case 3 : Discover Resources && Initiate GET Request on an"\
116 "available resource using link list interface.");
117 OC_LOG(INFO, TAG, "Test Case 4 : Discover Resources && Initiate GET & PUT Request on an"\
118 "available resource using default interface.");
119 OC_LOG(INFO, TAG, "Test Case 5 : Discover Resources && Initiate GET & PUT Request on an"\
120 "available resource using batch interface.");
121 OC_LOG(INFO, TAG, "Test Case 6 : Discover Resources && Initiate GET & PUT Request on an"\
122 "available resource using link list interface.");
123 OC_LOG(INFO, TAG, "Test Case 7 : Discover Resources && Initiate GET Request on an"\
124 "unavailable resource using default interface.");
125 OC_LOG(INFO, TAG, "Test Case 8 : Discover Resources && Initiate GET Request on an"\
126 "unavailable resource using batch interface.");
127 OC_LOG(INFO, TAG, "Test Case 9 : Discover Resources && Initiate GET Request on an"\
128 "unavailable resource using link list interface.");
131 OCStackApplicationResult putReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse)
133 if(clientResponse == NULL)
135 OC_LOG(INFO, TAG, "The clientResponse is NULL");
136 return OC_STACK_DELETE_TRANSACTION;
138 if(ctx == (void*)DEFAULT_CONTEXT_VALUE)
140 OC_LOG_V(INFO, TAG, "Callback Context for PUT query recvd successfully");
141 OC_LOG_V(INFO, TAG, "JSON = %s =============> Discovered", clientResponse->resJSONPayload);
144 return OC_STACK_KEEP_TRANSACTION;
147 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse)
149 OC_LOG_V(INFO, TAG, "StackResult: %s",
150 getResult(clientResponse->result));
151 if(ctx == (void*)DEFAULT_CONTEXT_VALUE)
153 OC_LOG_V(INFO, TAG, "SEQUENCE NUMBER: %d", clientResponse->sequenceNumber);
154 if(clientResponse->sequenceNumber == 0)
156 OC_LOG_V(INFO, TAG, "Callback Context for GET query recvd successfully");
157 OC_LOG_V(INFO, TAG, "Fnd' Rsrc': %s", clientResponse->resJSONPayload);
161 OC_LOG_V(INFO, TAG, "Callback Context for Get recvd successfully %d",
162 gNumObserveNotifies);
163 OC_LOG_V(INFO, TAG, "Fnd' Rsrc': %s", clientResponse->resJSONPayload);
164 gNumObserveNotifies++;
165 if (gNumObserveNotifies == 3)
167 if (OCCancel (gObserveDoHandle, OC_LOW_QOS, NULL, 0) != OC_STACK_OK)
169 OC_LOG(ERROR, TAG, "Observe cancel error");
174 if(TEST == TEST_PUT_DEFAULT || TEST == TEST_PUT_BATCH || TEST == TEST_PUT_LINK_LIST)
176 InitPutRequest(clientResponse);
178 return OC_STACK_KEEP_TRANSACTION;
182 // This is a function called back when a device is discovered
183 OCStackApplicationResult discoveryReqCB(void* ctx, OCDoHandle handle,
184 OCClientResponse * clientResponse)
186 uint8_t remoteIpAddr[4];
187 uint16_t remotePortNu;
190 "Entering discoveryReqCB (Application Layer CB)");
191 OC_LOG_V(INFO, TAG, "StackResult: %s",
192 getResult(clientResponse->result));
194 if (ctx == (void*) DEFAULT_CONTEXT_VALUE)
196 OC_LOG_V(INFO, TAG, "Callback Context recvd successfully");
199 OCDevAddrToIPv4Addr((OCDevAddr *) clientResponse->addr, remoteIpAddr,
200 remoteIpAddr + 1, remoteIpAddr + 2, remoteIpAddr + 3);
201 OCDevAddrToPort((OCDevAddr *) clientResponse->addr, &remotePortNu);
204 "Device =============> Discovered %s @ %d.%d.%d.%d:%d",
205 clientResponse->resJSONPayload, remoteIpAddr[0], remoteIpAddr[1],
206 remoteIpAddr[2], remoteIpAddr[3], remotePortNu);
208 if(TEST == TEST_UNKNOWN_RESOURCE_GET_DEFAULT || TEST == TEST_UNKNOWN_RESOURCE_GET_BATCH ||\
209 TEST == TEST_UNKNOWN_RESOURCE_GET_LINK_LIST)
211 InitGetRequestToUnavailableResource(clientResponse);
215 InitGetRequest(clientResponse);
217 return OC_STACK_KEEP_TRANSACTION;
221 int InitGetRequestToUnavailableResource(OCClientResponse * clientResponse)
224 OCCallbackData cbData;
225 std::ostringstream getQuery;
226 getQuery << "coap://" << getIPAddrTBServer(clientResponse) << ":" <<
227 getPortTBServer(clientResponse) << "/SomeUnknownResource";
228 cbData.cb = getReqCB;
229 cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
232 ret = OCDoResource(NULL, OC_REST_GET, getQuery.str().c_str(), 0, 0, OC_CONNTYPE, OC_LOW_QOS,
234 if (ret != OC_STACK_OK)
236 OC_LOG(ERROR, TAG, "OCStack resource error");
242 int InitObserveRequest(OCClientResponse * clientResponse)
245 OCCallbackData cbData;
247 std::ostringstream obsReg;
248 obsReg << "coap://" << getIPAddrTBServer(clientResponse) << ":" <<
249 getPortTBServer(clientResponse) <<
250 getQueryStrForGetPut(clientResponse->resJSONPayload);
251 cbData.cb = getReqCB;
252 cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
254 OC_LOG_V(INFO, TAG, "OBSERVE payload from client = %s ", putPayload.c_str());
256 ret = OCDoResource(&handle, OC_REST_OBSERVE, obsReg.str().c_str(), 0, 0, OC_CONNTYPE,
257 OC_LOW_QOS, &cbData, NULL, 0);
258 if (ret != OC_STACK_OK)
260 OC_LOG(ERROR, TAG, "OCStack resource error");
264 gObserveDoHandle = handle;
270 int InitPutRequest(OCClientResponse * clientResponse)
273 OCCallbackData cbData;
274 //* Make a PUT query*/
275 std::ostringstream getQuery;
276 getQuery << "coap://" << getIPAddrTBServer(clientResponse) << ":" <<
277 getPortTBServer(clientResponse) <<
278 "/a/room" << queryInterface[TEST].text;
279 cbData.cb = putReqCB;
280 cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
282 OC_LOG_V(INFO, TAG, "PUT payload from client = %s ", putPayload.c_str());
284 ret = OCDoResource(NULL, OC_REST_PUT, getQuery.str().c_str(), 0, putPayload.c_str(),
285 OC_CONNTYPE, OC_LOW_QOS, &cbData, NULL, 0);
286 if (ret != OC_STACK_OK)
288 OC_LOG(ERROR, TAG, "OCStack resource error");
294 int InitGetRequest(OCClientResponse * clientResponse)
297 OCCallbackData cbData;
299 uint8_t remoteIpAddr[4];
300 uint16_t remotePortNu;
302 OCDevAddrToIPv4Addr((OCDevAddr *) clientResponse->addr, remoteIpAddr,
303 remoteIpAddr + 1, remoteIpAddr + 2, remoteIpAddr + 3);
304 OCDevAddrToPort((OCDevAddr *) clientResponse->addr, &remotePortNu);
306 //* Make a GET query*/
307 std::ostringstream getQuery;
308 getQuery << "coap://" << getIPAddrTBServer(clientResponse) << ":" <<
309 getPortTBServer(clientResponse) <<
310 "/a/room" << queryInterface[TEST].text;
312 std::cout << "Get Query: " << getQuery.str() << std::endl;
314 cbData.cb = getReqCB;
315 cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
317 ret = OCDoResource(NULL, OC_REST_GET,
318 getQuery.str().c_str(), 0, 0, OC_CONNTYPE, OC_LOW_QOS,
320 if (ret != OC_STACK_OK)
322 OC_LOG(ERROR, TAG, "OCStack resource error");
330 OCCallbackData cbData;
331 /* Start a discovery query*/
332 char szQueryUri[64] = { 0 };
334 strcpy(szQueryUri, MULTICAST_RESOURCE_DISCOVERY_QUERY);
336 cbData.cb = discoveryReqCB;
337 cbData.context = (void*)DEFAULT_CONTEXT_VALUE;
339 ret = OCDoResource(NULL, OC_REST_GET, szQueryUri, 0, 0, OC_ALL,
342 if (ret != OC_STACK_OK)
344 OC_LOG(ERROR, TAG, "OCStack resource error");
349 int main(int argc, char* argv[])
353 while ((opt = getopt(argc, argv, "t:c:")) != -1)
361 OC_CONNTYPE = OCConnectivityType(atoi(optarg));
368 if (TEST <= TEST_INVALID || TEST >= MAX_TESTS)
374 /* Initialize OCStack*/
375 if (OCInit(NULL, 0, OC_CLIENT) != OC_STACK_OK)
377 OC_LOG(ERROR, TAG, "OCStack init error");
383 // Break from loop with Ctrl+C
384 OC_LOG(INFO, TAG, "Entering occlient main loop...");
385 signal(SIGINT, handleSigInt);
389 if (OCProcess() != OC_STACK_OK)
391 OC_LOG(ERROR, TAG, "OCStack process error");
396 } OC_LOG(INFO, TAG, "Exiting occlient main loop...");
398 if (OCStop() != OC_STACK_OK)
400 OC_LOG(ERROR, TAG, "OCStack stop error");
406 std::string getIPAddrTBServer(OCClientResponse * clientResponse)
412 if (!clientResponse->addr)
416 uint8_t a, b, c, d = 0;
417 if (0 != OCDevAddrToIPv4Addr(clientResponse->addr, &a, &b, &c, &d))
422 char ipaddr[16] = {'\0'};
423 // ostringstream not working correctly here, hence snprintf
424 snprintf(ipaddr, sizeof(ipaddr), "%d.%d.%d.%d", a,b,c,d);
425 return std::string (ipaddr);
428 std::string getPortTBServer(OCClientResponse * clientResponse)
434 if (!clientResponse->addr)
439 if (0 != OCDevAddrToPort(clientResponse->addr, &p))
443 std::ostringstream ss;
448 std::string getQueryStrForGetPut(const char * responsePayload)
451 std::string jsonPayload(responsePayload);