Project SkyFire Core
SkyFire 5.4.8 server core API documentation
Loading...
Searching...
No Matches
QueryCallback< Result, ParamType, chain > Class Template Reference

#include <Callback.h>

Collaboration diagram for QueryCallback< Result, ParamType, chain >:

Public Member Functions

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

Private Member Functions

QueryCallback & operator= (QueryCallback const &right)=delete
 QueryCallback (QueryCallback const &right)=delete

Private Attributes

ParamType _param
Skyfire::Future< Result > _result
uint8 _stage

Detailed Description

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

Definition at line 22 of file Callback.h.

Constructor & Destructor Documentation

◆ QueryCallback() [1/2]

template<typename Result, typename ParamType, bool chain = false>
QueryCallback< Result, ParamType, chain >::QueryCallback ( )
inline

Definition at line 25 of file Callback.h.

References _param, _stage, and CALLBACK_STAGE_INVALID.

Referenced by operator=(), and QueryCallback().

◆ QueryCallback() [2/2]

template<typename Result, typename ParamType, bool chain = false>
QueryCallback< Result, ParamType, chain >::QueryCallback ( QueryCallback< Result, ParamType, chain > const & right)
privatedelete

References QueryCallback().

Member Function Documentation

◆ FreeResult()

template<typename Result, typename ParamType, bool chain = false>
void QueryCallback< Result, ParamType, chain >::FreeResult ( )
inline

Definition at line 48 of file Callback.h.

References _result.

Referenced by Reset().

◆ GetFutureResult()

template<typename Result, typename ParamType, bool chain = false>
Skyfire::Future< Result > QueryCallback< Result, ParamType, chain >::GetFutureResult ( )
inline

Definition at line 33 of file Callback.h.

References _result.

◆ GetParam()

template<typename Result, typename ParamType, bool chain = false>
ParamType QueryCallback< Result, ParamType, chain >::GetParam ( )
inline

Definition at line 58 of file Callback.h.

References _param.

◆ GetResult()

template<typename Result, typename ParamType, bool chain = false>
void QueryCallback< Result, ParamType, chain >::GetResult ( Result & res)
inline

Definition at line 43 of file Callback.h.

References _result.

◆ GetStage()

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).

Definition at line 82 of file Callback.h.

References _stage.

◆ IsReady()

template<typename Result, typename ParamType, bool chain = false>
int QueryCallback< Result, ParamType, chain >::IsReady ( )
inline

Definition at line 38 of file Callback.h.

References _result.

◆ NextStage()

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.

Definition at line 73 of file Callback.h.

References _stage.

◆ operator=()

template<typename Result, typename ParamType, bool chain = false>
QueryCallback & QueryCallback< Result, ParamType, chain >::operator= ( QueryCallback< Result, ParamType, chain > const & right)
privatedelete

References QueryCallback().

◆ Reset()

template<typename Result, typename ParamType, bool chain = false>
void QueryCallback< Result, ParamType, chain >::Reset ( )
inline

Resets all underlying variables (param, result and stage).

Definition at line 88 of file Callback.h.

References FreeResult(), ResetStage(), and SetParam().

◆ ResetStage()

template<typename Result, typename ParamType, bool chain = false>
void QueryCallback< Result, ParamType, chain >::ResetStage ( )
inline

Resets the stage of the callback chain.

Definition at line 64 of file Callback.h.

References _stage.

Referenced by Reset().

◆ SetFutureResult()

template<typename Result, typename ParamType, bool chain = false>
void QueryCallback< Result, ParamType, chain >::SetFutureResult ( Skyfire::Future< Result > value)
inline

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

Definition at line 28 of file Callback.h.

References _result.

◆ SetParam()

template<typename Result, typename ParamType, bool chain = false>
void QueryCallback< Result, ParamType, chain >::SetParam ( ParamType value)
inline

Definition at line 53 of file Callback.h.

References _param.

Referenced by Reset().

Member Data Documentation

◆ _param

template<typename Result, typename ParamType, bool chain = false>
ParamType QueryCallback< Result, ParamType, chain >::_param
private

Definition at line 97 of file Callback.h.

Referenced by GetParam(), QueryCallback(), and SetParam().

◆ _result

template<typename Result, typename ParamType, bool chain = false>
Skyfire::Future<Result> QueryCallback< Result, ParamType, chain >::_result
private

Definition at line 96 of file Callback.h.

Referenced by FreeResult(), GetFutureResult(), GetResult(), IsReady(), and SetFutureResult().

◆ _stage

template<typename Result, typename ParamType, bool chain = false>
uint8 QueryCallback< Result, ParamType, chain >::_stage
private

Definition at line 98 of file Callback.h.

Referenced by GetStage(), NextStage(), QueryCallback(), and ResetStage().

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