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

Namespaces

 detail
 
 HeaderOption
 
 OCPlatform
 This namespace contains the main entrance/functionality of the product.
 

Classes

struct  PlatformConfig
 Data structure to provide the configuration. More...
 
struct  ObservationInfo
 
class  OCException
 
class  MessageContainer
 
class  OCRepresentation
 
class  OCResourceRequest
 OCResourceRequest provides APIs to extract details from a request URI. More...
 
class  OCResourceResponse
 OCResourceResponse provides APIs to set the response details. More...
 
class  OCResourceIdentifier
 OCResourceIdentifier represents the identity information for a server. More...
 
class  OCResource
 OCResource represents an OC resource. More...
 
struct  ProvisionContext
 
struct  TrustCertChainContext
 
struct  DisplayPinContext
 
struct  InputPinContext
 
struct  DisplayNumContext
 
struct  UserConfirmNumContext
 
class  Credential
 This class is for credential's to be set to devices. More...
 
class  OCSecure
 
class  OCSecureResource
 This class represents a secure virtual device, which can be provisioned by the provisioning client. More...
 

Typedefs

typedef
boost::iostreams::stream
< OC::oc_log_stream > 
log_target_t
 
typedef std::string URI
 
typedef std::vector
< OCResourceHandle
ResourceHandles
 
typedef std::vector
< HeaderOption::OCHeaderOption
HeaderOptions
 
typedef std::map< std::string,
std::string > 
QueryParamsMap
 
typedef std::map< std::string,
std::vector< std::string > > 
QueryParamsList
 
typedef std::vector
< OCObservationId
ObservationIds
 
typedef std::function< void(std::shared_ptr
< OCResource >)> 
FindCallback
 
typedef std::function< void(const
std::string &, const int)> 
FindErrorCallback
 
typedef std::function< void(std::vector
< std::shared_ptr< OCResource >>)> 
FindResListCallback
 
typedef std::function< void(const
OCRepresentation &)> 
FindDeviceCallback
 
typedef std::function< void(const
OCRepresentation &)> 
FindPlatformCallback
 
typedef std::function
< OCEntityHandlerResult(const
std::shared_ptr
< OCResourceRequest >)> 
EntityHandler
 
typedef std::function< void(OCStackResult,
const unsigned int, const
std::string &)> 
SubscribeCallback
 
typedef std::function< void(const
HeaderOptions &, const
OCRepresentation &, const int)> 
GetCallback
 
typedef std::function< void(const
HeaderOptions &, const
OCRepresentation &, const int)> 
PostCallback
 
typedef std::function< void(const
HeaderOptions &, const
OCRepresentation &, const int)> 
PutCallback
 
typedef std::function< void(const
HeaderOptions &, const int)> 
DeleteCallback
 
typedef std::function< void(const
HeaderOptions &, const
OCRepresentation &, const int,
const int)> 
ObserveCallback
 
typedef std::function< void(const
int, const std::string
&, std::shared_ptr< OCResource >)> 
MQTopicCallback
 
typedef std::vector
< std::shared_ptr
< OCSecureResource > > 
DeviceList_t
 
typedef std::vector< OicUuid_t > UuidList_t
 
typedef std::vector
< OCProvisionResult_t > 
PMResultList_t
 
typedef std::function< void(PMResultList_t
*result, int hasError)> 
ResultCallBack
 
typedef std::function< void(uint16_t
credId, uint8_t
*trustCertChain, size_t
chainSize)> 
CertChainCallBack
 
typedef std::function
< OCStackResult(uint8_t
verifNum[])> 
DisplayNumCB
 
typedef std::function
< OCStackResult()> 
UserConfirmNumCB
 
typedef std::function< void(char
*pinData, size_t pinSize)> 
DisplayPinCB
 
typedef std::function< void(OicUuid_t
deviceId, char *pinBuffer,
size_t pinBufferSize)> 
InputPinCB
 
typedef InputPinContextInputPinCallbackHandle
 
typedef DisplayPinContextDisplayPinCallbackHandle
 

Enumerations

enum  OCPlatformStatus { OCPlatformStatus::PlatformUp, OCPlatformStatus::PlatformDown }
 
enum  OCAdvertisementStatus { OCAdvertisementStatus::None }
 
enum  ServiceType { ServiceType::InProc, ServiceType::OutOfProc }
 
enum  ModeType { ModeType::Server, ModeType::Client, ModeType::Both, ModeType::Gateway }
 Host Mode of Operation. More...
 
enum  QualityOfService : uint8_t { QualityOfService::LowQos = OC_LOW_QOS, QualityOfService::MidQos = OC_MEDIUM_QOS, QualityOfService::HighQos = OC_HIGH_QOS, QualityOfService::NaQos = OC_NA_QOS }
 Quality of Service attempts to abstract the guarantees provided by the underlying transport protocol. More...
 
enum  RequestHandlerFlag { RequestFlag = 1 << 1, ObserverFlag = 1 << 2 }
 
enum  ObserveType { ObserveType::Observe, ObserveType::ObserveAll }
 
enum  ObserveAction { ObserveAction::ObserveRegister, ObserveAction::ObserveUnregister }
 
enum  InterfaceType {
  InterfaceType::None, InterfaceType::LinkParent, InterfaceType::BatchParent, InterfaceType::DefaultParent,
  InterfaceType::LinkChild, InterfaceType::BatchChild, InterfaceType::DefaultChild
}
 

Functions

std::ostream & operator<< (std::ostream &os, const OCRepresentation::AttributeItem &ai)
 
std::ostream & operator<< (std::ostream &os, const OCResourceIdentifier &ri)
 

Variables

auto oclog
 
const std::string DEFAULT_INTERFACE = "oic.if.baseline"
 
const std::string LINK_INTERFACE = "oic.if.ll"
 
const std::string BATCH_INTERFACE = "oic.if.b"
 
const std::string GROUP_INTERFACE = "oic.mi.grp"
 

Typedef Documentation

typedef std::function<void(uint16_t credId, uint8_t *trustCertChain, size_t chainSize)> OC::CertChainCallBack
typedef std::function<void(const HeaderOptions&, const int)> OC::DeleteCallback
typedef std::vector<std::shared_ptr<OCSecureResource> > OC::DeviceList_t
typedef std::function<OCStackResult(uint8_t verifNum[])> OC::DisplayNumCB
typedef std::function<void(char* pinData, size_t pinSize)> OC::DisplayPinCB
typedef std::function<OCEntityHandlerResult( const std::shared_ptr<OCResourceRequest>)> OC::EntityHandler
typedef std::function<void(std::shared_ptr<OCResource>)> OC::FindCallback
typedef std::function<void(const OCRepresentation&)> OC::FindDeviceCallback
typedef std::function<void(const std::string&, const int)> OC::FindErrorCallback
typedef std::function<void(const OCRepresentation&)> OC::FindPlatformCallback
typedef std::function<void(std::vector<std::shared_ptr<OCResource>>)> OC::FindResListCallback
typedef std::function<void(const HeaderOptions&, const OCRepresentation&, const int)> OC::GetCallback
typedef std::function<void(OicUuid_t deviceId, char* pinBuffer, size_t pinBufferSize)> OC::InputPinCB
typedef boost::iostreams::stream<OC::oc_log_stream> OC::log_target_t
typedef std::function<void(const int, const std::string&, std::shared_ptr<OCResource>)> OC::MQTopicCallback
typedef std::vector<OCObservationId> OC::ObservationIds
typedef std::function<void(const HeaderOptions&, const OCRepresentation&, const int, const int)> OC::ObserveCallback
typedef std::vector<OCProvisionResult_t> OC::PMResultList_t
typedef std::function<void(const HeaderOptions&, const OCRepresentation&, const int)> OC::PostCallback
typedef std::function<void(const HeaderOptions&, const OCRepresentation&, const int)> OC::PutCallback
typedef std::map< std::string, std::vector<std::string> > OC::QueryParamsList
typedef std::map<std::string, std::string> OC::QueryParamsMap
typedef std::vector<OCResourceHandle> OC::ResourceHandles
typedef std::function<void(PMResultList_t *result, int hasError)> OC::ResultCallBack
typedef std::function<void(OCStackResult, const unsigned int, const std::string&)> OC::SubscribeCallback
typedef std::string OC::URI
typedef std::function<OCStackResult()> OC::UserConfirmNumCB
typedef std::vector<OicUuid_t> OC::UuidList_t

Enumeration Type Documentation

enum OC::InterfaceType
strong
Enumerator
None 
LinkParent 
BatchParent 
DefaultParent 
LinkChild 
BatchChild 
DefaultChild 
enum OC::ModeType
strong

Host Mode of Operation.

Enumerator
Server 
Client 
Both 
Gateway 

Client server mode along with routing capabilities.

enum OC::ObserveAction
strong
Enumerator
ObserveRegister 
ObserveUnregister 
enum OC::ObserveType
strong
Enumerator
Observe 
ObserveAll 
Enumerator
None 
enum OC::OCPlatformStatus
strong
Enumerator
PlatformUp 
PlatformDown 
enum OC::QualityOfService : uint8_t
strong

Quality of Service attempts to abstract the guarantees provided by the underlying transport protocol.

The precise definitions of each quality of service level depend on the implementation. In descriptions below are for the current implementation and may changed over time.

Enumerator
LowQos 

Packet delivery is best effort.

MidQos 

Packet delivery is best effort.

HighQos 

Acknowledgments are used to confirm delivery.

NaQos 

No Quality is defined, let the stack decide.

Enumerator
RequestFlag 
ObserverFlag 
enum OC::ServiceType
strong
Enumerator
InProc 
OutOfProc 

Function Documentation

std::ostream& OC::operator<< ( std::ostream &  os,
const OCResourceIdentifier &  ri 
)
std::ostream& OC::operator<< ( std::ostream &  os,
const OCRepresentation::AttributeItem &  ai 
)

Variable Documentation

const std::string OC::BATCH_INTERFACE = "oic.if.b"
const std::string OC::DEFAULT_INTERFACE = "oic.if.baseline"
const std::string OC::GROUP_INTERFACE = "oic.mi.grp"
const std::string OC::LINK_INTERFACE = "oic.if.ll"
auto OC::oclog
Initial value:
= []() -> boost::iostreams::stream<OC::oc_log_stream>&
{
}
auto oclog_target
Definition: OCApi.h:62