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

Data structure to provide the configuration. More...

Public Member Functions

 PlatformConfig (const ServiceType serviceType_, const ModeType mode_, OCPersistentStorage *ps_)
 
 PlatformConfig ()
 
 PlatformConfig (const ServiceType serviceType_, const ModeType mode_, OCConnectivityType serverConnectivity_, OCConnectivityType clientConnectivity_, const QualityOfService QoS_, OCPersistentStorage *ps_=nullptr)
 
 PlatformConfig (const ServiceType serviceType_, const ModeType mode_, const std::string &ipAddress_, const uint16_t port_, const QualityOfService QoS_, OCPersistentStorage *ps_=nullptr)
 
 PlatformConfig (const ServiceType serviceType_, const ModeType mode_, const std::string &ipAddress_, const uint16_t port_, const OCTransportAdapter transportType_, const QualityOfService QoS_, OCPersistentStorage *ps_=nullptr)
 
 PlatformConfig (const ServiceType serviceType_, const ModeType mode_, OCTransportAdapter transportType_, const QualityOfService QoS_, OCPersistentStorage *ps_=nullptr)
 
 PlatformConfig (const ServiceType serviceType_, const ModeType mode_, OCConnectivityType serverConnectivity_, OCConnectivityType clientConnectivity_, OCTransportAdapter transportType_, const QualityOfService QoS_, OCPersistentStorage *ps_=nullptr)
 

Public Attributes

ServiceType serviceType
 indicate InProc or OutOfProc. More...
 
ModeType mode
 indicate whether we want to do server, client or both. More...
 
OCConnectivityType serverConnectivity
 default flags for server. More...
 
OCConnectivityType clientConnectivity
 default flags for client. More...
 
OCTransportAdapter transportType
 transport type to initialize. More...
 
std::string ipAddress
 not used. More...
 
uint16_t port
 not used. More...
 
QualityOfService QoS
 indicate Quality of Service : LowQos, MidQos,HighQos and NaQos(No quality Defined). More...
 
OCPersistentStorageps
 persistant storage Handler structure (open/read/write/close/unlink). More...
 
bool useLegacyCleanup
 This flag allows legacy app to opt in the previous behavior of OCPlatform being cleaned up by the C++ static storage (de)initializer. More...
 

Detailed Description

Data structure to provide the configuration.

Constructor & Destructor Documentation

OC::PlatformConfig::PlatformConfig ( const ServiceType  serviceType_,
const ModeType  mode_,
OCPersistentStorage ps_ 
)
inline
OC::PlatformConfig::PlatformConfig ( )
inline
OC::PlatformConfig::PlatformConfig ( const ServiceType  serviceType_,
const ModeType  mode_,
OCConnectivityType  serverConnectivity_,
OCConnectivityType  clientConnectivity_,
const QualityOfService  QoS_,
OCPersistentStorage ps_ = nullptr 
)
inline
OC::PlatformConfig::PlatformConfig ( const ServiceType  serviceType_,
const ModeType  mode_,
const std::string &  ipAddress_,
const uint16_t  port_,
const QualityOfService  QoS_,
OCPersistentStorage ps_ = nullptr 
)
inline
OC::PlatformConfig::PlatformConfig ( const ServiceType  serviceType_,
const ModeType  mode_,
const std::string &  ipAddress_,
const uint16_t  port_,
const OCTransportAdapter  transportType_,
const QualityOfService  QoS_,
OCPersistentStorage ps_ = nullptr 
)
inline
OC::PlatformConfig::PlatformConfig ( const ServiceType  serviceType_,
const ModeType  mode_,
OCTransportAdapter  transportType_,
const QualityOfService  QoS_,
OCPersistentStorage ps_ = nullptr 
)
inline
OC::PlatformConfig::PlatformConfig ( const ServiceType  serviceType_,
const ModeType  mode_,
OCConnectivityType  serverConnectivity_,
OCConnectivityType  clientConnectivity_,
OCTransportAdapter  transportType_,
const QualityOfService  QoS_,
OCPersistentStorage ps_ = nullptr 
)
inline

Member Data Documentation

OCConnectivityType OC::PlatformConfig::clientConnectivity

default flags for client.

std::string OC::PlatformConfig::ipAddress

not used.

ModeType OC::PlatformConfig::mode

indicate whether we want to do server, client or both.

uint16_t OC::PlatformConfig::port

not used.

OCPersistentStorage* OC::PlatformConfig::ps

persistant storage Handler structure (open/read/write/close/unlink).

QualityOfService OC::PlatformConfig::QoS

indicate Quality of Service : LowQos, MidQos,HighQos and NaQos(No quality Defined).

OCConnectivityType OC::PlatformConfig::serverConnectivity

default flags for server.

ServiceType OC::PlatformConfig::serviceType

indicate InProc or OutOfProc.

OCTransportAdapter OC::PlatformConfig::transportType

transport type to initialize.

bool OC::PlatformConfig::useLegacyCleanup

This flag allows legacy app to opt in the previous behavior of OCPlatform being cleaned up by the C++ static storage (de)initializer.

The flag is set to false by default, unless a legacy constructor is used.

When the flag is set to false (i.e., the new preferred behavior), users of OCPlatform are responsible for calling start() and stop() explicitly while ensuring that the calls to them are balanced as the last call to stop() shuts down the underlying stack.


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