summaryrefslogtreecommitdiff
path: root/src/server/database/Database/Callback.h
blob: e71e6653b3f51bd88d27996ad191115918ad9b2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
/*
 * Copyright (C) 2016+     AzerothCore <www.azerothcore.org>
 * Copyright (C) 2008-2016 TrinityCore <http://www.trinitycore.org/>
 * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
 */

#ifndef _CALLBACK_H
#define _CALLBACK_H

#include <ace/Future.h>
#include <ace/Future_Set.h>
#include "QueryResult.h"

typedef ACE_Future<QueryResult> QueryResultFuture;
typedef ACE_Future<PreparedQueryResult> PreparedQueryResultFuture;

/*! A simple template using ACE_Future to manage callbacks from the thread and object that
    issued the request. <ParamType> is variable type of parameter that is used as parameter
    for the callback function.
*/
#define CALLBACK_STAGE_INVALID uint8(-1)

template <typename Result, typename ParamType, bool chain = false>
class QueryCallback
{
public:
    QueryCallback() : _param(), _stage(chain ? 0 : CALLBACK_STAGE_INVALID)  {}

    //! The parameter of this function should be a resultset returned from either .AsyncQuery or .AsyncPQuery
    void SetFutureResult(ACE_Future<Result> value)
    {
        _result = value;
    }

    ACE_Future<Result> GetFutureResult()
    {
        return _result;
    }

    int IsReady()
    {
        return _result.ready();
    }

    void GetResult(Result& res)
    {
        _result.get(res);
    }

    void FreeResult()
    {
        _result.cancel();
    }

    void SetParam(ParamType value)
    {
        _param = value;
    }

    ParamType GetParam()
    {
        return _param;
    }

    //! Resets the stage of the callback chain
    void ResetStage()
    {
        if (!chain)
            return;

        _stage = 0;
    }

    //! Advances the callback chain to the next stage, so upper level code can act on its results accordingly
    void NextStage()
    {
        if (!chain)
            return;

        ++_stage;
    }

    //! Returns the callback stage (or CALLBACK_STAGE_INVALID if invalid)
    uint8 GetStage()
    {
        return _stage;
    }

    //! Resets all underlying variables (param, result and stage)
    void Reset()
    {
        SetParam(nullptr);
        FreeResult();
        ResetStage();
    }

private:
    ACE_Future<Result> _result;
    ParamType _param;
    uint8 _stage;
};

template <typename Result, typename ParamType1, typename ParamType2, bool chain = false>
class QueryCallback_2
{
public:
    QueryCallback_2() : _stage(chain ? 0 : CALLBACK_STAGE_INVALID) {}

    //! The parameter of this function should be a resultset returned from either .AsyncQuery or .AsyncPQuery
    void SetFutureResult(ACE_Future<Result> value)
    {
        _result = value;
    }

    ACE_Future<Result> GetFutureResult()
    {
        return _result;
    }

    int IsReady()
    {
        return _result.ready();
    }

    void GetResult(Result& res)
    {
        _result.get(res);
    }

    void FreeResult()
    {
        _result.cancel();
    }

    void SetFirstParam(ParamType1 value)
    {
        _param_1 = value;
    }

    void SetSecondParam(ParamType2 value)
    {
        _param_2 = value;
    }

    ParamType1 GetFirstParam()
    {
        return _param_1;
    }

    ParamType2 GetSecondParam()
    {
        return _param_2;
    }

    //! Resets the stage of the callback chain
    void ResetStage()
    {
        if (!chain)
            return;

        _stage = 0;
    }

    //! Advances the callback chain to the next stage, so upper level code can act on its results accordingly
    void NextStage()
    {
        if (!chain)
            return;

        ++_stage;
    }

    //! Returns the callback stage (or CALLBACK_STAGE_INVALID if invalid)
    uint8 GetStage()
    {
        return _stage;
    }

    //! Resets all underlying variables (param, result and stage)
    void Reset()
    {
        SetFirstParam(0);
        SetSecondParam(nullptr);
        FreeResult();
        ResetStage();
    }

private:
    ACE_Future<Result> _result;
    ParamType1 _param_1;
    ParamType2 _param_2;
    uint8 _stage;
};

template <typename Result, typename ParamType1, typename ParamType2, typename ParamType3, bool chain = false>
class QueryCallback_3
{
public:
    QueryCallback_3() : _stage(chain ? 0 : CALLBACK_STAGE_INVALID) {}

    //! The parameter of this function should be a resultset returned from either .AsyncQuery or .AsyncPQuery
    void SetFutureResult(ACE_Future<Result> value)
    {
        _result = value;
    }

    ACE_Future<Result> GetFutureResult()
    {
        return _result;
    }

    int IsReady()
    {
        return _result.ready();
    }

    void GetResult(Result& res)
    {
        _result.get(res);
    }

    void FreeResult()
    {
        _result.cancel();
    }

    void SetFirstParam(ParamType1 value)
    {
        _param_1 = value;
    }

    void SetSecondParam(ParamType2 value)
    {
        _param_2 = value;
    }

    void SetThirdParam(ParamType3 value)
    {
        _param_3 = value;
    }

    ParamType1 GetFirstParam()
    {
        return _param_1;
    }

    ParamType2 GetSecondParam()
    {
        return _param_2;
    }

    ParamType3 GetThirdParam()
    {
        return _param_3;
    }

    //! Resets the stage of the callback chain
    void ResetStage()
    {
        if (!chain)
            return;

        _stage = 0;
    }

    //! Advances the callback chain to the next stage, so upper level code can act on its results accordingly
    void NextStage()
    {
        if (!chain)
            return;

        ++_stage;
    }

    //! Returns the callback stage (or CALLBACK_STAGE_INVALID if invalid)
    uint8 GetStage()
    {
        return _stage;
    }

    //! Resets all underlying variables (param, result and stage)
    void Reset()
    {
        SetFirstParam(nullptr);
        SetSecondParam(nullptr);
        SetThirdParam(nullptr);
        FreeResult();
        ResetStage();
    }

private:
    ACE_Future<Result> _result;
    ParamType1 _param_1;
    ParamType2 _param_2;
    ParamType3 _param_3;
    uint8 _stage;
};

#endif