client-cpp  0.7.4
kaa::Kaa Class Reference

Creates a new Kaa client based on IKaaClientPlatformContext and optional IKaaClientStateListener. More...

#include <Kaa.hpp>

Public Member Functions

 Kaa ()=delete
 Use newClient() to create a Kaa client instance. More...
 
 Kaa (const Kaa &)=delete
 Use newClient() to create a Kaa client instance. More...
 
Kaaoperator= (const Kaa &)=delete
 Use newClient() to create a Kaa client instance. More...
 

Static Public Member Functions

static std::shared_ptr
< IKaaClient
newClient (IKaaClientPlatformContextPtr context=std::make_shared< KaaClientPlatformContext >(), IKaaClientStateListenerPtr listener=IKaaClientStateListenerPtr())
 Creates a new instance of a Kaa client. More...
 
static KAA_DEPRECATED void init (int options=0)
 Initialize Kaa library. More...
 
static KAA_DEPRECATED void start ()
 Starts Kaa's workflow. More...
 
static KAA_DEPRECATED void stop ()
 Stops Kaa's workflow. More...
 
static KAA_DEPRECATED void pause ()
 Pauses Kaa's workflow. More...
 
static KAA_DEPRECATED void resume ()
 Resumes Kaa's workflow. More...
 
static KAA_DEPRECATED IKaaClientgetKaaClient ()
 Retrieves the Kaa client. More...
 

Detailed Description

Creates a new Kaa client based on IKaaClientPlatformContext and optional IKaaClientStateListener.

Definition at line 44 of file Kaa.hpp.

Constructor & Destructor Documentation

kaa::Kaa::Kaa ( )
delete

Use newClient() to create a Kaa client instance.

kaa::Kaa::Kaa ( const Kaa )
delete

Use newClient() to create a Kaa client instance.

Member Function Documentation

static KAA_DEPRECATED IKaaClient& kaa::Kaa::getKaaClient ( )
static

Retrieves the Kaa client.

Deprecated:
Use newClient() to create a Kaa client instance.
Returns
IKaaClient instance.
static KAA_DEPRECATED void kaa::Kaa::init ( int  options = 0)
static

Initialize Kaa library.

Deprecated:
Use newClient() to create a Kaa client instance.
static std::shared_ptr<IKaaClient> kaa::Kaa::newClient ( IKaaClientPlatformContextPtr  context = std::make_shared< KaaClientPlatformContext >(),
IKaaClientStateListenerPtr  listener = IKaaClientStateListenerPtr() 
)
static

Creates a new instance of a Kaa client.

Parameters
contextPlatform context.
listenerKaa client state listener.
Returns
New instance of Kaa client.
Kaa& kaa::Kaa::operator= ( const Kaa )
delete

Use newClient() to create a Kaa client instance.

static KAA_DEPRECATED void kaa::Kaa::pause ( )
static

Pauses Kaa's workflow.

Deprecated:
Use kaa::IKaaClient::pause().
static KAA_DEPRECATED void kaa::Kaa::resume ( )
static

Resumes Kaa's workflow.

Deprecated:
Use kaa::IKaaClient::resume().
static KAA_DEPRECATED void kaa::Kaa::start ( )
static

Starts Kaa's workflow.

Deprecated:
Use kaa::IKaaClient::start().
static KAA_DEPRECATED void kaa::Kaa::stop ( )
static

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