IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::ResourceContainerBundleAPI Class Referenceabstract

This class provides APIs for retrieving bundle and resource configuration and registering/unregistering resources. More...

Inherits OIC::Service::NotificationReceiver.

Public Member Functions

virtual int registerResource (BundleResource::Ptr resource)=0
 Register bundle resource in the container and register resource server for bundle resource. More...
 
virtual void unregisterResource (BundleResource::Ptr resource)=0
 Unregister bundle resource from the container and unregister resource server. More...
 
virtual void getBundleConfiguration (const std::string &bundleId, configInfo *configOutput)=0
 Get Configuration data of certain bundle. More...
 
virtual void getResourceConfiguration (const std::string &bundleId, std::vector< resourceInfo > *configOutput)=0
 Get the list of Configuration data of resources that certain bundle has. More...
 
- Public Member Functions inherited from OIC::Service::NotificationReceiver
 NotificationReceiver ()
 Constructor for NotificationReceiver. More...
 
 ~NotificationReceiver ()
 destructor for NotificationReceiver More...
 
virtual void onNotificationReceived (const std::string &strResourceUri)=0
 Callback method for getting notification from bundle resources. More...
 

Static Public Member Functions

static ResourceContainerBundleAPIgetInstance ()
 API for getting an instance of ResourceContainerBundleAPI. More...
 

Protected Member Functions

 ResourceContainerBundleAPI ()
 
virtual ~ResourceContainerBundleAPI ()
 
 ResourceContainerBundleAPI (const ResourceContainerBundleAPI &)=delete
 
 ResourceContainerBundleAPI (ResourceContainerBundleAPI &&)=delete
 
ResourceContainerBundleAPIoperator= (const ResourceContainerBundleAPI &) const =delete
 
ResourceContainerBundleAPIoperator= (ResourceContainerBundleAPI &&) const =delete
 

Detailed Description

This class provides APIs for retrieving bundle and resource configuration and registering/unregistering resources.

Constructor & Destructor Documentation

OIC::Service::ResourceContainerBundleAPI::ResourceContainerBundleAPI ( )
protected
virtual OIC::Service::ResourceContainerBundleAPI::~ResourceContainerBundleAPI ( )
protectedvirtual
OIC::Service::ResourceContainerBundleAPI::ResourceContainerBundleAPI ( const ResourceContainerBundleAPI )
protecteddelete
OIC::Service::ResourceContainerBundleAPI::ResourceContainerBundleAPI ( ResourceContainerBundleAPI &&  )
protecteddelete

Member Function Documentation

virtual void OIC::Service::ResourceContainerBundleAPI::getBundleConfiguration ( const std::string &  bundleId,
configInfo *  configOutput 
)
pure virtual

Get Configuration data of certain bundle.

Parameters
[in]bundleIdBundle id to get configuration data
[out]configOutputReturned configuration data of bundle
Returns
void
static ResourceContainerBundleAPI* OIC::Service::ResourceContainerBundleAPI::getInstance ( )
static

API for getting an instance of ResourceContainerBundleAPI.

Returns
ResourceContainerBundleAPI * Return the object pointer of ResourceContainerBundleAPI
virtual void OIC::Service::ResourceContainerBundleAPI::getResourceConfiguration ( const std::string &  bundleId,
std::vector< resourceInfo > *  configOutput 
)
pure virtual

Get the list of Configuration data of resources that certain bundle has.

Parameters
[in]bundleIdBundle id to get configuration data
[out]configOutputReturned vector of resource configuration data
Returns
void
ResourceContainerBundleAPI& OIC::Service::ResourceContainerBundleAPI::operator= ( const ResourceContainerBundleAPI ) const
protecteddelete
ResourceContainerBundleAPI& OIC::Service::ResourceContainerBundleAPI::operator= ( ResourceContainerBundleAPI &&  ) const
protecteddelete
virtual int OIC::Service::ResourceContainerBundleAPI::registerResource ( BundleResource::Ptr  resource)
pure virtual

Register bundle resource in the container and register resource server for bundle resource.

Parameters
resourcebundle resource to register
Returns
int 0 in case of an success -EEXIST when the resource already exists and was not registered -EINVAL when it was not possible to create such a resource
virtual void OIC::Service::ResourceContainerBundleAPI::unregisterResource ( BundleResource::Ptr  resource)
pure virtual

Unregister bundle resource from the container and unregister resource server.

Parameters
resourceBundle resource to unregister
Returns
void

The documentation for this class was generated from the following file: