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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
22 /// This sample provides steps to define an interface for a resource
23 /// (properties and methods) and host this resource on the server.
26 #include "iotivity_config.h"
33 #include <condition_variable>
35 #include "OCPlatform.h"
42 #include "ocpayload.h"
46 namespace PH = std::placeholders;
49 void * ChangeLightRepresentation (void *param);
51 // Set of strings for each of platform Info fields
52 std::string platformId = "0A3E0D6F-DBF5-404E-8719-D6880042463A";
53 std::string manufacturerName = "OCF";
54 std::string manufacturerLink = "https://www.iotivity.org";
55 std::string modelNumber = "myModelNumber";
56 std::string dateOfManufacture = "2016-01-15";
57 std::string platformVersion = "myPlatformVersion";
58 std::string operatingSystemVersion = "myOS";
59 std::string hardwareVersion = "myHardwareVersion";
60 std::string firmwareVersion = "1.0";
61 std::string supportLink = "https://www.iotivity.org";
62 std::string systemTime = "2016-01-15T11.01";
64 // Set of strings for each of device info fields
65 std::string deviceName = "IoTivity Simple Server HQ";
66 std::string specVersion = "core.1.1.0";
67 std::string dataModelVersions = "res.1.1.0";
69 // OCPlatformInfo Contains all the platform info to be stored
70 OCPlatformInfo platformInfo;
72 // OCDeviceInfo Contains all the device info to be stored
73 OCDeviceInfo deviceInfo;
75 // Specifies where to notify all observers or list of observers
76 // 0 - notifies all observers
77 // 1 - notifies list of observers
78 int isListOfObservers = 0;
80 /// This class represents a single resource named 'lightResource'. This resource has
81 /// two simple properties named 'state' and 'power'
87 /// Access this property from a TB client
91 std::string m_lightUri;
92 OCResourceHandle m_resourceHandle;
93 OCRepresentation m_lightRep;
94 ObservationIds m_interestedObservers;
98 LightResource(PlatformConfig& /*cfg*/)
99 :m_name("John's light"), m_state(false), m_power(0), m_lightUri("/a/light") {
100 // Initialize representation
101 m_lightRep.setUri(m_lightUri);
103 m_lightRep.setValue("state", m_state);
104 m_lightRep.setValue("power", m_power);
105 m_lightRep.setValue("name", m_name);
108 /* Note that this does not need to be a member function: for classes you do not have
109 access to, you can accomplish this with a free function: */
111 /// This function internally calls registerResource API.
112 void createResource()
114 std::string resourceURI = m_lightUri; // URI of the resource
115 // resource type name. In this case, it is light
116 std::string resourceTypeName = "core.light";
117 std::string resourceInterface = DEFAULT_INTERFACE; // resource interface.
119 // OCResourceProperty is defined ocstack.h
120 uint8_t resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
122 EntityHandler cb = std::bind(&LightResource::entityHandler, this,PH::_1);
124 // This will internally create and register the resource.
125 OCStackResult result = OCPlatform::registerResource(
126 m_resourceHandle, resourceURI, resourceTypeName,
127 resourceInterface, cb, resourceProperty);
129 if (OC_STACK_OK != result)
131 cout << "Resource creation was unsuccessful\n";
135 OCStackResult createResource1()
137 std::string resourceURI = "/a/light1"; // URI of the resource
138 std::string resourceTypeName = "core.light"; // resource type name. In this case, it is light
139 std::string resourceInterface = DEFAULT_INTERFACE; // resource interface.
141 // OCResourceProperty is defined ocstack.h
142 uint8_t resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
144 EntityHandler cb = std::bind(&LightResource::entityHandler, this,PH::_1);
146 OCResourceHandle resHandle;
148 // This will internally create and register the resource.
149 OCStackResult result = OCPlatform::registerResource(
150 resHandle, resourceURI, resourceTypeName,
151 resourceInterface, cb, resourceProperty);
153 if (OC_STACK_OK != result)
155 cout << "Resource creation was unsuccessful\n";
161 OCResourceHandle getHandle()
163 return m_resourceHandle;
166 // Puts representation.
167 // Gets values from the representation and
168 // updates the internal state
169 void put(OCRepresentation& rep)
172 if (rep.getValue("state", m_state))
174 cout << "\t\t\t\t" << "state: " << m_state << endl;
178 cout << "\t\t\t\t" << "state not found in the representation" << endl;
181 if (rep.getValue("power", m_power))
183 cout << "\t\t\t\t" << "power: " << m_power << endl;
187 cout << "\t\t\t\t" << "power not found in the representation" << endl;
192 cout << e.what() << endl;
197 // Post representation.
198 // Post can create new resource or simply act like put.
199 // Gets values from the representation and
200 // updates the internal state
201 OCRepresentation post(OCRepresentation& rep)
203 static int first = 1;
205 std::cout << "In POST\n";
207 // for the first time it tries to create a resource
210 std::cout << "In POST/First\n";
214 if(OC_STACK_OK == createResource1())
216 std::cout << "Created a new resource\n";
217 OCRepresentation rep1;
218 rep1.setValue("createduri", std::string("/a/light1"));
224 // from second time onwards it just puts
230 // gets the updated representation.
231 // Updates the representation with latest internal state before
233 OCRepresentation get()
235 m_lightRep.setValue("state", m_state);
236 m_lightRep.setValue("power", m_power);
241 void addType(const std::string& type) const
243 OCStackResult result = OCPlatform::bindTypeToResource(m_resourceHandle, type);
244 if (OC_STACK_OK != result)
246 cout << "Binding TypeName to Resource was unsuccessful\n";
250 void addInterface(const std::string& iface) const
252 OCStackResult result = OCPlatform::bindInterfaceToResource(m_resourceHandle, iface);
253 if (OC_STACK_OK != result)
255 cout << "Binding TypeName to Resource was unsuccessful\n";
261 OCStackResult sendResponse(std::shared_ptr<OCResourceRequest> pRequest)
263 auto pResponse = std::make_shared<OC::OCResourceResponse>();
264 pResponse->setRequestHandle(pRequest->getRequestHandle());
265 pResponse->setResourceHandle(pRequest->getResourceHandle());
266 pResponse->setResourceRepresentation(get());
267 pResponse->setErrorCode(200);
268 pResponse->setResponseResult(OC_EH_OK);
270 return OCPlatform::sendResponse(pResponse);
273 OCStackResult sendPostResponse(std::shared_ptr<OCResourceRequest> pRequest)
275 auto pResponse = std::make_shared<OC::OCResourceResponse>();
276 pResponse->setRequestHandle(pRequest->getRequestHandle());
277 pResponse->setResourceHandle(pRequest->getResourceHandle());
279 OCRepresentation rep = pRequest->getResourceRepresentation();
280 OCRepresentation rep_post = post(rep);
282 pResponse->setResourceRepresentation(rep_post);
283 pResponse->setErrorCode(200);
284 pResponse->setResponseResult(OC_EH_OK);
286 return OCPlatform::sendResponse(pResponse);
289 // This is just a sample implementation of entity handler.
290 // Entity handler can be implemented in several ways by the manufacturer
291 OCEntityHandlerResult entityHandler(std::shared_ptr<OCResourceRequest> request)
293 cout << "\tIn Server CPP entity handler:\n";
294 OCEntityHandlerResult ehResult = OC_EH_ERROR;
298 // Get the request type and request flag
299 std::string requestType = request->getRequestType();
300 int requestFlag = request->getRequestHandlerFlag();
302 if(requestFlag & RequestHandlerFlag::RequestFlag)
304 cout << "\t\trequestFlag : Request\n";
306 // If the request type is GET
307 if(requestType == "GET")
309 cout << "\t\t\trequestType : GET\n";
310 if(OC_STACK_OK == sendResponse(request))
315 else if(requestType == "PUT")
317 cout << "\t\t\trequestType : PUT\n";
319 OCRepresentation rep = request->getResourceRepresentation();
320 // Do related operations related to PUT request
321 // Update the lightResource
323 if(OC_STACK_OK == sendResponse(request))
328 else if(requestType == "POST")
330 cout << "\t\t\trequestType : POST\n";
331 if(OC_STACK_OK == sendPostResponse(request))
336 else if(requestType == "DELETE")
338 // DELETE request operations
342 if(requestFlag & RequestHandlerFlag::ObserverFlag)
344 ObservationInfo observationInfo = request->getObservationInfo();
345 if(ObserveAction::ObserveRegister == observationInfo.action)
347 m_interestedObservers.push_back(observationInfo.obsId);
349 else if(ObserveAction::ObserveUnregister == observationInfo.action)
351 m_interestedObservers.erase(std::remove(
352 m_interestedObservers.begin(),
353 m_interestedObservers.end(),
354 observationInfo.obsId),
355 m_interestedObservers.end());
360 cout << "\t\trequestFlag : Observer\n";
362 static int startedThread = 0;
364 // Observation happens on a different thread in ChangeLightRepresentation function.
365 // If we have not created the thread already, we will create one here.
368 pthread_create (&threadId, NULL, ChangeLightRepresentation, (void *)this);
376 std::cout << "Request invalid" << std::endl;
384 // ChangeLightRepresentaion is an observation function,
385 // which notifies any changes to the resource to stack
386 // via notifyObservers
387 void * ChangeLightRepresentation (void *param)
389 LightResource* lightPtr = (LightResource*) param;
391 // This function continuously monitors for the changes
398 // If under observation if there are any changes to the light resource
399 // we call notifyObservors
401 // For demostration we are changing the power value and notifying.
402 lightPtr->m_power += 10;
404 cout << "\nPower updated to : " << lightPtr->m_power << endl;
405 cout << "Notifying observers with resource handle: " << lightPtr->getHandle() << endl;
407 OCStackResult result = OC_STACK_OK;
409 if(isListOfObservers)
411 std::shared_ptr<OCResourceResponse> resourceResponse =
412 std::make_shared<OCResourceResponse>();
414 resourceResponse->setErrorCode(200);
415 resourceResponse->setResourceRepresentation(lightPtr->get(), DEFAULT_INTERFACE);
417 result = OCPlatform::notifyListOfObservers(
418 lightPtr->getHandle(),
419 lightPtr->m_interestedObservers,
421 OC::QualityOfService::HighQos);
425 result = OCPlatform::notifyAllObservers(lightPtr->getHandle(),
426 OC::QualityOfService::HighQos);
429 if(OC_STACK_NO_OBSERVERS == result)
431 cout << "No More observers, stopping notifications" << endl;
440 void DeletePlatformInfo()
442 delete[] platformInfo.platformID;
443 delete[] platformInfo.manufacturerName;
444 delete[] platformInfo.manufacturerUrl;
445 delete[] platformInfo.modelNumber;
446 delete[] platformInfo.dateOfManufacture;
447 delete[] platformInfo.platformVersion;
448 delete[] platformInfo.operatingSystemVersion;
449 delete[] platformInfo.hardwareVersion;
450 delete[] platformInfo.firmwareVersion;
451 delete[] platformInfo.supportUrl;
452 delete[] platformInfo.systemTime;
455 void DeleteDeviceInfo()
457 delete[] deviceInfo.deviceName;
458 delete[] deviceInfo.specVersion;
459 OCFreeOCStringLL(deviceInfo.dataModelVersions);
462 void DuplicateString(char ** targetString, std::string sourceString)
464 *targetString = new char[sourceString.length() + 1];
465 strncpy(*targetString, sourceString.c_str(), (sourceString.length() + 1));
468 OCStackResult SetPlatformInfo(std::string platformID, std::string manufacturerName,
469 std::string manufacturerUrl, std::string modelNumber, std::string dateOfManufacture,
470 std::string platformVersion, std::string operatingSystemVersion,
471 std::string hardwareVersion, std::string firmwareVersion, std::string supportUrl,
472 std::string systemTime)
474 DuplicateString(&platformInfo.platformID, platformID);
475 DuplicateString(&platformInfo.manufacturerName, manufacturerName);
476 DuplicateString(&platformInfo.manufacturerUrl, manufacturerUrl);
477 DuplicateString(&platformInfo.modelNumber, modelNumber);
478 DuplicateString(&platformInfo.dateOfManufacture, dateOfManufacture);
479 DuplicateString(&platformInfo.platformVersion, platformVersion);
480 DuplicateString(&platformInfo.operatingSystemVersion, operatingSystemVersion);
481 DuplicateString(&platformInfo.hardwareVersion, hardwareVersion);
482 DuplicateString(&platformInfo.firmwareVersion, firmwareVersion);
483 DuplicateString(&platformInfo.supportUrl, supportUrl);
484 DuplicateString(&platformInfo.systemTime, systemTime);
489 OCStackResult SetDeviceInfo(std::string deviceName, std::string specVersion, std::string dataModelVersions)
491 DuplicateString(&deviceInfo.deviceName, deviceName);
493 if (!specVersion.empty())
495 DuplicateString(&deviceInfo.specVersion, specVersion);
498 if (!dataModelVersions.empty())
500 OCResourcePayloadAddStringLL(&deviceInfo.dataModelVersions, dataModelVersions.c_str());
508 std::cout << std::endl;
509 std::cout << "Usage : simpleserverHQ <ObserveType>\n";
510 std::cout << " ObserveType : 0 - Observe All\n";
511 std::cout << " ObserveType : 1 - Observe List of observers\n\n";
515 int main(int argc, char* argv[])
521 isListOfObservers = 0;
525 int value = atoi(argv[1]);
527 isListOfObservers = 1;
529 isListOfObservers = 0;
536 // Create PlatformConfig object
538 OC::ServiceType::InProc,
539 OC::ModeType::Server,
540 "0.0.0.0", // By setting to "0.0.0.0", it binds to all available interfaces
541 0, // Uses randomly available port
542 OC::QualityOfService::LowQos
545 OCPlatform::Configure(cfg);
546 std::cout << "Starting server & setting platform info\n";
548 OCStackResult result = SetPlatformInfo(platformId, manufacturerName, manufacturerLink,
549 modelNumber, dateOfManufacture, platformVersion, operatingSystemVersion,
550 hardwareVersion, firmwareVersion, supportLink, systemTime);
552 result = OCPlatform::registerPlatformInfo(platformInfo);
554 if (result != OC_STACK_OK)
556 std::cout << "Platform Registration failed\n";
560 result = SetDeviceInfo(deviceName, specVersion, dataModelVersions);
561 OCResourcePayloadAddStringLL(&deviceInfo.types, "oic.wk.d");
563 result = OCPlatform::registerDeviceInfo(deviceInfo);
565 if (result != OC_STACK_OK)
567 std::cout << "Device Registration failed\n";
573 // Create the instance of the resource class
574 // (in this case instance of class 'LightResource').
575 LightResource myLight(cfg);
577 // Invoke createResource function of class light.
578 myLight.createResource();
580 myLight.addType(std::string("core.brightlight"));
581 myLight.addInterface(std::string(LINK_INTERFACE));
583 DeletePlatformInfo();
586 // A condition variable will free the mutex it is given, then do a non-
587 // intensive block until 'notify' is called on it. In this case, since we
588 // don't ever call cv.notify, this should be a non-processor intensive version
591 std::condition_variable cv;
592 std::unique_lock<std::mutex> lock(blocker);
593 cv.wait(lock, []{return false;});
595 catch(OCException& e)
597 oclog() << "Exception in main: "<< e.what();
600 // No explicit call to stop the platform.
601 // When OCPlatform destructor is invoked, internally we do platform cleanup