Main Page | Modules | File List | File Members

MSClientLibrary.h

Go to the documentation of this file.
00001 
00002 //****************************************************************************
00003 //*   Author:  Scott Schmeisser  gsdevteam@ubisoft.com
00004 //*   Date:    4/19/02 1:44:25 PM
00011 //****************************************************************************
00012 
00013 #ifndef _MSCLIENTLIBRARY_H_
00014 #define _MSCLIENTLIBRARY_H_
00015 
00016 #include "GSTypes.h"
00017 
00039 //============================================================================
00040 // CallBack MSClient_GameServerCB
00041 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00042 // Date:                4/19/02 1:44:16 PM
00069 //============================================================================
00070 typedef GSvoid (__stdcall *MSClient_GameServerCB)(GSint iLobbyID,GSint iRoomID,
00071                 GSshort siGroupType,GSchar *szGroupName, GSint iConfig,
00072                 GSchar *szMaster,GSchar *szAllowedGames,GSchar *szGames,
00073                 GSchar *szGameVersion,GSchar *szGSVersion,GSvoid *vpInfo,GSint iSize,
00074                 GSuint uiMaxPlayer,GSuint uiNbrPlayer,GSuint uiMaxVisitor,
00075                 GSuint uiNbrVisitor,GSchar *szIPAddress,GSchar *szAltIPAddress,
00076                 GSint iEventID);
00077 
00078 //============================================================================
00079 // CallBack MSClient_AlternateInfoCB
00080 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00081 // Date:                8/19/02 1:44:16 PM
00093 //============================================================================
00094 typedef GSvoid (__stdcall *MSClient_AlternateInfoCB)(GSint iLobbyID,GSint iRoomID,
00095                 const GSvoid* pcAlternateInfo, GSint iAltInfoSize);
00096 
00097 //============================================================================
00098 // CallBack MSClient_ErrorCB
00099 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00100 // Date:                4/19/02 2:35:34 PM
00111 //============================================================================
00112 typedef GSvoid (__stdcall *MSClient_ErrorCB)(GSint iReason,GSint iLobbyID,
00113                 GSint iRoomID);
00114 
00115 //============================================================================
00116 // CallBack MSClient_InitFinishedCB
00117 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00118 // Date:                4/19/02 2:36:34 PM
00131 //============================================================================
00132 typedef GSvoid (__stdcall *MSClient_InitFinishedCB)(GSubyte ucType, GSint iError,
00133                 GSchar *szUserName);
00134 
00135 //============================================================================
00136 // CallBack MSClient_LoginDisconnectCB
00137 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00138 // Date:                8/9/02 5:29:53 PM
00149 //============================================================================
00150 typedef GSvoid (__stdcall *MSClient_LoginDisconnectCB)();
00151 
00152 
00153 //============================================================================
00154 // CallBack MSClient_LobbyDisconnectCB
00155 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00156 // Date:                8/9/02 5:33:26 PM
00168 //============================================================================
00169 typedef GSvoid (__stdcall *MSClient_LobbyDisconnectCB)();
00170 //============================================================================
00171 // CallBack MSClient_RequestFinishedCB
00172 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00173 // Date:                4/19/02 2:37:41 PM
00182 //============================================================================
00183 typedef GSvoid (__stdcall *MSClient_RequestFinishedCB)();
00184 
00185 //============================================================================
00186 // CallBack MSClient_JoinFinishedCB
00187 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00188 // Date:                4/19/02 2:41:32 PM
00202 //============================================================================
00203 typedef GSvoid (__stdcall *MSClient_JoinFinishedCB)(GSint iLobbyID,GSint iRoomID,
00204                 GSvoid *vpGameData,GSint iSize,GSchar *szIPAddress,GSchar *szAltIPAddress,
00205                 GSushort usPort);
00206 
00207 //============================================================================
00208 // CallBack MSClient_AccountCreationCB
00209 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00210 // Date:                5/30/02 11:03:32 AM
00219 //============================================================================
00220 typedef GSvoid (__stdcall *MSClient_AccountCreationCB)(GSubyte ucType,
00221                 GSint iReason);
00222 
00223 //============================================================================
00224 // CallBack MSClient_ModifyAccountCB
00225 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00226 // Date:                5/30/02 11:03:32 AM
00235 //============================================================================
00236 typedef GSvoid (__stdcall *MSClient_ModifyAccountCB)(GSubyte ucType,
00237                 GSint iReason);
00238 
00239 //============================================================================
00240 // CallBack MSClient_MatchStartedCB
00241 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00242 // Date:                7/25/02 10:39:51 AM
00253 //============================================================================
00254 typedef GSvoid (__stdcall *MSClient_MatchStartedCB)(GSint iLobbyID,GSint iRoomID,
00255                 GSuint uiMatchID);
00256 
00257 
00258 //============================================================================
00259 // CallBack MSClient_SubmitMatchCB
00260 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00261 // Date:                7/25/02 11:16:34 AM
00272 //============================================================================
00273 typedef GSvoid (__stdcall *MSClient_SubmitMatchCB)(GSubyte ucType,
00274                 GSint iReason,GSuint iMatchID);
00275 
00276 
00277 //============================================================================
00278 // Callback MSClient_RequestMOTDCB
00279 
00298 //============================================================================
00299 typedef GSvoid (__stdcall *MSClient_RequestMOTDCB)(GSubyte ubType,
00300                 GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason);
00301 
00305 extern "C" {
00306 
00314 //============================================================================
00315 // Function MSClient_Initialize
00316 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00317 // Date:                4/19/02 2:48:31 PM
00334 //============================================================================
00335 GSbool __stdcall MSClient_Initialize(const GSchar *szMasterServerIP,
00336                 GSushort usMasterServerPort,const GSchar *szUserName,
00337                 const GSchar *szPassword, const GSchar *szVersion);
00338 
00339 
00340 //============================================================================
00341 // Function MSClient_Uninitialize
00342 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00343 // Date:                4/19/02 2:58:14 PM
00352 //============================================================================
00353 GSbool __stdcall MSClient_Uninitialize();
00354 
00355 
00356 //============================================================================
00357 // Function MSClient_Engine
00358 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00359 // Date:                4/19/02 2:59:11 PM
00373 //============================================================================
00374 GSbool __stdcall MSClient_Engine(GSuint uiMaxPostingDelay = 500,
00375                 GSuint uiMaxsOperationalDelay = 800);
00376 
00377 
00378 //============================================================================
00379 // Function MSClient_RequestMOTD
00398 //============================================================================
00399 GSbool __stdcall MSClient_RequestMOTD(const GSchar *szLanguage);
00400 
00401 //============================================================================
00402 // Function MSClient_RequestGameServers
00403 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00404 // Date:                4/19/02 3:00:24 PM
00418 //============================================================================
00419 GSbool __stdcall MSClient_RequestGameServers(const GSchar *szGameName);
00420 
00421 
00422 //============================================================================
00423 // Function MSClient_RefreshGameServers
00424 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00425 // Date:                6/12/02 5:25:28 PM
00438 //============================================================================
00439 GSbool __stdcall MSClient_RefreshGameServer(GSint iLobbyID,GSint iRoomID);
00440 
00441 //============================================================================
00442 // Function MSClient_RequestAlternateInfo
00443 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00444 // Date:                6/12/02 5:25:28 PM
00457 //============================================================================
00458 GSbool __stdcall MSClient_RequestAlternateInfo(GSint iLobbyID,GSint iRoomID);
00459 
00460 //============================================================================
00461 // Function MSClient_JoinGameServer
00462 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00463 // Date:                4/19/02 3:24:58 PM
00481 //============================================================================
00482 GSbool __stdcall MSClient_JoinGameServer(GSint iLobbyID,GSint iRoomID,
00483                 const GSchar *szPassword,const GSchar *szGSVersion,const GSchar *szGameName,
00484                 const GSvoid *pvPlayerInfo, GSint iPlayerInfoSize);
00485 
00486 //============================================================================
00487 // Function MSClient_LeaveGameServer
00488 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00489 // Date:                4/19/02 3:31:07 PM
00501 //============================================================================
00502 GSbool __stdcall MSClient_LeaveGameServer(GSint iLobbyID,GSint iRoomID);
00503 
00504 //============================================================================
00505 // Function MSClient_GameServerConnected
00506 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00507 // Date:                11/20/02 3:31:07 PM
00519 //============================================================================
00520 GSbool __stdcall MSClient_GameServerConnected(GSint iLobbyID,GSint iRoomID);
00521 
00522 
00523 //============================================================================
00524 // Function MSClient_CreateAccount
00525 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00526 // Date:                5/30/02 11:31:07 AM
00549 //============================================================================
00550 GSbool __stdcall MSClient_CreateAccount(const GSchar *szMasterServerIP,
00551                 GSushort usMasterServerPort,const GSchar* szVersion,
00552                 const GSchar* szNickName,const GSchar* szPassword,const GSchar* szFirstName,
00553                 const GSchar* szLastName,const GSchar* szEmail,const GSchar* szCountry);
00554 
00555 //============================================================================
00556 // Function MSClient_ModifyAccount
00557 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00558 // Date:                5/30/02 11:31:07 AM
00574 //============================================================================
00575 GSbool __stdcall MSClient_ModifyAccount(const GSchar* szPassword,
00576                 const GSchar* szFirstName,const GSchar* szLastName, const GSchar* szEmail,
00577                 const GSchar* szCountry);
00578 
00579 
00580 //============================================================================
00581 // Function MSClient_MatchStarted
00582 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00583 // Date:                7/25/02 2:00:49 PM
00598 //============================================================================
00599 GSbool __stdcall MSClient_MatchStarted(GSint iLobbyID,GSint iRoomID);           
00600                 
00601 //============================================================================
00602 // Function MSClient_InitMatchResult
00603 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00604 // Date:                7/25/02 1:54:52 PM
00620 //============================================================================
00621 GSbool __stdcall MSClient_InitMatchResult(GSuint uiMatchID);
00622 
00623 
00624 //============================================================================
00625 // Function MSClient_SetMatchResult
00626 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00627 // Date:                7/25/02 1:56:18 PM
00643 //============================================================================
00644 GSbool __stdcall MSClient_SetMatchResult(GSchar* szAlias,
00645                 GSuint uiFieldID,GSint iFieldValue);
00646 
00647 
00648 //============================================================================
00649 // Function MSClient_SubmitMatchResult
00650 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00651 // Date:                7/25/02 1:56:56 PM
00666 //============================================================================
00667 GSbool __stdcall MSClient_SubmitMatchResult(GSint iLobbyID,GSint iRoomID);
00668 
00669 
00670 //============================================================================
00671 // Function MSClient_UninitMatchResult
00672 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00673 // Date:                7/25/02 1:58:22 PM
00683 //============================================================================
00684 GSbool __stdcall MSClient_UninitMatchResult();
00685 
00686 
00687 //============================================================================
00688 // Function MSClient_MatchFinished
00689 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00690 // Date:                7/25/02 2:00:49 PM
00704 //============================================================================
00705 GSbool __stdcall MSClient_MatchFinished(GSint iLobbyID,GSint iRoomID);
00706 
00716 //============================================================================
00717 // Function MSClient_FixRequestMOTD
00733 //============================================================================
00734 GSbool __stdcall MSClient_FixRequestMOTD(MSClient_RequestMOTDCB fFunction);
00735 
00736 //============================================================================
00737 // Function MSClient_FixGameServerCB
00738 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00739 // Date:                4/19/02 3:32:14 PM
00751 //============================================================================
00752 GSbool __stdcall MSClient_FixGameServerCB(MSClient_GameServerCB fFunction);
00753 
00754 //============================================================================
00755 // Function MSClient_FixAlternateInfoCB
00756 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00757 // Date:                4/19/02 3:32:14 PM
00769 //============================================================================
00770 GSbool __stdcall MSClient_FixAlternateInfoCB(MSClient_AlternateInfoCB fFunction);
00771 
00772 //============================================================================
00773 // Function MSClient_FixErrorCB
00774 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00775 // Date:                4/19/02 3:33:20 PM
00786 //============================================================================
00787 GSbool __stdcall MSClient_FixErrorCB(MSClient_ErrorCB fFunction);
00788 
00789 
00790 //============================================================================
00791 // Function MSClient_FixInitFinishedCB
00792 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00793 // Date:                4/19/02 3:37:05 PM
00804 //============================================================================
00805 GSbool __stdcall MSClient_FixInitFinishedCB(MSClient_InitFinishedCB fFunction);
00806 
00807 //============================================================================
00808 // Function MSClient_FixLoginDisconnectCB
00809 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00810 // Date:                8/19/02 3:37:05 PM
00822 //============================================================================
00823 GSbool __stdcall MSClient_FixLoginDisconnectCB(
00824                 MSClient_LoginDisconnectCB fFunction);
00825 
00826 //============================================================================
00827 // Function MSClient_FixLoginDisconnectCB
00828 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00829 // Date:                8/19/02 3:37:05 PM
00841 //============================================================================
00842 GSbool __stdcall MSClient_FixLobbyDisconnectCB(
00843                 MSClient_LobbyDisconnectCB fFunction);
00844 
00845 //============================================================================
00846 // Function MSClient_FixRequestFinishedCB
00847 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00848 // Date:                4/19/02 3:40:32 PM
00860 //============================================================================
00861 GSbool __stdcall MSClient_FixRequestFinishedCB(
00862                 MSClient_RequestFinishedCB fFunction);
00863 
00864 
00865 //============================================================================
00866 // Function MSClient_FixJoinFinishedCB
00867 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00868 // Date:                4/19/02 3:42:19 PM
00879 //============================================================================
00880 GSbool __stdcall MSClient_FixJoinFinishedCB(MSClient_JoinFinishedCB fFunction);
00881 
00882 //============================================================================
00883 // Function MSClient_AccountCreationCB
00884 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00885 // Date:                5/30/03 11:15:19 AM
00896 //============================================================================
00897 GSbool __stdcall MSClient_FixAccountCreationCB(MSClient_AccountCreationCB fFunction);
00898 
00899 //============================================================================
00900 // Function MSClient_ModifyAccountCB
00901 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00902 // Date:                5/30/03 11:15:19 AM
00914 //============================================================================
00915 GSbool __stdcall MSClient_FixModifyAccountCB(MSClient_ModifyAccountCB fFunction);
00916 
00917 //============================================================================
00918 // Function MSClient_FixMatchStartedCB
00919 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00920 // Date:                7/25/02 2:02:01 PM
00931 //============================================================================
00932 GSbool __stdcall MSClient_FixMatchStartedCB(MSClient_MatchStartedCB fFunction);
00933 
00934 
00935 //============================================================================
00936 // Function MSClient_FixSubmitMatchCB
00937 // Author:              Scott Schmeisser  gsdevteam@ubisoft.com
00938 // Date:                7/25/02 2:03:13 PM
00950 //============================================================================
00951 GSbool __stdcall MSClient_FixSubmitMatchCB(MSClient_SubmitMatchCB fFunction);
00952 
00956 }
00957 #endif _MSCLIENTLIBRARY_H_

Ubi.com GameService SDK - ©UbiSoft Entertainment 2002
GameService development team