Main Page | Modules | File List | File Members

# RegServerLibrary.h File Reference

The main header for the RegServerLibrary. More...

Go to the source code of this file.

## Typedefs
typedef GSvoid(* | CBRegServerRcv_LoginRouterResult )(GSubyte ucType, GSint lReason, const GSchar *szIPAddress)
| The login result of the router.
typedef GSvoid(* | CBRegServerRcv_RouterDisconnection )()
| Called when you are disconnected from the router.
typedef GSvoid(* | CBRegServerRcv_RegisterServer )(GSubyte ucType, GSint lReason, GSint iGroupID, const GSchar *szAddress, GSushort usPort, const GSchar *szSessionName)
| Result of registering server.
typedef GSvoid(* | CBRegServerRcv_RequestParentGroup )(GSubyte ucType, GSint lReason, GSint iLobbyServerID, GSint iGroupID, const GSchar *szGroupName, GSuint uiNbPlayers, GSuint uiMaxPlayers)
| Gives the List of the Lobbies.
typedef GSvoid(* | CBRegServerRcv_LobbyServerLogin )(GSubyte ucType, GSint iReason, GSint iLobbyServerID, GSint iGroupID)
| The result logging in to the lobby server.
typedef GSvoid(* | CBRegServerRcv_LobbyServerUpdateGroupSettings )(GSubyte ucType, GSint iReason, GSint iGroupID)
| The result of updating group settings.
typedef GSvoid(* | CBRegServerRcv_LobbyServerDisconnection )()
| The game server has disconnected from the Lobby Server.
typedef GSvoid(* | CBRegServerRcv_LobbyServerMemberNew )(const GSchar *szMember, GSbool bSpectator, const GSchar *szIPAddress, const GSchar *szAltIPAddress, const GSvoid *pPlayerInfo, GSuint uiPlayerInfoSize, GSushort usPlayerStatus)
| A new member has joined the room.
typedef GSvoid(* | CBRegServerRcv_LobbyServerMemberLeft )(const GSchar *szMember)
| A member left the room.
typedef GSvoid(* | CBRegServerRcv_LobbyServerMatchStartReply )(GSubyte ucType, GSint iReason, GSint iGroupID)
| Result of starting a match.
typedef GSvoid(* | CBRegServerRcv_LobbyServerMatchFinishReply )(GSubyte ucType, GSint iReason, GSint iGroupID)
| Result of finishing a match.
typedef GSvoid(* | CBRegServerRcv_LobbyServerGroupConfigUpdate )(GSuint uiGroupConfig, GSint iGroupID)
| The Group Config has changed.
typedef GSvoid(* | CBRegServerRcv_LobbyServerMemberUpdateStatus )(const GSchar *szMember, GSushort usMemberStatus)
| A member status has been updated.
typedef GSvoid(* | CBRegServerRcv_LobbyServerNewUpdateGroup )(GSushort usRoomType, const GSchar *szRoomName, GSint iGroupID, GSint iLobbyServerID, GSint iParentGroupID, GSint uiGroupConfig, GSshort sGroupLevel, const GSchar *szMaster, const GSchar *szAllowedGames, const GSchar *szGame, const GSvoid *pGroupInfo, GSuint uiGroupInfoSize, GSuint uiMatchEventID, GSuint uiMaxPlayers, GSuint uiNbPlayers, GSuint uiMaxSpectators, GSuint uiNbSpectators, const GSchar *szGameVersion, const GSchar *szGSGameVersion, const GSchar *szIPAddress, const GSchar *szAltIPAddress)
| Settings of the room as it is on the lobby-server.
typedef GSvoid(* | CBRegServerRcv_LobbyServerMemberUpdateInfo )(const GSchar *szMember, const GSvoid *pPlayerInfo, GSuint uiPlayerInfoSize)
| Receive when a player's info changes.
## Functions
GSbool | RegServerLibrary_Initialize ()
| Initialize the libary.
GSbool | RegServerLibrary_Uninitialize ()
| Uninitialize the library.
GSvoid | RegServer_Engine ()
| Do the library work.
GSbool | RegServerSend_RouterConnect (const GSchar *szAddress, GSushort usPort)
| Connect to the router.
GSbool | RegServerSend_LoginRouter (const GSchar *szUsername, const GSchar *szPassword, const GSchar *szVersion)
| Send the login info to the router.
GSbool | RegServerSend_RouterDisconnect ()
| Disconnect the Router.
GSbool | RegServerSend_RequestParentGroupOnLobby (const GSchar *szGameName)
| Get the lobbies of the related game.
GSbool | RegServerSend_RegisterServerOnLobby (GSuint uiLobbyID, GSint iParentID, const GSchar *szRoomName, const GSchar *szGameName, GSushort uwRoomType, GSuint uiMaxPlayer, GSuint uiMaxSpectator, const GSchar *szPassword, const GSvoid *pstGroupInfo, GSint iGroupInfoSize, const GSvoid *pstAltGroupInfo, GSint iAltGroupInfoSize, const GSvoid *pstGameData, GSint iGameDataSize, GSushort usGamePort, const GSchar *szGameVersion, const GSchar *szGSVersion, GSbool bScoreSubmission, GSbool bDedicatedServer)
| Register a room on the lobby-server.
GSbool | RegServerSend_LobbyServerConnection (const GSchar *szAddress, GSushort usPort, GSushort usLocalPort=0, GSuint uiStillAliveDelay=25, GSuint uiDisconnectionDelay=120)
| Connect to the lobby-server.
GSbool | RegServerSend_LobbyServerClose ()
| Close the lobby-server connection.
GSbool | RegServerSend_LobbyServerLogin (const GSchar *szUsername, GSint iGroupID)
| Log on the lobby-server.
GSbool | RegServerSend_UpdateGroupSettings (GSint iGroupID, GSbyte bOpen, GSbyte bScoreSubmission, GSbyte bDedicatedServer, GSint uiMaxPlayers, GSint uiMaxSpectator, const GSchar *szPassword, const GSvoid *pucGroupInfo, GSint iGroupInfoSize, const GSvoid *pucAltGroupInfo, GSint iAltGroupInfoSize, const GSvoid *pucGameData, GSint iGameDataSize, GSushort usGamePort)
| Modify group parameters.
GSbool | RegServerSend_LobbyServerMemberJoin (const GSchar *szUsername)
| Send to the lobby-server than a player join the game server.
GSbool | RegServerSend_LobbyServerMemberLeave (const GSchar *szUsername)
| Send to the lobby-server than a player left the game server.
GSbool | RegServerSend_MatchStart (GSuint uiMode=0)
| Send to the lobby-server than the Server wants to start a match.
GSbool | RegServerSend_MatchFinish ()
| Force The Lobby-Server to finish the match.
GSvoid | RegServerFix_LoginRouterResult (CBRegServerRcv_LoginRouterResult fLoginRouterResult)
| Fix the CBRegServerRcv_LoginRouterResult Callback.
GSvoid | RegServerFix_RouterDisconnection (CBRegServerRcv_RouterDisconnection fRouterDisconnection)
| Fix the CBRegServerRcv_RouterDisconnection Callback.
GSvoid | RegServerFix_RegisterServerResult (CBRegServerRcv_RegisterServer fRegisterServer)
| Fix the CBRegServerRcv_RegisterServer Callback.
GSvoid | RegServerFix_RequestParentGroupResult (CBRegServerRcv_RequestParentGroup fRequestParentGroup)
| Fix the CBRegServerRcv_RequestParentGroup Callback.
GSvoid | RegServerFix_LobbyServerLoginResult (CBRegServerRcv_LobbyServerLogin fLobbyServerLogging)
| Fix the CBRegServerRcv_LobbyServerLogin Callback.
GSvoid | RegServerFix_LobbyServerUpdateGroupSettingsResult (CBRegServerRcv_LobbyServerUpdateGroupSettings fLobbyServerUpdateGroupSettings)
| Fix the CBRegServerRcv_LobbyServerUpdateGroupSettings Callback.
GSvoid | RegServerFix_LobbyServerDisconnection (CBRegServerRcv_LobbyServerDisconnection fLobbyServerDisconnection)
| Fix CBRegServerRcv_LobbyServerDisconnection Callback.
GSvoid | RegServerFix_LobbyServerMemberNew (CBRegServerRcv_LobbyServerMemberNew fLobbyServerMemberNew)
| Fix the CBRegServerRcv_LobbyServerNewMember Clallback.
GSvoid | RegServerFix_LobbyServerMemberLeft (CBRegServerRcv_LobbyServerMemberLeft fLobbyServerMemberLeft)
| Fix the CBRegServerRcv_LobbyServerMemberLeft Clallback.
GSvoid | RegServerFix_LobbyServerMatchStartReply (CBRegServerRcv_LobbyServerMatchStartReply fLobbyServerMatchStartReply)
| Fix the CBRegServerRcv_LobbyServerMatchStartReply Clallback.
GSvoid | RegServerFix_LobbyServerMatchFinishReply (CBRegServerRcv_LobbyServerMatchFinishReply fLobbyServerMatchFinishReply)
| Fix the CBRegServerRcv_LobbyServerMatchFinishReply Clallback.
GSvoid | RegServerFix_LobbyServerGroupConfigUpdate (CBRegServerRcv_LobbyServerGroupConfigUpdate fLobbyServerGroupConfigUpdate)
| Fix the CBRegServerRcv_LobbyServerGroupConfigUpdate Clallback.
GSvoid | RegServerFix_LobbyServerMemberUpdateStatus (CBRegServerRcv_LobbyServerMemberUpdateStatus fLobbyServerMemberUpdateStatus)
| Fix the CBRegServerRcv_LobbyServerMemberUpdateStatus Clallback.
GSvoid | RegServerFix_LobbyServerNewUpdateGroup (CBRegServerRcv_LobbyServerNewUpdateGroup fLobbyServerNewUpdateGroup)
| Fix the CBRegServerRcv_LobbyServerNewUpdateGroup Clallback.
GSvoid | RegServerFix_LobbyServerMemberUpdateInfo (CBRegServerRcv_LobbyServerMemberUpdateInfo fLobbyServerMemberUpdateInfo)
| Fix the CBRegServerRcv_LobbyServerMemberUpdateInfo Clallback.

## Detailed Description

The main page for the Regiser Server library

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