QueryCallback< Result, ParamType, chain > Class Template Reference

#include <Callback.h>

Public Member Functions
	QueryCallback ()
void	SetFutureResult (std::future< Result > value)
	The parameter of this function should be a resultset returned from either .AsyncQuery or .AsyncPQuery. More...
std::future< Result > &	GetFutureResult ()
bool	IsReady ()
void	GetResult (Result &res)
void	FreeResult ()
void	SetParam (ParamType value)
ParamType	GetParam ()
void	ResetStage ()
	Resets the stage of the callback chain. More...
void	NextStage ()
	Advances the callback chain to the next stage, so upper level code can act on its results accordingly. More...
uint8	GetStage ()
	Returns the callback stage (or CALLBACK_STAGE_INVALID if invalid) More...
void	Reset ()
	Resets all underlying variables (param, result and stage) More...

Private Member Functions
	QueryCallback (QueryCallback const &right)=delete
QueryCallback &	operator= (QueryCallback const &right)=delete

Private Attributes
std::future< Result >	_result
ParamType	_param
uint8	_stage

Constructor & Destructor Documentation

template<typename Result, typename ParamType, bool chain = false>

QueryCallback< Result, ParamType, chain >::QueryCallback ( )

inline

: _param(), _stage(chain ? 0 : CALLBACK_STAGE_INVALID) { }

template<typename Result, typename ParamType, bool chain = false>

QueryCallback< Result, ParamType, chain >::QueryCallback ( QueryCallback< Result, ParamType, chain > const &  right )

privatedelete

Member Function Documentation

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::FreeResult ( )

inline

 {
 // Nothing to do here, the constructor of std::future will take care of the cleanup
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

std::future<Result>& QueryCallback< Result, ParamType, chain >::GetFutureResult ( )

inline

 {
 return _result;
 }

template<typename Result, typename ParamType, bool chain = false>

ParamType QueryCallback< Result, ParamType, chain >::GetParam ( )

inline

 {
 return _param;
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::GetResult ( Result &  res )

inline

 {
 res = _result.get();
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

uint8 QueryCallback< Result, ParamType, chain >::GetStage ( )

inline

Returns the callback stage (or CALLBACK_STAGE_INVALID if invalid)

 {
 return _stage;
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

bool QueryCallback< Result, ParamType, chain >::IsReady ( )

inline

 {
 return _result.valid() && _result.wait_for(std::chrono::seconds(0)) == std::future_status::ready;
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::NextStage ( )

inline

Advances the callback chain to the next stage, so upper level code can act on its results accordingly.

 {
 if (!chain)
 return;

 ++_stage;
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

QueryCallback& QueryCallback< Result, ParamType, chain >::operator= ( QueryCallback< Result, ParamType, chain > const &  right )

privatedelete

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::Reset ( )

inline

Resets all underlying variables (param, result and stage)

 {
 SetParam(ParamType());
 FreeResult();
 ResetStage();
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::ResetStage ( )

inline

Resets the stage of the callback chain.

 {
 if (!chain)
 return;

 _stage = 0;
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::SetFutureResult ( std::future< Result >  value )

inline

The parameter of this function should be a resultset returned from either .AsyncQuery or .AsyncPQuery.

 {
 _result = std::move(value);
 }

Here is the caller graph for this function:

template<typename Result, typename ParamType, bool chain = false>

void QueryCallback< Result, ParamType, chain >::SetParam ( ParamType  value )

inline

 {
 _param = value;
 }

Here is the caller graph for this function:

Member Data Documentation

template<typename Result, typename ParamType, bool chain = false>

ParamType QueryCallback< Result, ParamType, chain >::_param

private

template<typename Result, typename ParamType, bool chain = false>

std::future<Result> QueryCallback< Result, ParamType, chain >::_result

private

template<typename Result, typename ParamType, bool chain = false>

uint8 QueryCallback< Result, ParamType, chain >::_stage

private

---

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

• src/common/Threading/Callback.h