QueryCallback_2< Result, ParamType1, ParamType2, chain > Class Template Reference

#include <Callback.h>

Public Member Functions
	QueryCallback_2 ()
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	SetFirstParam (ParamType1 value)
void	SetSecondParam (ParamType2 value)
ParamType1	GetFirstParam ()
ParamType2	GetSecondParam ()
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_2 (QueryCallback_2 const &right)=delete
QueryCallback_2 &	operator= (QueryCallback_2 const &right)=delete

Private Attributes
std::future< Result >	_result
ParamType1	_param_1
ParamType2	_param_2
uint8	_stage

Constructor & Destructor Documentation

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

QueryCallback_2< Result, ParamType1, ParamType2, chain >::QueryCallback_2 ( )

inline

: _stage(chain ? 0 : CALLBACK_STAGE_INVALID) { }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

QueryCallback_2< Result, ParamType1, ParamType2, chain >::QueryCallback_2 ( QueryCallback_2< Result, ParamType1, ParamType2, chain > const &  right )

privatedelete

Member Function Documentation

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, 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 ParamType1 , typename ParamType2 , bool chain = false>

ParamType1 QueryCallback_2< Result, ParamType1, ParamType2, chain >::GetFirstParam ( )

inline

 {
 return _param_1;
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

std::future<Result>& QueryCallback_2< Result, ParamType1, ParamType2, chain >::GetFutureResult ( )

inline

 {
 return _result;
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, chain >::GetResult ( Result &  res )

inline

 {
 res = _result.get();
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

ParamType2 QueryCallback_2< Result, ParamType1, ParamType2, chain >::GetSecondParam ( )

inline

 {
 return _param_2;
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

uint8 QueryCallback_2< Result, ParamType1, ParamType2, chain >::GetStage ( )

inline

Returns the callback stage (or CALLBACK_STAGE_INVALID if invalid)

 {
 return _stage;
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

bool QueryCallback_2< Result, ParamType1, ParamType2, chain >::IsReady ( )

inline

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

Here is the call graph for this function:

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, 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;
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

QueryCallback_2& QueryCallback_2< Result, ParamType1, ParamType2, chain >::operator= ( QueryCallback_2< Result, ParamType1, ParamType2, chain > const &  right )

privatedelete

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, chain >::Reset ( )

inline

Resets all underlying variables (param, result and stage)

 {
 SetFirstParam(NULL);
 SetSecondParam(NULL);
 FreeResult();
 ResetStage();
 }

Here is the call graph for this function:

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, 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 ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, chain >::SetFirstParam ( ParamType1  value )

inline

 {
 _param_1 = value;
 }

Here is the caller graph for this function:

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, 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);
 }

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

void QueryCallback_2< Result, ParamType1, ParamType2, chain >::SetSecondParam ( ParamType2  value )

inline

 {
 _param_2 = value;
 }

Here is the caller graph for this function:

Member Data Documentation

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

ParamType1 QueryCallback_2< Result, ParamType1, ParamType2, chain >::_param_1

private

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

ParamType2 QueryCallback_2< Result, ParamType1, ParamType2, chain >::_param_2

private

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

std::future<Result> QueryCallback_2< Result, ParamType1, ParamType2, chain >::_result

private

template<typename Result , typename ParamType1 , typename ParamType2 , bool chain = false>

uint8 QueryCallback_2< Result, ParamType1, ParamType2, chain >::_stage

private

---

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

• src/common/Threading/Callback.h