kanzi::connect::ServerState Class Reference

Class that represents, and maintains, a service state. More...

#include <serverstate.hpp>

Public Types
typedef function< void(State)>	ServerStateChangeCallback
enum	State {   Unknown , Initializing , Stopping , Stopped ,   Starting , Running }
typedef enum kanzi::connect::ServerState::State	State
typedef shared_ptr< void >	StateListenerSubscriptionToken

Public Member Functions
State	getServerState ()
	Retrieve the current state.
StateListenerSubscriptionToken	registerServerStateListener (ServerStateChangeCallback callback)
	Add callback to listen service states.
	ServerState ()
	C++ constructor. initialize object.
void	setServerState (State state)
	Configure the server state.
void	unregisterServerStateListener (StateListenerSubscriptionToken token)
	Remove callback that listened server state changes.

Detailed Description

Class that represents, and maintains, a service state.

Member Typedef Documentation

ServerStateChangeCallback

typedef function<void(State)> kanzi::connect::ServerState::ServerStateChangeCallback

State

typedef enum kanzi::connect::ServerState::State kanzi::connect::ServerState::State

StateListenerSubscriptionToken

typedef shared_ptr<void> kanzi::connect::ServerState::StateListenerSubscriptionToken

Member Enumeration Documentation

State

enum kanzi::connect::ServerState::State

Enumerator
Unknown	Not defined yet. Used as initial value.
Initializing	Server is initializing itself.
Stopping	Server is transitioning from Running to Stopped.
Stopped	Server is stopped.
Starting	Server is transitioning from Stopped to Running.
Running	Server is running.

Constructor & Destructor Documentation

ServerState()

kanzi::connect::ServerState::ServerState

(

)

C++ constructor. initialize object.

Member Function Documentation

getServerState()

State kanzi::connect::ServerState::getServerState

(

)

Retrieve the current state.

Returns

state

registerServerStateListener()

StateListenerSubscriptionToken kanzi::connect::ServerState::registerServerStateListener

(

ServerStateChangeCallback

callback

)

Add callback to listen service states.

Parameters

callback

the method to invoke on changes.

Returns

token that can be used for unregistration.

setServerState()

void kanzi::connect::ServerState::setServerState

(

State

state

)

Configure the server state.

Parameters

state

the new server state.

unregisterServerStateListener()

void kanzi::connect::ServerState::unregisterServerStateListener

(

StateListenerSubscriptionToken

token

)

Remove callback that listened server state changes.

Parameters

token

---

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

• connect/serverstate.hpp