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
|
#ifndef _AVAILABLE_H_
#define _AVAILABLE_H_
#include "gsStringUtil.h"
#ifdef __cplusplus
extern "C" {
#endif
#ifndef GSI_UNICODE
#define GSIStartAvailableCheck GSIStartAvailableCheckA
#else
#define GSIStartAvailableCheck GSIStartAvailableCheckW
#endif
// the available check contacts a backend server at "<gamename>.available.gamespy.com"
// an app can resolve the hostname itself and store the IP here before starting the check
extern char GSIACHostname[64];
// these are possible return types for GSIAvailableCheckThink
typedef enum
{
GSIACWaiting, // still waiting for a response from the backend
GSIACAvailable, // the game's backend services are available
GSIACUnavailable, // the game's backend services are unavailable
GSIACTemporarilyUnavailable // the game's backend services are temporarily unavailable
} GSIACResult;
// start an available check for a particular game
// return 0 if no error starting up, non-zero if there's an error
void GSIStartAvailableCheck(const gsi_char * gamename);
// let the available check think
// continue to call this while it returns GSIACWaiting
// if it returns GSIACAvailable, use the GameSpy SDKs as normal
// if it returns GSIACUnavailable or GSIACTemporarilyUnavailable, do NOT
// continue to use the GameSpy SDKs. the backend services are not available
// for the game. in this case, you can show the user a
// message based on the particular result.
GSIACResult GSIAvailableCheckThink(void);
// this should only be used if the availability check needs to be aborted
// for example, if the player leaves the game's multiplayer area before the check completes
void GSICancelAvailableCheck(void);
// internal use only
extern GSIACResult __GSIACResult;
extern char __GSIACGamename[64];
#ifdef __cplusplus
}
#endif
#endif
|
