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

This class provides a set of APIs for Notification service Topic. More...

Public Types

enum  NSTopicState { NSTopicState::UNSUBSCRIBED = 0, NSTopicState::SUBSCRIBED = 1 }
 Notification topic State. More...
 

Public Member Functions

 NSTopic ()
 Constructor of NSTopic. More...
 
 NSTopic (const std::string &topicName, const NSTopicState state)
 Constructor of NSTopic. More...
 
 ~NSTopic ()=default
 Destructor of NSTopic. More...
 
std::string getTopicName () const
 This method is for getting topicName from the Notification service Topic. More...
 
void setTopicName (const std::string &topicName)
 This method is for setting topicName for the Notification service Topic. More...
 
NSTopicState getState () const
 This method is for getting state from the Notification service Topic. More...
 
void setState (const NSTopicState state)
 This method is for setting state for the Notification service Topic. More...
 

Detailed Description

This class provides a set of APIs for Notification service Topic.

Member Enumeration Documentation

Notification topic State.

Enumerator
UNSUBSCRIBED 
SUBSCRIBED 

Constructor & Destructor Documentation

OIC::Service::NSTopic::NSTopic ( )
inline

Constructor of NSTopic.

OIC::Service::NSTopic::NSTopic ( const std::string &  topicName,
const NSTopicState  state 
)
inline

Constructor of NSTopic.

Parameters
topicName- topicName of the Notification service Topic.
state- as NSTopicState.
OIC::Service::NSTopic::~NSTopic ( )
default

Destructor of NSTopic.

Member Function Documentation

NSTopicState OIC::Service::NSTopic::getState ( ) const

This method is for getting state from the Notification service Topic.

Returns
state as NSTopicState.
std::string OIC::Service::NSTopic::getTopicName ( ) const

This method is for getting topicName from the Notification service Topic.

Returns
topicName as string.
void OIC::Service::NSTopic::setState ( const NSTopicState  state)

This method is for setting state for the Notification service Topic.

Parameters
state- as NSTopicState.
void OIC::Service::NSTopic::setTopicName ( const std::string &  topicName)

This method is for setting topicName for the Notification service Topic.

Parameters
topicName- as string.

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