123
This commit is contained in:
@@ -0,0 +1,186 @@
|
||||
<HTML>
|
||||
|
||||
<HEAD>
|
||||
<TITLE>Ubi.com GameService SDK</TITLE>
|
||||
<LINK href="./gs-sdk-doc.css" rel="stylesheet" type="text/css">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
||||
<h1>GSClientClass.h</h1><div class="fragment"><pre>00001 <span class="preprocessor">#ifndef _GSCLIENCLASS_H_</span>
|
||||
00002 <span class="preprocessor"></span><span class="preprocessor">#define _GSCLIENCLASS_H_</span>
|
||||
00003 <span class="preprocessor"></span>
|
||||
00004 <span class="preprocessor">#include "GSErrors.h"</span>
|
||||
00005 <span class="preprocessor">#include "<a class="code" href="GSLoginCB_8h.html">GSLoginCB.h</a>"</span>
|
||||
00006 <span class="preprocessor">#include "<a class="code" href="GSFriendsCB_8h.html">GSFriendsCB.h</a>"</span>
|
||||
00007 <span class="preprocessor">#include "<a class="code" href="GSLobbyCB_8h.html">GSLobbyCB.h</a>"</span>
|
||||
00008 <span class="preprocessor">#include "<a class="code" href="GSPersistentCB_8h.html">GSPersistentCB.h</a>"</span>
|
||||
00009 <span class="preprocessor">#include "<a class="code" href="GSLadderQueryCB_8h.html">GSLadderQueryCB.h</a>"</span>
|
||||
00010 <span class="preprocessor">#include "GSRemoteAlgorithmCB.h"</span>
|
||||
00011 <span class="preprocessor">#include "<a class="code" href="LadderDefines_8h.html">LadderDefines.h</a>"</span>
|
||||
00012 <span class="preprocessor">#include "RemoteAlgorithmDefines.h"</span>
|
||||
00013
|
||||
00014 <span class="keyword">class </span>CGLClientLIB;
|
||||
00015
|
||||
00016 <span class="keyword">class </span>clGLClient : <span class="keyword">public</span> clLoginCallbacks, <span class="keyword">public</span> clFriendsCallbacks,
|
||||
00017 <span class="keyword">public</span> clLobbyCallbacks, <span class="keyword">public</span> clPersistentCallbacks,
|
||||
00018 <span class="keyword">public</span> clLadderQueryCallbacks
|
||||
00019 {
|
||||
00020 <span class="keyword">public</span>:
|
||||
00021 clGLClient();
|
||||
00022 <span class="keyword">virtual</span> ~clGLClient();
|
||||
00023
|
||||
00024 GSbool GL_AddRouterPing(GSint lID, GSchar *szIPAddress, GSint lPort);
|
||||
00025 GSbool GL_GetFirstPing(GSint *plID);
|
||||
00026 GSbool GL_ClearRouterPing();
|
||||
00027
|
||||
00028 <span class="comment">//Login Messages</span>
|
||||
00029 GSbool <a class="code" href="group__group1__1.html#a0">Login_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00030 GSbool <a class="code" href="group__group1__1.html#a1">LoginSend_Connect</a>(<span class="keyword">const</span> GSchar* szAddress, GSushort lPort);
|
||||
00031 GSbool <a class="code" href="group__group1__1.html#a2">LoginSend_Disconnect</a>();
|
||||
00032 GSbool <a class="code" href="group__group1__1.html#a3">LoginSend_LoginRouter</a>(<span class="keyword">const</span> GSchar* szAlias, <span class="keyword">const</span> GSchar* szPassword,
|
||||
00033 <span class="keyword">const</span> GSchar* szVersion, GSbool bPublicIP = GS_TRUE);
|
||||
00034 GSbool <a class="code" href="group__group1__1.html#a5">LoginSend_LoginWaitModule</a>(<span class="keyword">const</span> GSchar* szAlias);
|
||||
00035 GSbool <a class="code" href="group__group1__1.html#a4">LoginSend_JoinWaitModule</a>();
|
||||
00036 GSbool <a class="code" href="group__group1__1.html#a6">LoginSend_PlayerInfo</a>(<span class="keyword">const</span> GSchar* szAlias);
|
||||
00037 GSbool <a class="code" href="group__group1__1.html#a7">LoginSend_Sleep</a>();
|
||||
00038 GSbool <a class="code" href="group__group1__1.html#a8">LoginSend_WakeUp</a>();
|
||||
00039 GSbool <a class="code" href="group__group1__1.html#a9">LoginSend_ModifyAccount</a>(<span class="keyword">const</span> GSchar* szPassword, <span class="keyword">const</span> GSchar* szFirstName,
|
||||
00040 <span class="keyword">const</span> GSchar* szLastName, <span class="keyword">const</span> GSchar* szEmail, <span class="keyword">const</span> GSchar* szCountry);
|
||||
00041 GSbool <a class="code" href="group__group1__1.html#a10">LoginSend_CreateAccount</a>(<span class="keyword">const</span> GSchar* szVersion, <span class="keyword">const</span> GSchar* szNickName, <span class="keyword">const</span> GSchar* szPassword, <span class="keyword">const</span> GSchar* szFirstName,
|
||||
00042 <span class="keyword">const</span> GSchar* szLastName, <span class="keyword">const</span> GSchar* szEmail, <span class="keyword">const</span> GSchar* szCountry);
|
||||
00043 GSbool <a class="code" href="group__group1__1.html#a11">LoginSend_RequestMOTD</a>(<span class="keyword">const</span> GSchar *szLanguage);
|
||||
00044
|
||||
00045 <span class="comment">//Friends Messages</span>
|
||||
00046 GSbool <a class="code" href="group__group2__1.html#a0">Friends_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00047 GSbool <a class="code" href="group__group2__1.html#a1">FriendsSend_Connect</a>();
|
||||
00048 GSbool <a class="code" href="group__group2__1.html#a2">FriendsSend_Disconnect</a>();
|
||||
00049 GSbool <a class="code" href="group__group2__1.html#a3">FriendsSend_Login</a>(GSint lStatus = 0, GSint lMood = 0);
|
||||
00050 GSbool <a class="code" href="group__group2__1.html#a4">FriendsSend_AddFriend</a>(<span class="keyword">const</span> GSchar* szFriend, <span class="keyword">const</span> GSchar* szGroup, GSint lOptions);
|
||||
00051 GSbool <a class="code" href="group__group2__1.html#a5">FriendsSend_DelFriend</a> (<span class="keyword">const</span> GSchar* szFriend);
|
||||
00052 GSbool <a class="code" href="group__group2__1.html#a6">FriendsSend_FriendList</a>();
|
||||
00053
|
||||
00054 GSRESULT <a class="code" href="group__group2__1.html#a7">FriendsSend_IgnorePlayer</a>( <span class="keyword">const</span> GSchar * szPlayer );
|
||||
00055 GSRESULT <a class="code" href="group__group2__1.html#a8">FriendsSend_UnignorePlayer</a>( <span class="keyword">const</span> GSchar * szPlayer);
|
||||
00056 GSRESULT <a class="code" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers</a>();
|
||||
00057
|
||||
00058 GSbool <a class="code" href="group__group2__1.html#a10">FriendsSend_PagePlayer</a>(<span class="keyword">const</span> GSchar* pszAlias, <span class="keyword">const</span> GSchar* szMessage);
|
||||
00059 GSbool <a class="code" href="group__group2__1.html#a11">FriendsSend_PeerPlayer</a>(<span class="keyword">const</span> GSchar* pszAlias, GSvoid *p_Buffer, GSuint uiLength);
|
||||
00060 GSbool <a class="code" href="group__group2__1.html#a12">FriendsSend_StatusChange</a>(GSint lStatus, GSint lMood);
|
||||
00061 GSbool <a class="code" href="group__group2__1.html#a13">FriendsSend_ChangeFriend</a>(<span class="keyword">const</span> GSchar* szFriend, <span class="keyword">const</span> GSchar* szGroup, GSint lOptions);
|
||||
00062 GSbool <a class="code" href="group__group2__1.html#a14">FriendsSend_SearchPlayer</a>(<span class="keyword">const</span> GSchar* pszAlias, <span class="keyword">const</span> GSchar* pszSurName, <span class="keyword">const</span> GSchar* pszFirstName, <span class="keyword">const</span> GSchar* pszCountry, <span class="keyword">const</span> GSchar* pszEmail, GSint lSex, <span class="keyword">const</span> GSchar* pszGame);
|
||||
00063 GSbool <a class="code" href="group__group2__1.html#a15">FriendsSend_GetPlayerScores</a>(<span class="keyword">const</span> GSchar* pszAlias);
|
||||
00064
|
||||
00065 <span class="comment">//Lobby messages</span>
|
||||
00066 GSbool <a class="code" href="group__group4__1.html#a0">Lobby_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00067 GSbool <a class="code" href="group__group4__1.html#a1">LobbySend_Connect</a>();
|
||||
00068 GSbool <a class="code" href="group__group4__1.html#a4">LobbySend_Login</a>(<span class="keyword">const</span> GSchar* szGames, GSbool bPublicIP = GS_TRUE, GSushort usPlayerStatus = 0 );
|
||||
00069 GSbool <a class="code" href="group__group4__1.html#a2">LobbySend_Disconnect</a>(GSint iLobbyServerID);
|
||||
00070 GSbool <a class="code" href="group__group4__1.html#a3">LobbySend_DisconnectAll</a>();
|
||||
00071
|
||||
00072 GSbool <a class="code" href="group__group4__1.html#a8">LobbySend_CreateRoom</a>(GSint iParentGroupID, GSint iLobbyServerID, <span class="keyword">const</span> GSchar *szRoomName,
|
||||
00073 <span class="keyword">const</span> GSchar *szGames, GSushort usRoomType, GSushort usMaxPlayers, GSushort usMaxVisitors,
|
||||
00074 <span class="keyword">const</span> GSvoid *vpData, GSint iSize, <span class="keyword">const</span> GSvoid* vpAltGroupInfo, GSint iAltGroupInfoSize,
|
||||
00075 <span class="keyword">const</span> GSchar *szPassword, <span class="keyword">const</span> GSchar *szGameVersion, <span class="keyword">const</span> GSchar *szGSVersion);
|
||||
00076
|
||||
00077 GSbool <a class="code" href="group__group4__1.html#a5">LobbySend_JoinLobby</a>(GSint iGroupID, GSint iLobbyServerID,
|
||||
00078 <span class="keyword">const</span> GSchar *szPassword, GSint iConfig = 0);
|
||||
00079 GSbool <a class="code" href="group__group4__1.html#a6">LobbySend_JoinRoom</a>(GSint iGroupID, GSint iLobbyServerID, <span class="keyword">const</span> GSchar *szPassword,
|
||||
00080 GSbool bVisitor, <span class="keyword">const</span> GSchar *szVersion, GSint iConfig = 0);
|
||||
00081 GSbool <a class="code" href="group__group4__1.html#a7">LobbySend_LeaveGroup</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00082
|
||||
00083 GSbool <a class="code" href="group__group4__1.html#a17">LobbySend_GetGroupInfo</a>(GSint iGroupID, GSint iLobbyServerID, GSint iconfig);
|
||||
00084 GSbool <a class="code" href="group__group4__1.html#a18">LobbySend_GetAlternateGroupInfo</a>(GSint iGroupID, GSint iLobbyServerID );
|
||||
00085
|
||||
00086 GSbool <a class="code" href="group__group4__1.html#a19">LobbySend_InitMatchResults</a>(GSuint uiMatchID);
|
||||
00087 GSbool <a class="code" href="group__group4__1.html#a20">LobbySend_SetMatchResult</a>(GSchar *szAlias, GSuint uiFieldID, GSint iFieldValue);
|
||||
00088 GSbool <a class="code" href="group__group4__1.html#a21">LobbySend_SubmitMatchResult</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00089 GSbool <a class="code" href="group__group4__1.html#a22">LobbySend_ClearMatchResult</a>();
|
||||
00090
|
||||
00091 GSbool <a class="code" href="group__group4__1.html#a9">LobbySend_StartMatch</a>(GSint iGroupID, GSint iLobbyServerID, GSuint uiMode = 0 );
|
||||
00092 GSbool <a class="code" href="group__group4__1.html#a10">LobbySend_MatchFinish</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00093 GSbool <a class="code" href="group__group4__1.html#a12">LobbySend_PlayerMatchStarted</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00094 GSbool <a class="code" href="group__group4__1.html#a13">LobbySend_PlayerMatchFinished</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00095
|
||||
00096 GSbool <a class="code" href="group__group4__1.html#a11">LobbySend_NewMaster</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias);
|
||||
00097 GSbool <a class="code" href="group__group4__1.html#a14">LobbySend_PlayerKick</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias, GSchar *szReason);
|
||||
00098 GSbool <a class="code" href="group__group4__1.html#a15">LobbySend_GetParentGroupID</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00099 GSbool <a class="code" href="group__group4__1.html#a16">LobbySend_UpdateRoomConfig</a>(GSint iGroupID, GSint iLobbyServerID, GSbyte bDedicatedServer,
|
||||
00100 GSbyte bOpen, GSbyte bScore_Submission, GSint iMaxPlayers,
|
||||
00101 GSint iMaxVisitors, <span class="keyword">const</span> GSchar* szPassword, <span class="keyword">const</span> GSvoid* vpData,
|
||||
00102 GSint iSize, <span class="keyword">const</span> GSvoid* vpAltGroupInfo, GSint iGroupInfoSize );
|
||||
00103
|
||||
00104 GSbool <a class="code" href="group__group4__1.html#a24">LobbySend_GameStart</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00105 GSbool <a class="code" href="group__group4__1.html#a27">LobbySend_GameReady</a>(GSint iGroupID, GSint iLobbyServerID, GSvoid* vpGameData, GSint iSize,
|
||||
00106 GSushort usPort = 0, GSchar *szIPAddress = 0);
|
||||
00107 GSbool <a class="code" href="group__group4__1.html#a26">LobbySend_GameFinish</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00108 GSbool <a class="code" href="group__group4__1.html#a25">LobbySend_GameConnected</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00109
|
||||
00110 GSbool <a class="code" href="group__group4__1.html#a28">LobbySend_UpdateGameInfo</a>(GSint iGroupID, GSint iLobbyServerID, GSvoid* vpGameData, GSint iSize,
|
||||
00111 GSushort usPort = 0, GSchar *szIPAddress = 0);
|
||||
00112 GSbool <a class="code" href="group__group4__1.html#a29">LobbySend_PlayerBan</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias, GSchar *szReason);
|
||||
00113 GSbool <a class="code" href="group__group4__1.html#a30">LobbySend_PlayerUnBan</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias);
|
||||
00114 GSbool <a class="code" href="group__group4__1.html#a31">LobbySend_GetPlayerBannedList</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00115 GSbool <a class="code" href="group__group4__1.html#a32">LobbySend_SetPlayerInfo</a>(GSvoid *vpPlayerData, GSint iPlayerDataSize);
|
||||
00116 GSbool <a class="code" href="group__group4__1.html#a33">LobbySend_GetPlayerGroups</a>(GSchar *szAlias);
|
||||
00117 GSbool <a class="code" href="group__group4__1.html#a34">LobbySend_ChangeRequestedLobbies</a>(<span class="keyword">const</span> GSchar* szGames);
|
||||
00118
|
||||
00119 GSbool <a class="code" href="group__group5__1.html#a2">PS_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00120 GSbool <a class="code" href="group__group5__1.html#a0">PSSend_Login</a>();
|
||||
00121 GSbool <a class="code" href="group__group5__1.html#a1">PSSend_Disconnect</a>();
|
||||
00122 GSuint <a class="code" href="group__group5__1.html#a3">PSSend_GetPrivateData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00123 GSint iRecordID);
|
||||
00124 GSuint <a class="code" href="group__group5__1.html#a4">PSSend_SetPrivateData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00125 GSint iRecordID, <span class="keyword">const</span> GSvoid *vpData, GSint iSize);
|
||||
00126 GSuint <a class="code" href="group__group5__1.html#a5">PSSend_GetPublicData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00127 GSint iRecordID, <span class="keyword">const</span> GSchar *szPlayerAlias = 0);
|
||||
00128 GSuint <a class="code" href="group__group5__1.html#a6">PSSend_SetPublicData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00129 GSint iRecordID, <span class="keyword">const</span> GSvoid *vpData, GSint iSize);
|
||||
00130
|
||||
00131 GSbool <a class="code" href="group__group6__1.html#a0">LadderQuery_Initialize</a>(GSchar *szLocale);
|
||||
00132 GSbool <a class="code" href="group__group6__1.html#a1">LadderQuery_Uninitialize</a>();
|
||||
00133 GSbool <a class="code" href="group__group6__1.html#a2">LadderQuery_Engine</a>(GSuint uiMaxPostingDelay = 500,GSuint uiMaxsOperationalDelay = 800);
|
||||
00134 GSuint <a class="code" href="group__group6__1.html#a4">LadderQuery_SendRequest</a>();
|
||||
00135
|
||||
00136 GSbool <a class="code" href="group__group6__1.html#a3">LadderQuery_CreateRequest</a>(GSchar *szGameName, GSuint uiEvent = 0, GSuint uiMode = 0);
|
||||
00137 GSbool <a class="code" href="group__group6__1.html#a5">LadderQuery_RequestPivotUser</a>(<span class="keyword">const</span> GSchar *pszEntry, GSuint uiNumberOfEntries);
|
||||
00138 GSbool <a class="code" href="group__group6__1.html#a6">LadderQuery_RequestPivotRow</a>(GSuint uiEntry, GSuint uiNumberOfEntries);
|
||||
00139 GSbool <a class="code" href="group__group6__1.html#a7">LadderQuery_RequestSet</a>(<span class="keyword">const</span> GSchar *pszEntries[], GSuint uiNumberOfEntries);
|
||||
00140 GSbool <a class="code" href="group__group6__1.html#a8">LadderQuery_RequestOrderedList</a>(GSuint uiFirstEntry, GSuint uiNumberOfEntries);
|
||||
00141
|
||||
00142 GSbool <a class="code" href="group__group6__1.html#a9">LadderQuery_AddSortConstraint</a>(<span class="keyword">const</span> GSchar *pszField, GSbool bSortDirection);
|
||||
00143 GSbool <a class="code" href="group__group6__1.html#a10">LadderQuery_AddFilterConstraint</a>(<span class="keyword">const</span> <a class="code" href="structLADDER__FILTER.html">LADDER_FILTER</a> *pLadderFilter[], GSuint uiListOfFilters);
|
||||
00144 GSbool <a class="code" href="group__group6__1.html#a11">LadderQuery_AddDisplayConstraint</a>(<span class="keyword">const</span> GSchar *pszFields[], GSuint uiNumberOfFields);
|
||||
00145
|
||||
00146 GSbool <a class="code" href="group__group6__2.html#a0">LadderQuery_GetResultSearchCount</a>(GSuint uiRequestID, GSuint & uiCount);
|
||||
00147 GSbool <a class="code" href="group__group6__2.html#a1">LadderQuery_GetResultEntryCount</a>(GSuint uiRequestID, GSuint & uiCount);
|
||||
00148 GSbool <a class="code" href="group__group6__2.html#a2">LadderQuery_GetResultFieldCaption</a>(GSuint uiRequestID, <span class="keyword">const</span> GSchar *pszField, GSchar * pszCaption);
|
||||
00149 GSbool <a class="code" href="group__group6__2.html#a3">LadderQuery_StartResultEntryEnumeration</a>(GSuint uiRequestID, GSuint uiStartEntry);
|
||||
00150 GSbool <a class="code" href="group__group6__2.html#a4">LadderQuery_NextResultEntry</a>(GSuint uiRequestID);
|
||||
00151 GSbool <a class="code" href="group__group6__2.html#a5">LadderQuery_GetCurrentEntryField</a>(GSuint uiRequestID, <span class="keyword">const</span> GSchar *pszField, GSint & iValue);
|
||||
00152 GSbool <a class="code" href="group__group6__2.html#a6">LadderQuery_GetCurrentEntryFieldAsString</a>(GSuint uiRequestID, <span class="keyword">const</span> GSchar *pszField, GSchar * pszValue);
|
||||
00153 GSvoid <a class="code" href="group__group6__2.html#a7">LadderQuery_ReleaseResult</a>(GSuint uiRequestID);
|
||||
00154
|
||||
00155 GSRESULT <a class="code" href="group__group7__1.html#a0">RemoteAlgorithm_Initialise</a>(<span class="keyword">const</span> GSchar * szGameName);
|
||||
00156 GSRESULT <a class="code" href="group__group7__1.html#a1">RemoteAlgorithm_Uninitialise</a>();
|
||||
00157 GSRESULT <a class="code" href="group__group7__1.html#a2">RemoteAlgorithm_Engine</a>(GSuint uiMaxPostingDelay = 500,
|
||||
00158 GSuint uiMaxsOperationalDelay = 800);
|
||||
00159 GSRESULT <a class="code" href="group__group7__1.html#a3">RemoteAlgorithm_Execute</a>(GSuint uiAlgoId,
|
||||
00160 <a class="code" href="structRAE__VALUE.html">RAE_VALUE</a> * pInput, GSuint uiNumInput,
|
||||
00161 <a class="code" href="group__group__RAECB.html#a0">RemoteAlgorithm_OutputCB</a> fOutput,
|
||||
00162 GSvoid * pData, GSuint & uiRequest);
|
||||
00163
|
||||
00164 <span class="keyword">private</span>:
|
||||
00165 CGLClientLIB *m_pClientLIB;
|
||||
00166
|
||||
00167 };
|
||||
00168
|
||||
00169 <span class="preprocessor">#endif //_GSCLIENCLASS_H_</span>
|
||||
</pre></div><hr>
|
||||
<p align="right">
|
||||
<i>Ubi.com GameService SDK - ©UbiSoft Entertainment 2002 </i><br>
|
||||
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user