Main Page | Modules | File List | File Members

MSClientLibrary.h File Reference

The header file for the Master Server Client Library. More...

#include "GSTypes.h"

Go to the source code of this file.

Typedefs

typedef GSvoid(* MSClient_GameServerCB )(GSint iLobbyID, GSint iRoomID, GSshort siGroupType, GSchar *szGroupName, GSint iConfig, GSchar *szMaster, GSchar *szAllowedGames, GSchar *szGames, GSchar *szGameVersion, GSchar *szGSVersion, GSvoid *vpInfo, GSint iSize, GSuint uiMaxPlayer, GSuint uiNbrPlayer, GSuint uiMaxVisitor, GSuint uiNbrVisitor, GSchar *szIPAddress, GSchar *szAltIPAddress, GSint iEventID)
 Receivec information on a game server.

typedef GSvoid(* MSClient_AlternateInfoCB )(GSint iLobbyID, GSint iRoomID, const GSvoid *pcAlternateInfo, GSint iAltInfoSize)
 The Alternate Info of a Game Server.

typedef GSvoid(* MSClient_ErrorCB )(GSint iReason, GSint iLobbyID, GSint iRoomID)
 An error occured.

typedef GSvoid(* MSClient_InitFinishedCB )(GSubyte ucType, GSint iError, GSchar *szUserName)
 The initialization has finished.

typedef GSvoid(* MSClient_LoginDisconnectCB )()
 The library has disconnected from the Router.

typedef GSvoid(* MSClient_LobbyDisconnectCB )()
 The library has disconnected from the Lobby.

typedef GSvoid(* MSClient_RequestFinishedCB )()
 All the Game Servers have been downloaded.

typedef GSvoid(* MSClient_JoinFinishedCB )(GSint iLobbyID, GSint iRoomID, GSvoid *vpGameData, GSint iSize, GSchar *szIPAddress, GSchar *szAltIPAddress, GSushort usPort)
 Finished joining the game server.

typedef GSvoid(* MSClient_AccountCreationCB )(GSubyte ucType, GSint iReason)
 Account Creatation callback.

typedef GSvoid(* MSClient_ModifyAccountCB )(GSubyte ucType, GSint iReason)
 Account Creatation callback.

typedef GSvoid(* MSClient_MatchStartedCB )(GSint iLobbyID, GSint iRoomID, GSuint uiMatchID)
 The match has started.

typedef GSvoid(* MSClient_SubmitMatchCB )(GSubyte ucType, GSint iReason, GSuint iMatchID)
 The replay to MSClient_SubmitMatchResult.

typedef GSvoid(* MSClient_RequestMOTDCB )(GSubyte ubType, GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason)
 Receive the message of the day.


Functions

GSbool MSClient_Initialize (const GSchar *szMasterServerIP, GSushort usMasterServerPort, const GSchar *szUserName, const GSchar *szPassword, const GSchar *szVersion)
 Initialize the library.

GSbool MSClient_Uninitialize ()
 Uninitialize the library.

GSbool MSClient_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)
 Runs the Library.

GSbool MSClient_RequestMOTD (const GSchar *szLanguage)
 Request the message of the day.

GSbool MSClient_RequestGameServers (const GSchar *szGameName)
 Request a new list of game servers.

GSbool MSClient_RefreshGameServer (GSint iLobbyID, GSint iRoomID)
 Refresh certain Game Servers.

GSbool MSClient_RequestAlternateInfo (GSint iLobbyID, GSint iRoomID)
 Request the alternate info of a game server.

GSbool MSClient_JoinGameServer (GSint iLobbyID, GSint iRoomID, const GSchar *szPassword, const GSchar *szGSVersion, const GSchar *szGameName, const GSvoid *pvPlayerInfo, GSint iPlayerInfoSize)
 Tells the library to join a Game Server.

GSbool MSClient_LeaveGameServer (GSint iLobbyID, GSint iRoomID)
 Leaves the Game Server.

GSbool MSClient_GameServerConnected (GSint iLobbyID, GSint iRoomID)
 Leaves the Game Server.

GSbool MSClient_CreateAccount (const GSchar *szMasterServerIP, GSushort usMasterServerPort, const GSchar *szVersion, const GSchar *szNickName, const GSchar *szPassword, const GSchar *szFirstName, const GSchar *szLastName, const GSchar *szEmail, const GSchar *szCountry)
 Create an account.

GSbool MSClient_ModifyAccount (const GSchar *szPassword, const GSchar *szFirstName, const GSchar *szLastName, const GSchar *szEmail, const GSchar *szCountry)
 Create an account.

GSbool MSClient_MatchStarted (GSint iLobbyID, GSint iRoomID)
 Tell the lobby server that the player is starting a match.

GSbool MSClient_InitMatchResult (GSuint uiMatchID)
 Initialize the librairie score submission system.

GSbool MSClient_SetMatchResult (GSchar *szAlias, GSuint uiFieldID, GSint iFieldValue)
 Set results for a player in a match.

GSbool MSClient_SubmitMatchResult (GSint iLobbyID, GSint iRoomID)
 Send the compiled scores of a match to the lobby server.

GSbool MSClient_UninitMatchResult ()
 Unload the internal score submission system.

GSbool MSClient_MatchFinished (GSint iLobbyID, GSint iRoomID)
 Tell the lobby server that a match is finished.

GSbool MSClient_FixRequestMOTD (MSClient_RequestMOTDCB fFunction)
 Set the function name for the callback.

GSbool MSClient_FixGameServerCB (MSClient_GameServerCB fFunction)
 Fix the GameServer Callback.

GSbool MSClient_FixAlternateInfoCB (MSClient_AlternateInfoCB fFunction)
 Fix the AlternateInfo Callback.

GSbool MSClient_FixErrorCB (MSClient_ErrorCB fFunction)
 Fix the Error Callback.

GSbool MSClient_FixInitFinishedCB (MSClient_InitFinishedCB fFunction)
 Fix the InitFinished callback.

GSbool MSClient_FixLoginDisconnectCB (MSClient_LoginDisconnectCB fFunction)
 Fix the LoginDisconnect callback.

GSbool MSClient_FixLobbyDisconnectCB (MSClient_LobbyDisconnectCB fFunction)
 Fix the LobbyDisconnect callback.

GSbool MSClient_FixRequestFinishedCB (MSClient_RequestFinishedCB fFunction)
 Fix the RequestFinished callback.

GSbool MSClient_FixJoinFinishedCB (MSClient_JoinFinishedCB fFunction)
 Fix the JoinFinished callback.

GSbool MSClient_FixAccountCreationCB (MSClient_AccountCreationCB fFunction)
 Fix the AccountCreation callback.

GSbool MSClient_FixModifyAccountCB (MSClient_ModifyAccountCB fFunction)
 Fix the ModifyUser callback.

GSbool MSClient_FixMatchStartedCB (MSClient_MatchStartedCB fFunction)
 Fix the Match Started callback.

GSbool MSClient_FixSubmitMatchCB (MSClient_SubmitMatchCB fFunction)
 Fix the SubmitMatch callback.


Detailed Description

This interface provides game client functionality to retrieve a list of running game servers registered on Ubi.com (Master server list style).

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