IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service Namespace Reference

Classes

class  RCSAddress
 This is to specify a target address to discover. More...
 
class  RCSDiscoveryManager
 This class contains the resource discovery methods. More...
 
class  RCSException
 The base exception class for resource encapsulation. More...
 
class  RCSPlatformException
 Thrown when OC layer returns an error. More...
 
class  RCSBadRequestException
 Thrown when a request is not acceptable. More...
 
class  RCSInvalidParameterException
 Thrown when a parameter is not valid. More...
 
class  RCSBadGetException
 Thrown when getting value with wrong template parameter. More...
 
class  RCSInvalidKeyException
 Thrown when a key is invalid. More...
 
class  RCSQueryParams
 This is to specify query parameters for requests to the server. More...
 
class  RCSRemoteResourceObject
 This represents a remote resource and provides simple ways to interact with it. More...
 
class  RCSRepresentation
 This class describes a resource representation. More...
 
class  RCSRequest
 This class describes the request. More...
 
class  RCSByteString
 This RCSByteString the one of RCSResourceAttributes value for Byte String (Binary). More...
 
class  RCSResourceAttributes
 This represents the attributes for a resource. More...
 
class  NoLockException
 Thrown when lock has not been acquired. More...
 
class  RCSResourceObject
 This class represents a resource and handles any requests from clients automatically with attributes. More...
 
class  RCSGetResponse
 This class provides factory methods to create the response for a received get request. More...
 
class  RCSSetResponse
 This class provides factory methods to create the response for a received set request. More...
 
class  RCSSeparateResponse
 This class is to send a delayed response for request handlers of the RCSResourceObject. More...
 
class  RCSBundleInfo
 This class provides APIs for creating, getting and setting the Bundle Information. More...
 
class  RCSResourceContainer
 This class provides APIs for managing the container and bundles in the container. More...
 
class  BundleActivator
 This class represents Bundle to be activated by container. More...
 
class  BundleResource
 This class represents Basic bundle resource template to be registered in the container and make resource server. More...
 
class  NotificationReceiver
 This class represents Notification Receiver to get notification from bundle resources if there's any changes of attribute state. More...
 
class  ProtocolBridgeConnector
 This class represents connector to bridge non-IoTivity protocol and IoTivity for Protocol Bridge. More...
 
class  ProtocolBridgeResource
 This class represents bundle resource template for Protocol Bridge to be registered in the container and make resource server. More...
 
class  ResourceContainerBundleAPI
 This class provides APIs for retrieving bundle and resource configuration and registering/unregistering resources. More...
 
class  SoftSensorResource
 This class represents bundle resource for Soft Sensor to be registered in the container and make resource server. More...
 
class  EasySetup
 This provides an API to instanciate a new RemoteEnrollee object correspondent to Enrollee Device to be setup. More...
 
class  ESException
 The base exception class for resource encapsulation. More...
 
class  ESPlatformException
 Thrown when OC layer returns an error. More...
 
class  ESBadRequestException
 Thrown when a request is not acceptable. More...
 
class  ESInvalidParameterException
 Thrown when a parameter is not valid. More...
 
class  ESBadGetException
 Thrown when getting value with wrong template parameter. More...
 
class  ESInvalidKeyException
 Thrown when a key is invalid. More...
 
class  EnrolleeStatus
 Properties of easysetup resource. More...
 
class  CloudProp
 Data class stored for provisioning of coap cloud server properties. More...
 
class  DeviceProp
 Data class stored for provisioning of Device properties which includes properties of WiFiConf resource and DevConf resource. More...
 
class  SecProvisioningStatus
 Security Provisioning Status. More...
 
class  EnrolleeConf
 This provide a set of getter APIs from received response for getConfiguration(). More...
 
class  GetEnrolleeStatus
 Status object for getStatus API. More...
 
class  GetConfigurationStatus
 Status object for getConfiguration API. More...
 
class  DevicePropProvisioningStatus
 Status object for provisionDeviceProperties API. More...
 
class  CloudPropProvisioningStatus
 Status object for provisionCloudProperties API. More...
 
class  ConnectRequestStatus
 Status object for connect API. More...
 
class  ESOwnershipTransferData
 
class  RemoteEnrollee
 This class represents Remote Enrollee device instance. More...
 
class  RemoteScene
 
class  RemoteSceneAction
 
class  RemoteSceneCollection
 RemoteSceneCollection class is an interface class to send a request to SceneCollection resource on remote side. More...
 
class  RemoteSceneList
 RemoteSceneList class is an interface class to send a request to SceneList resource on remote side. More...
 
class  Scene
 Scene class is an interface class to manage scenes provided by SceneCollection resource. More...
 
class  SceneAction
 SceneAction class indicates a unit of actions when a scene is executed. More...
 
class  SceneCollection
 SceneCollection class is an interface class to manage SceneCollection resource. More...
 
class  SceneList
 SceneList class is an interface class to manage SceneList resource. More...
 
class  NSAcceptedConsumers
 This class provides a set of C++APIs for managing accepted Consumers. More...
 
class  NSConsumer
 This class provides a set of Notification service Consumer representation APIs. More...
 
class  NSProviderService
 This class provides a set of C++APIs for Notification Provider. More...
 
class  NSAcceptedProviders
 This class provides a set of C++APIs for managing accepted Providers. More...
 
class  NSConsumerService
 This class provides a set of C++APIs for Notification Consumer. More...
 
class  NSProvider
 This class provides a set of Notification service Provider representation APIs. More...
 
class  NSMediaContents
 This class provides a set of APIs for Notification service Media Contents. More...
 
class  NSMessage
 This class provides a set of APIs for Notification service Message . More...
 
class  NSSyncInfo
 This class provides a set of APIs for Notification service SyncInfo . More...
 
class  NSTopic
 This class provides a set of APIs for Notification service Topic. More...
 
class  NSTopicsList
 This class provides a set of APIs for Notification service Topics Linked list. More...
 

Typedefs

typedef std::vector
< OC::HeaderOption::OCHeaderOption
HeaderOpts
 
typedef function< void(shared_ptr
< GetEnrolleeStatus >) > 
GetStatusCb
 Callback function definition for providing Enrollee status. More...
 
typedef function< void(shared_ptr
< GetConfigurationStatus >) > 
GetConfigurationStatusCb
 Callback function definition for providing Enrollee configuration status. More...
 
typedef function< void(shared_ptr
< DevicePropProvisioningStatus >) > 
DevicePropProvStatusCb
 Callback function definition for providing Enrollee device property provisioning status. More...
 
typedef function< void(shared_ptr
< CloudPropProvisioningStatus >) > 
CloudPropProvStatusCb
 Callback function definition for providing Enrollee cloud property provisioning status. More...
 
typedef function< void(shared_ptr
< ConnectRequestStatus >) > 
ConnectRequestStatusCb
 Callback function definition for providing 'Connect' request status. More...
 
typedef function< void(shared_ptr
< SecProvisioningStatus >) > 
SecurityProvStatusCb
 Callback function definition for providing Enrollee security provisioning status. More...
 
typedef function
< ESOwnershipTransferData(shared_ptr
< SecProvisioningStatus >) > 
SecurityProvStatusCbWithOption
 Callback function definition for providing Enrollee security provisioning status. More...
 
typedef function< void(string &) > SecurityPinCb
 Callback definition to be invoked when the security stack expects a pin from application. More...
 
typedef function< void(string &) > SecProvisioningDbPathCb
 Callback definition to be invoked when the stack expects a db path. More...
 
typedef std::function< void(const
std::shared_ptr
< OC::OCResource > resource)> 
onDeviceDiscoveredCb
 

Enumerations

enum  CacheState { CacheState::NONE, CacheState::UNREADY, CacheState::READY, CacheState::LOST_SIGNAL }
 The states of caching. More...
 
enum  CacheMode { CacheMode::OBSERVE_ONLY, CacheMode::OBSERVE_WITH_POLLING }
 
enum  ResourceState {
  ResourceState::NONE, ResourceState::REQUESTED, ResourceState::ALIVE, ResourceState::LOST_SIGNAL,
  ResourceState::DESTROYED
}
 The states of monitoring. More...
 
enum  NSResult { NSResult::OK = 100, NSResult::ERROR = 200, NSResult::SUCCESS = 300, NSResult::FAIL = 400 }
 NSResult - enumeration for NS service Result. More...
 
enum  NSProviderState { NSProviderState::ALLOW = 1, NSProviderState::DENY = 2, NSProviderState::TOPIC = 3, NSProviderState::STOPPED = 12 }
 NSProviderState of notification service. More...
 
enum  NSProviderSubscribedState { NSProviderSubscribedState::DENY = 0, NSProviderSubscribedState::DISCOVERED = 1, NSProviderSubscribedState::SUBSCRIBED = 2 }
 NSProviderSubscribedState of notification service. More...
 

Typedef Documentation

typedef function< void(shared_ptr< CloudPropProvisioningStatus >) > OIC::Service::CloudPropProvStatusCb

Callback function definition for providing Enrollee cloud property provisioning status.

typedef function< void(shared_ptr< ConnectRequestStatus >) > OIC::Service::ConnectRequestStatusCb

Callback function definition for providing 'Connect' request status.

typedef function< void(shared_ptr< DevicePropProvisioningStatus >) > OIC::Service::DevicePropProvStatusCb

Callback function definition for providing Enrollee device property provisioning status.

typedef function< void(shared_ptr< GetConfigurationStatus >) > OIC::Service::GetConfigurationStatusCb

Callback function definition for providing Enrollee configuration status.

typedef function< void(shared_ptr< GetEnrolleeStatus >) > OIC::Service::GetStatusCb

Callback function definition for providing Enrollee status.

typedef std::function<void(const std::shared_ptr<OC::OCResource> resource)> OIC::Service::onDeviceDiscoveredCb
typedef function< void(string&) > OIC::Service::SecProvisioningDbPathCb

Callback definition to be invoked when the stack expects a db path.

typedef function< void(string&) > OIC::Service::SecurityPinCb

Callback definition to be invoked when the security stack expects a pin from application.

typedef function< void(shared_ptr<SecProvisioningStatus>) > OIC::Service::SecurityProvStatusCb

Callback function definition for providing Enrollee security provisioning status.

Callback function definition for providing Enrollee security provisioning status.

This callback is an overloaded version of SecurityProvStatusCb, which has ESOwnershipTransferData as a return value.

Enumeration Type Documentation

Enumerator
OBSERVE_ONLY 
OBSERVE_WITH_POLLING 

The states of caching.

See Also
startCaching
getCacheState
Enumerator
NONE 

Caching is not started.

UNREADY 

Caching is started, but the data is not ready yet.

This is the default state after startCaching.

READY 

The data is ready.

LOST_SIGNAL 

Failed to reach the resource.

NSProviderState of notification service.

Enumerator
ALLOW 
DENY 
TOPIC 
STOPPED 

NSProviderSubscribedState of notification service.

Enumerator
DENY 
DISCOVERED 
SUBSCRIBED 

NSResult - enumeration for NS service Result.

Enumerator
OK 
ERROR 
SUCCESS 
FAIL 

The states of monitoring.

See Also
startMonitoring
getState
Enumerator
NONE 

Monitoring is not started.

REQUESTED 

Monitoring is started and checking state is in progress.

This is the default state after startMonitoring.

ALIVE 

The resource is alive.

LOST_SIGNAL 

Failed to reach the resource.

DESTROYED 

The resource is deleted.