IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OCPlatform.h File Reference

This file contains the declaration of classes and its members related to OCPlatform. More...

Go to the source code of this file.

Namespaces

 OC
 
 OC::OCPlatform
 This namespace contains the main entrance/functionality of the product.
 

Typedefs

typedef OCDoHandle OC::OCPlatform::OCPresenceHandle
 

Functions

void OC::OCPlatform::Configure (const PlatformConfig &config)
 API for overwriting the default configuration of the OCPlatform object. More...
 
OCStackResult OC::OCPlatform::stop ()
 API for stop Base layer including resource and connectivity abstraction. More...
 
OCStackResult OC::OCPlatform::start ()
 API for start Base layer including resource and connectivity abstraction. More...
 
OCStackResult OC::OCPlatform::notifyAllObservers (OCResourceHandle resourceHandle)
 API for notifying base that resource's attributes have changed. More...
 
OCStackResult OC::OCPlatform::notifyAllObservers (OCResourceHandle resourceHandle, QualityOfService QoS)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
OCStackResult OC::OCPlatform::notifyListOfObservers (OCResourceHandle resourceHandle, ObservationIds &observationIds, const std::shared_ptr< OCResourceResponse > responsePtr)
 API for notifying only specific clients that resource's attributes have changed. More...
 
OCStackResult OC::OCPlatform::notifyListOfObservers (OCResourceHandle resourceHandle, ObservationIds &observationIds, const std::shared_ptr< OCResourceResponse > responsePtr, QualityOfService QoS)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
OCStackResult OC::OCPlatform::findResource (const std::string &host, const std::string &resourceURI, OCConnectivityType connectivityType, FindCallback resourceHandler)
 API for Service and Resource Discovery. More...
 
OCStackResult OC::OCPlatform::findResource (const std::string &host, const std::string &resourceURI, OCConnectivityType connectivityType, FindCallback resourceHandler, QualityOfService QoS)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
OCStackResult OC::OCPlatform::findResource (const std::string &host, const std::string &resourceURI, OCConnectivityType connectivityType, FindCallback resourceHandler, FindErrorCallback errorHandler)
 
OCStackResult OC::OCPlatform::findResource (const std::string &host, const std::string &resourceURI, OCConnectivityType connectivityType, FindCallback resourceHandler, FindErrorCallback errorHandler, QualityOfService QoS)
 
OCStackResult OC::OCPlatform::findResourceList (const std::string &host, const std::string &resourceURI, OCConnectivityType connectivityType, FindResListCallback resourceHandler, QualityOfService QoS=QualityOfService::LowQos)
 
OCStackResult OC::OCPlatform::findResourceList (const std::string &host, const std::string &resourceURI, OCConnectivityType connectivityType, FindResListCallback resourceHandler, FindErrorCallback errorHandler, QualityOfService QoS=QualityOfService::LowQos)
 
OCStackResult OC::OCPlatform::setPropertyValue (OCPayloadType type, const std::string &tag, const std::string &value)
 
OCStackResult OC::OCPlatform::setPropertyValue (OCPayloadType type, const std::string &tag, const std::vector< std::string > &value)
 
OCStackResult OC::OCPlatform::getPropertyValue (OCPayloadType type, const std::string &tag, std::string &value)
 
OCStackResult OC::OCPlatform::getPropertyValue (OCPayloadType type, const std::string &tag, std::vector< std::string > &value)
 
OCStackResult OC::OCPlatform::getDeviceInfo (const std::string &host, const std::string &deviceURI, OCConnectivityType connectivityType, FindDeviceCallback deviceInfoHandler)
 API for Device Discovery. More...
 
OCStackResult OC::OCPlatform::getDeviceInfo (const std::string &host, const std::string &deviceURI, OCConnectivityType connectivityType, FindDeviceCallback deviceInfoHandler, QualityOfService QoS)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
OCStackResult OC::OCPlatform::getPlatformInfo (const std::string &host, const std::string &platformURI, OCConnectivityType connectivityType, FindPlatformCallback platformInfoHandler)
 API for Platform Discovery. More...
 
OCStackResult OC::OCPlatform::getPlatformInfo (const std::string &host, const std::string &platformURI, OCConnectivityType connectivityType, FindPlatformCallback platformInfoHandler, QualityOfService QoS)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
OCStackResult OC::OCPlatform::getSupportedTransportsInfo (OCTpsSchemeFlags &supportedTps)
 This function returns flags of supported endpoint TPS on stack. More...
 
OCStackResult OC::OCPlatform::registerResource (OCResourceHandle &resourceHandle, std::string &resourceURI, const std::string &resourceTypeName, const std::string &resourceInterface, EntityHandler entityHandler, uint8_t resourceProperty)
 This API registers a resource with the server. More...
 
OCStackResult OC::OCPlatform::registerResource (OCResourceHandle &resourceHandle, std::string &resourceURI, const std::string &resourceTypeName, const std::string &resourceInterface, EntityHandler entityHandler, uint8_t resourceProperty, OCTpsSchemeFlags resourceTpsTypes)
 This API registers a resource with the server. More...
 
OCStackResult OC::OCPlatform::registerResource (OCResourceHandle &resourceHandle, const std::shared_ptr< OCResource > resource)
 This API registers a resource with the server. More...
 
OCStackResult OC::OCPlatform::registerDeviceInfo (const OCDeviceInfo deviceInfo)
 Register Device Info. More...
 
OCStackResult OC::OCPlatform::registerPlatformInfo (const OCPlatformInfo platformInfo)
 Register Platform Info. More...
 
OCStackResult OC::OCPlatform::setDefaultDeviceEntityHandler (EntityHandler entityHandler)
 Set default device entity handler. More...
 
OCStackResult OC::OCPlatform::unregisterResource (const OCResourceHandle &resourceHandle)
 This API unregisters a resource with the server. More...
 
OCStackResult OC::OCPlatform::bindResource (const OCResourceHandle collectionHandle, const OCResourceHandle resourceHandle)
 Add a resource to a collection resource. More...
 
OCStackResult OC::OCPlatform::bindResources (const OCResourceHandle collectionHandle, const std::vector< OCResourceHandle > &addedResourceHandleList)
 Add multiple resources to a collection resource. More...
 
OCStackResult OC::OCPlatform::unbindResource (const OCResourceHandle collectionHandle, const OCResourceHandle resourceHandle)
 Unbind a resource from a collection resource. More...
 
OCStackResult OC::OCPlatform::unbindResources (const OCResourceHandle collectionHandle, const std::vector< OCResourceHandle > &resourceHandleList)
 Unbind resources from a collection resource. More...
 
OCStackResult OC::OCPlatform::bindTypeToResource (const OCResourceHandle &resourceHandle, const std::string &resourceTypeName)
 Binds a type to a particular resource. More...
 
OCStackResult OC::OCPlatform::bindInterfaceToResource (const OCResourceHandle &resourceHandle, const std::string &resourceInterfaceName)
 Binds an interface to a particular resource. More...
 
OCStackResult OC::OCPlatform::startPresence (const unsigned int ttl)
 Start Presence announcements. More...
 
OCStackResult OC::OCPlatform::stopPresence ()
 Stop Presence announcements. More...
 
OCStackResult OC::OCPlatform::subscribePresence (OCPresenceHandle &presenceHandle, const std::string &host, OCConnectivityType connectivityType, SubscribeCallback presenceHandler)
 subscribes to a server's presence change events. More...
 
OCStackResult OC::OCPlatform::subscribePresence (OCPresenceHandle &presenceHandle, const std::string &host, const std::string &resourceType, OCConnectivityType connectivityType, SubscribeCallback presenceHandler)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.subscribes to a server's presence change events. More...
 
OCStackResult OC::OCPlatform::unsubscribePresence (OCPresenceHandle presenceHandle)
 unsubscribes from a previously subscribed server's presence events. More...
 
OCResource::Ptr OC::OCPlatform::constructResourceObject (const std::string &host, const std::string &uri, OCConnectivityType connectivityType, bool isObservable, const std::vector< std::string > &resourceTypes, const std::vector< std::string > &interfaces)
 Creates a resource proxy object so that get/put/observe functionality can be used without discovering the object in advance. More...
 
OCStackResult OC::OCPlatform::sendResponse (const std::shared_ptr< OCResourceResponse > pResponse)
 Allows application entity handler to send response to an incoming request. More...
 
OCStackResult OC::OCPlatform::getDeviceId (OCUUIdentity *deviceId)
 gets the deviceId of the client More...
 
OCStackResult OC::OCPlatform::setDeviceId (const OCUUIdentity *deviceId)
 sets the deviceId of the client More...
 

Detailed Description

This file contains the declaration of classes and its members related to OCPlatform.