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::vector<std::string> dataModelVersions = {"res.1.1.0"};
69 // OCPlatformInfo Contains all the platform info to be stored
70 OCPlatformInfo platformInfo;
72 // Specifies where to notify all observers or list of observers
73 // 0 - notifies all observers
74 // 1 - notifies list of observers
75 int isListOfObservers = 0;
77 /// This class represents a single resource named 'lightResource'. This resource has
78 /// two simple properties named 'state' and 'power'
84 /// Access this property from a TB client
88 std::string m_lightUri;
89 OCResourceHandle m_resourceHandle;
90 OCRepresentation m_lightRep;
91 ObservationIds m_interestedObservers;
95 LightResource(PlatformConfig& /*cfg*/)
96 :m_name("John's light"), m_state(false), m_power(0), m_lightUri("/a/light") {
97 // Initialize representation
98 m_lightRep.setUri(m_lightUri);
100 m_lightRep.setValue("state", m_state);
101 m_lightRep.setValue("power", m_power);
102 m_lightRep.setValue("name", m_name);
105 /* Note that this does not need to be a member function: for classes you do not have
106 access to, you can accomplish this with a free function: */
108 /// This function internally calls registerResource API.
109 void createResource()
111 std::string resourceURI = m_lightUri; // URI of the resource
112 // resource type name. In this case, it is light
113 std::string resourceTypeName = "core.light";
114 std::string resourceInterface = DEFAULT_INTERFACE; // resource interface.
116 // OCResourceProperty is defined ocstack.h
117 uint8_t resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
119 EntityHandler cb = std::bind(&LightResource::entityHandler, this,PH::_1);
121 // This will internally create and register the resource.
122 OCStackResult result = OCPlatform::registerResource(
123 m_resourceHandle, resourceURI, resourceTypeName,
124 resourceInterface, cb, resourceProperty);
126 if (OC_STACK_OK != result)
128 cout << "Resource creation was unsuccessful\n";
132 OCStackResult createResource1()
134 std::string resourceURI = "/a/light1"; // URI of the resource
135 std::string resourceTypeName = "core.light"; // resource type name. In this case, it is light
136 std::string resourceInterface = DEFAULT_INTERFACE; // resource interface.
138 // OCResourceProperty is defined ocstack.h
139 uint8_t resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
141 EntityHandler cb = std::bind(&LightResource::entityHandler, this,PH::_1);
143 OCResourceHandle resHandle;
145 // This will internally create and register the resource.
146 OCStackResult result = OCPlatform::registerResource(
147 resHandle, resourceURI, resourceTypeName,
148 resourceInterface, cb, resourceProperty);
150 if (OC_STACK_OK != result)
152 cout << "Resource creation was unsuccessful\n";
158 OCResourceHandle getHandle()
160 return m_resourceHandle;
163 // Puts representation.
164 // Gets values from the representation and
165 // updates the internal state
166 void put(OCRepresentation& rep)
169 if (rep.getValue("state", m_state))
171 cout << "\t\t\t\t" << "state: " << m_state << endl;
175 cout << "\t\t\t\t" << "state not found in the representation" << endl;
178 if (rep.getValue("power", m_power))
180 cout << "\t\t\t\t" << "power: " << m_power << endl;
184 cout << "\t\t\t\t" << "power not found in the representation" << endl;
189 cout << e.what() << endl;
194 // Post representation.
195 // Post can create new resource or simply act like put.
196 // Gets values from the representation and
197 // updates the internal state
198 OCRepresentation post(OCRepresentation& rep)
200 static int first = 1;
202 std::cout << "In POST\n";
204 // for the first time it tries to create a resource
207 std::cout << "In POST/First\n";
211 if(OC_STACK_OK == createResource1())
213 std::cout << "Created a new resource\n";
214 OCRepresentation rep1;
215 rep1.setValue("createduri", std::string("/a/light1"));
221 // from second time onwards it just puts
227 // gets the updated representation.
228 // Updates the representation with latest internal state before
230 OCRepresentation get()
232 m_lightRep.setValue("state", m_state);
233 m_lightRep.setValue("power", m_power);
238 void addType(const std::string& type) const
240 OCStackResult result = OCPlatform::bindTypeToResource(m_resourceHandle, type);
241 if (OC_STACK_OK != result)
243 cout << "Binding TypeName to Resource was unsuccessful\n";
247 void addInterface(const std::string& iface) const
249 OCStackResult result = OCPlatform::bindInterfaceToResource(m_resourceHandle, iface);
250 if (OC_STACK_OK != result)
252 cout << "Binding TypeName to Resource was unsuccessful\n";
258 OCStackResult sendResponse(std::shared_ptr<OCResourceRequest> pRequest)
260 auto pResponse = std::make_shared<OC::OCResourceResponse>();
261 pResponse->setRequestHandle(pRequest->getRequestHandle());
262 pResponse->setResourceHandle(pRequest->getResourceHandle());
263 pResponse->setResourceRepresentation(get());
265 pResponse->setResponseResult(OC_EH_OK);
267 return OCPlatform::sendResponse(pResponse);
270 OCStackResult sendPostResponse(std::shared_ptr<OCResourceRequest> pRequest)
272 auto pResponse = std::make_shared<OC::OCResourceResponse>();
273 pResponse->setRequestHandle(pRequest->getRequestHandle());
274 pResponse->setResourceHandle(pRequest->getResourceHandle());
276 OCRepresentation rep = pRequest->getResourceRepresentation();
277 OCRepresentation rep_post = post(rep);
279 pResponse->setResourceRepresentation(rep_post);
281 pResponse->setResponseResult(OC_EH_OK);
283 return OCPlatform::sendResponse(pResponse);
286 // This is just a sample implementation of entity handler.
287 // Entity handler can be implemented in several ways by the manufacturer
288 OCEntityHandlerResult entityHandler(std::shared_ptr<OCResourceRequest> request)
290 cout << "\tIn Server CPP entity handler:\n";
291 OCEntityHandlerResult ehResult = OC_EH_ERROR;
295 // Get the request type and request flag
296 std::string requestType = request->getRequestType();
297 int requestFlag = request->getRequestHandlerFlag();
299 if(requestFlag & RequestHandlerFlag::RequestFlag)
301 cout << "\t\trequestFlag : Request\n";
303 // If the request type is GET
304 if(requestType == "GET")
306 cout << "\t\t\trequestType : GET\n";
307 if(OC_STACK_OK == sendResponse(request))
312 else if(requestType == "PUT")
314 cout << "\t\t\trequestType : PUT\n";
316 OCRepresentation rep = request->getResourceRepresentation();
317 // Do related operations related to PUT request
318 // Update the lightResource
320 if(OC_STACK_OK == sendResponse(request))
325 else if(requestType == "POST")
327 cout << "\t\t\trequestType : POST\n";
328 if(OC_STACK_OK == sendPostResponse(request))
333 else if(requestType == "DELETE")
335 // DELETE request operations
339 if(requestFlag & RequestHandlerFlag::ObserverFlag)
341 ObservationInfo observationInfo = request->getObservationInfo();
342 if(ObserveAction::ObserveRegister == observationInfo.action)
344 m_interestedObservers.push_back(observationInfo.obsId);
346 else if(ObserveAction::ObserveUnregister == observationInfo.action)
348 m_interestedObservers.erase(std::remove(
349 m_interestedObservers.begin(),
350 m_interestedObservers.end(),
351 observationInfo.obsId),
352 m_interestedObservers.end());
357 cout << "\t\trequestFlag : Observer\n";
359 static int startedThread = 0;
361 // Observation happens on a different thread in ChangeLightRepresentation function.
362 // If we have not created the thread already, we will create one here.
365 pthread_create (&threadId, NULL, ChangeLightRepresentation, (void *)this);
373 std::cout << "Request invalid" << std::endl;
381 // ChangeLightRepresentaion is an observation function,
382 // which notifies any changes to the resource to stack
383 // via notifyObservers
384 void * ChangeLightRepresentation (void *param)
386 LightResource* lightPtr = (LightResource*) param;
388 // This function continuously monitors for the changes
395 // If under observation if there are any changes to the light resource
396 // we call notifyObservors
398 // For demostration we are changing the power value and notifying.
399 lightPtr->m_power += 10;
401 cout << "\nPower updated to : " << lightPtr->m_power << endl;
402 cout << "Notifying observers with resource handle: " << lightPtr->getHandle() << endl;
404 OCStackResult result = OC_STACK_OK;
406 if(isListOfObservers)
408 std::shared_ptr<OCResourceResponse> resourceResponse =
409 std::make_shared<OCResourceResponse>();
411 resourceResponse->setResourceRepresentation(lightPtr->get(), DEFAULT_INTERFACE);
413 result = OCPlatform::notifyListOfObservers(
414 lightPtr->getHandle(),
415 lightPtr->m_interestedObservers,
417 OC::QualityOfService::HighQos);
421 result = OCPlatform::notifyAllObservers(lightPtr->getHandle(),
422 OC::QualityOfService::HighQos);
425 if(OC_STACK_NO_OBSERVERS == result)
427 cout << "No More observers, stopping notifications" << endl;
436 void DeletePlatformInfo()
438 delete[] platformInfo.platformID;
439 delete[] platformInfo.manufacturerName;
440 delete[] platformInfo.manufacturerUrl;
441 delete[] platformInfo.modelNumber;
442 delete[] platformInfo.dateOfManufacture;
443 delete[] platformInfo.platformVersion;
444 delete[] platformInfo.operatingSystemVersion;
445 delete[] platformInfo.hardwareVersion;
446 delete[] platformInfo.firmwareVersion;
447 delete[] platformInfo.supportUrl;
448 delete[] platformInfo.systemTime;
451 void DuplicateString(char ** targetString, std::string sourceString)
453 *targetString = new char[sourceString.length() + 1];
454 strncpy(*targetString, sourceString.c_str(), (sourceString.length() + 1));
457 OCStackResult SetPlatformInfo(std::string platformID, std::string manufacturerName,
458 std::string manufacturerUrl, std::string modelNumber, std::string dateOfManufacture,
459 std::string platformVersion, std::string operatingSystemVersion,
460 std::string hardwareVersion, std::string firmwareVersion, std::string supportUrl,
461 std::string systemTime)
463 DuplicateString(&platformInfo.platformID, platformID);
464 DuplicateString(&platformInfo.manufacturerName, manufacturerName);
465 DuplicateString(&platformInfo.manufacturerUrl, manufacturerUrl);
466 DuplicateString(&platformInfo.modelNumber, modelNumber);
467 DuplicateString(&platformInfo.dateOfManufacture, dateOfManufacture);
468 DuplicateString(&platformInfo.platformVersion, platformVersion);
469 DuplicateString(&platformInfo.operatingSystemVersion, operatingSystemVersion);
470 DuplicateString(&platformInfo.hardwareVersion, hardwareVersion);
471 DuplicateString(&platformInfo.firmwareVersion, firmwareVersion);
472 DuplicateString(&platformInfo.supportUrl, supportUrl);
473 DuplicateString(&platformInfo.systemTime, systemTime);
478 OCStackResult SetDeviceInfo()
480 OCStackResult result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_DEVICE_NAME,
482 if (result != OC_STACK_OK)
484 cout << "Failed to set device name" << endl;
488 result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_DATA_MODEL_VERSION,
490 if (result != OC_STACK_OK)
492 cout << "Failed to set data model versions" << endl;
496 result = OCPlatform::setPropertyValue(PAYLOAD_TYPE_DEVICE, OC_RSRVD_SPEC_VERSION, specVersion);
497 if (result != OC_STACK_OK)
499 cout << "Failed to set spec version" << endl;
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();
561 if (result != OC_STACK_OK)
563 std::cout << "Device Registration failed\n";
569 // Create the instance of the resource class
570 // (in this case instance of class 'LightResource').
571 LightResource myLight(cfg);
573 // Invoke createResource function of class light.
574 myLight.createResource();
576 myLight.addType(std::string("core.brightlight"));
577 myLight.addInterface(std::string(LINK_INTERFACE));
579 DeletePlatformInfo();
581 // A condition variable will free the mutex it is given, then do a non-
582 // intensive block until 'notify' is called on it. In this case, since we
583 // don't ever call cv.notify, this should be a non-processor intensive version
586 std::condition_variable cv;
587 std::unique_lock<std::mutex> lock(blocker);
588 cv.wait(lock, []{return false;});
590 catch(OCException& e)
592 oclog() << "Exception in main: "<< e.what();
595 // No explicit call to stop the platform.
596 // When OCPlatform destructor is invoked, internally we do platform cleanup