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

This class provides APIs for managing the container and bundles in the container. More...

Public Member Functions

virtual void startContainer (const std::string &configFile)=0
 API for starting the Container. More...
 
virtual void stopContainer ()=0
 API for stopping the Container. More...
 
virtual std::list
< std::unique_ptr
< RCSBundleInfo > > 
listBundles ()=0
 API for getting the list of all bundles in the container. More...
 
virtual void startBundle (const std::string &bundleId)=0
 API for starting the bundle. More...
 
virtual void stopBundle (const std::string &bundleId)=0
 API for Stopping the bundle. More...
 
virtual void addBundle (const std::string &bundleId, const std::string &bundleUri, const std::string &bundlePath, const std::string &activator, std::map< std::string, std::string > params)=0
 API for adding the bundle to the Container. More...
 
virtual void removeBundle (const std::string &bundleId)=0
 API for removing the bundle from the container. More...
 
virtual void addResourceConfig (const std::string &bundleId, const std::string &resourceUri, std::map< std::string, std::string > params)=0
 API for adding the Resource configuration information to the bundle. More...
 
virtual void removeResourceConfig (const std::string &bundleId, const std::string &resourceUri)=0
 API for removing the Resource configuration information from the bundle. More...
 
virtual std::list< std::string > listBundleResources (const std::string &bundleId)=0
 API for getting the list of Bundle Resources. More...
 

Static Public Member Functions

static RCSResourceContainergetInstance ()
 API for getting the Instance of ResourceContainer class. More...
 

Protected Member Functions

 RCSResourceContainer ()
 
virtual ~RCSResourceContainer ()
 
 RCSResourceContainer (const RCSResourceContainer &)=delete
 
 RCSResourceContainer (RCSResourceContainer &&)=delete
 
RCSResourceContaineroperator= (const RCSResourceContainer &) const =delete
 
RCSResourceContaineroperator= (RCSResourceContainer &&) const =delete
 

Detailed Description

This class provides APIs for managing the container and bundles in the container.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void OIC::Service::RCSResourceContainer::addBundle ( const std::string &  bundleId,
const std::string &  bundleUri,
const std::string &  bundlePath,
const std::string &  activator,
std::map< std::string, std::string >  params 
)
pure virtual

API for adding the bundle to the Container.

Parameters
bundleIdId of the Bundle
bundleUriUri of the bundle
bundlePathPath of the bundle
activatorActivation prefix for .so bundles, or activator class name for .jar bundles
paramskey-value pairs in string form for other Bundle parameters
virtual void OIC::Service::RCSResourceContainer::addResourceConfig ( const std::string &  bundleId,
const std::string &  resourceUri,
std::map< std::string, std::string >  params 
)
pure virtual

API for adding the Resource configuration information to the bundle.

Parameters
bundleIdId of the Bundle
resourceUriURI of the resource
paramskey-value pairs in string form for other Bundle parameters
static RCSResourceContainer* OIC::Service::RCSResourceContainer::getInstance ( )
static

API for getting the Instance of ResourceContainer class.

Returns
Instance of the "RCSResourceContainer" class
virtual std::list<std::string> OIC::Service::RCSResourceContainer::listBundleResources ( const std::string &  bundleId)
pure virtual

API for getting the list of Bundle Resources.

Parameters
bundleIdId of the Bundle
virtual std::list<std::unique_ptr<RCSBundleInfo> > OIC::Service::RCSResourceContainer::listBundles ( )
pure virtual

API for getting the list of all bundles in the container.

The returned list and the contained bundle information are a copy and will not be updated by the resource container.

Returns
List of BundleInfo pointer each associated with a bundle
RCSResourceContainer& OIC::Service::RCSResourceContainer::operator= ( const RCSResourceContainer ) const
protecteddelete
RCSResourceContainer& OIC::Service::RCSResourceContainer::operator= ( RCSResourceContainer &&  ) const
protecteddelete
virtual void OIC::Service::RCSResourceContainer::removeBundle ( const std::string &  bundleId)
pure virtual

API for removing the bundle from the container.

Parameters
bundleIdId of the Bundle
virtual void OIC::Service::RCSResourceContainer::removeResourceConfig ( const std::string &  bundleId,
const std::string &  resourceUri 
)
pure virtual

API for removing the Resource configuration information from the bundle.

Parameters
bundleIdId of the Bundle
resourceUriURI of the resource
virtual void OIC::Service::RCSResourceContainer::startBundle ( const std::string &  bundleId)
pure virtual

API for starting the bundle.

Parameters
bundleIdId of the Bundle
virtual void OIC::Service::RCSResourceContainer::startContainer ( const std::string &  configFile)
pure virtual

API for starting the Container.

This API start the container with the provided Configuration file.

Parameters
configFileconfiguration File that contains the Bundle/Bundles information.
virtual void OIC::Service::RCSResourceContainer::stopBundle ( const std::string &  bundleId)
pure virtual

API for Stopping the bundle.

Parameters
bundleIdId of the Bundle
virtual void OIC::Service::RCSResourceContainer::stopContainer ( )
pure virtual

API for stopping the Container.


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