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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#ifndef __SAKE_H__
#define __SAKE_H__
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#include "../common/gsCommon.h"
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#if defined(__cplusplus)
extern "C" {
#endif
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#ifndef SAKE_CALL
#define SAKE_CALL
#endif
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// URL for sake webservice
#define SAKE_MAX_URL_LENGTH 128
extern char sakeiSoapUrl[SAKE_MAX_URL_LENGTH];
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// General
typedef struct SAKEInternal *SAKE;
typedef enum
{
SAKEStartupResult_SUCCESS,
SAKEStartupResult_NOT_AVAILABLE,
SAKEStartupResult_CORE_SHUTDOWN,
SAKEStartupResult_OUT_OF_MEMORY
} SAKEStartupResult;
SAKEStartupResult SAKE_CALL sakeStartup(SAKE *sakePtr);
void SAKE_CALL sakeShutdown(SAKE sake);
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// Authentication
void SAKE_CALL sakeSetGame(SAKE sake, const gsi_char *gameName, int gameId, const gsi_char *secretKey);
void SAKE_CALL sakeSetProfile(SAKE sake, int profileId, const char *loginTicket);
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// Fields
typedef enum
{
SAKEFieldType_BYTE,
SAKEFieldType_SHORT,
SAKEFieldType_INT,
SAKEFieldType_FLOAT,
SAKEFieldType_ASCII_STRING,
SAKEFieldType_UNICODE_STRING,
SAKEFieldType_BOOLEAN,
SAKEFieldType_DATE_AND_TIME,
SAKEFieldType_BINARY_DATA,
SAKEFieldType_INT64,
SAKEFieldType_NUM_FIELD_TYPES
} SAKEFieldType;
typedef struct
{
gsi_u8 *mValue;
int mLength;
} SAKEBinaryData;
typedef union
{
gsi_u8 mByte;
gsi_i16 mShort;
gsi_i32 mInt;
float mFloat;
char *mAsciiString;
gsi_u16 *mUnicodeString;
gsi_bool mBoolean;
time_t mDateAndTime;
SAKEBinaryData mBinaryData;
gsi_i64 mInt64;
} SAKEValue;
typedef struct
{
char *mName;
SAKEFieldType mType;
SAKEValue mValue;
} SAKEField;
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// Requests
typedef struct SAKERequestInternal *SAKERequest;
typedef enum
{
SAKEStartRequestResult_SUCCESS,
SAKEStartRequestResult_NOT_AUTHENTICATED,
SAKEStartRequestResult_OUT_OF_MEMORY,
SAKEStartRequestResult_BAD_INPUT,
SAKEStartRequestResult_BAD_TABLEID,
SAKEStartRequestResult_BAD_FIELDS,
SAKEStartRequestResult_BAD_NUM_FIELDS,
SAKEStartRequestResult_BAD_FIELD_NAME,
SAKEStartRequestResult_BAD_FIELD_TYPE,
SAKEStartRequestResult_BAD_FIELD_VALUE,
SAKEStartRequestResult_BAD_OFFSET,
SAKEStartRequestResult_BAD_MAX,
SAKEStartRequestResult_BAD_RECORDIDS,
SAKEStartRequestResult_BAD_NUM_RECORDIDS,
SAKEStartRequestResult_UNKNOWN_ERROR
} SAKEStartRequestResult;
typedef enum
{
SAKERequestResult_SUCCESS,
SAKERequestResult_SECRET_KEY_INVALID,
SAKERequestResult_SERVICE_DISABLED,
SAKERequestResult_CONNECTION_TIMEOUT,
SAKERequestResult_CONNECTION_ERROR,
SAKERequestResult_MALFORMED_RESPONSE,
SAKERequestResult_OUT_OF_MEMORY,
SAKERequestResult_DATABASE_UNAVAILABLE,
SAKERequestResult_LOGIN_TICKET_INVALID,
SAKERequestResult_LOGIN_TICKET_EXPIRED,
SAKERequestResult_TABLE_NOT_FOUND,
SAKERequestResult_RECORD_NOT_FOUND,
SAKERequestResult_FIELD_NOT_FOUND,
SAKERequestResult_FIELD_TYPE_INVALID,
SAKERequestResult_NO_PERMISSION,
SAKERequestResult_RECORD_LIMIT_REACHED,
SAKERequestResult_ALREADY_RATED,
SAKERequestResult_NOT_RATEABLE,
SAKERequestResult_NOT_OWNED,
SAKERequestResult_FILTER_INVALID,
SAKERequestResult_SORT_INVALID,
SAKERequestResult_TARGET_FILTER_INVALID,
SAKERequestResult_UNKNOWN_ERROR
} SAKERequestResult;
typedef void (*SAKERequestCallback)(SAKE sake, SAKERequest request, SAKERequestResult result, void *inputData, void *outputData, void *userData);
///////////////////////////////////////////////////////////////////////////////
// get start request result
SAKEStartRequestResult SAKE_CALL sakeGetStartRequestResult(SAKE sake);
///////////////////////////////////////////////////////////////////////////////
// create record
typedef struct
{
char *mTableId;
SAKEField *mFields;
int mNumFields;
} SAKECreateRecordInput;
typedef struct
{
int mRecordId;
} SAKECreateRecordOutput;
SAKERequest SAKE_CALL sakeCreateRecord(SAKE sake, SAKECreateRecordInput *input, SAKERequestCallback callback, void *userData);
//////////////////////////// ///////////////////////////////////////////////////
// update record
typedef struct
{
char *mTableId;
int mRecordId;
SAKEField *mFields;
int mNumFields;
} SAKEUpdateRecordInput;
SAKERequest SAKE_CALL sakeUpdateRecord(SAKE sake, SAKEUpdateRecordInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// delete record
typedef struct
{
char *mTableId;
int mRecordId;
} SAKEDeleteRecordInput;
SAKERequest SAKE_CALL sakeDeleteRecord(SAKE sake, SAKEDeleteRecordInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// search for records
typedef struct
{
char *mTableId;
char **mFieldNames;
int mNumFields;
gsi_char *mFilter;
char *mSort;
int mOffset;
int mMaxRecords;
gsi_char *mTargetRecordFilter;
int mSurroundingRecordsCount;
int *mOwnerIds;
int mNumOwnerIds;
gsi_bool mCacheFlag;
} SAKESearchForRecordsInput;
typedef struct
{
int mNumRecords;
SAKEField **mRecords;
} SAKESearchForRecordsOutput;
SAKERequest SAKE_CALL sakeSearchForRecords(SAKE sake, SAKESearchForRecordsInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// get my records
typedef struct
{
char *mTableId;
char **mFieldNames;
int mNumFields;
} SAKEGetMyRecordsInput;
typedef struct
{
int mNumRecords;
SAKEField **mRecords;
} SAKEGetMyRecordsOutput;
SAKERequest SAKE_CALL sakeGetMyRecords(SAKE sake, SAKEGetMyRecordsInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// get specific records
typedef struct
{
char *mTableId;
int *mRecordIds;
int mNumRecordIds;
char **mFieldNames;
int mNumFields;
} SAKEGetSpecificRecordsInput;
typedef struct
{
int mNumRecords;
SAKEField **mRecords;
} SAKEGetSpecificRecordsOutput;
SAKERequest SAKE_CALL sakeGetSpecificRecords(SAKE sake, SAKEGetSpecificRecordsInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// get random record
typedef struct
{
char *mTableId;
char **mFieldNames;
int mNumFields;
gsi_char *mFilter;
} SAKEGetRandomRecordInput;
typedef struct
{
SAKEField *mRecord;
} SAKEGetRandomRecordOutput;
SAKERequest SAKE_CALL sakeGetRandomRecord(SAKE sake, SAKEGetRandomRecordInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// rate record
typedef struct
{
char *mTableId;
int mRecordId;
gsi_u8 mRating;
} SAKERateRecordInput;
typedef struct
{
int mNumRatings;
float mAverageRating;
} SAKERateRecordOutput;
SAKERequest SAKE_CALL sakeRateRecord(SAKE sake, SAKERateRecordInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// get record limit
typedef struct
{
char *mTableId;
} SAKEGetRecordLimitInput;
typedef struct
{
int mLimitPerOwner;
int mNumOwned;
} SAKEGetRecordLimitOutput;
SAKERequest SAKE_CALL sakeGetRecordLimit(SAKE sake, SAKEGetRecordLimitInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
// get record count
typedef struct
{
char *mTableId;
gsi_char *mFilter;
gsi_bool mCacheFlag;
} SAKEGetRecordCountInput;
typedef struct
{
int mCount;
} SAKEGetRecordCountOutput;
SAKERequest SAKE_CALL sakeGetRecordCount(SAKE sake, SAKEGetRecordCountInput *input, SAKERequestCallback callback, void *userData);
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// read request utility
SAKEField * SAKE_CALL sakeGetFieldByName(const char *name, SAKEField *fields, int numFields);
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// Files
#define SAKE_FILE_RESULT_HEADER "Sake-File-Result:"
#define SAKE_FILE_ID_HEADER "Sake-File-Id:"
// Sake-File-Result from the HTTP response header
typedef enum
{
SAKEFileResult_SUCCESS = 0,
SAKEFileResult_BAD_HTTP_METHOD = 1,
SAKEFileResult_BAD_FILE_COUNT = 2,
SAKEFileResult_MISSING_PARAMETER = 3,
SAKEFileResult_FILE_NOT_FOUND = 4,
SAKEFileResult_FILE_TOO_LARGE = 5,
SAKEFileResult_SERVER_ERROR = 6,
SAKEFileResult_UNKNOWN_ERROR
} SAKEFileResult;
gsi_bool SAKE_CALL sakeSetFileDownloadURL(SAKE sake, gsi_char url[SAKE_MAX_URL_LENGTH]);
gsi_bool SAKE_CALL sakeSetFileUploadURL(SAKE sake, gsi_char url[SAKE_MAX_URL_LENGTH]);
gsi_bool SAKE_CALL sakeGetFileDownloadURL(SAKE sake, int fileId, gsi_char url[SAKE_MAX_URL_LENGTH]);
gsi_bool SAKE_CALL sakeGetFileUploadURL(SAKE sake, gsi_char url[SAKE_MAX_URL_LENGTH]);
gsi_bool SAKE_CALL sakeGetFileResultFromHeaders(const char *headers, SAKEFileResult *result);
gsi_bool SAKE_CALL sakeGetFileIdFromHeaders(const char *headers, int *fileId);
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#if defined(__cplusplus)
} // extern "C"
#endif
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#endif // __SAKE_H__
|
