Main Page | Modules | File List | File Members

# Callbacks

List of the Library's callbacks. More...

## 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.

## Detailed Description

## Typedef Documentation

typedef GSvoid( * CBRegServerRcv_LobbyServerDisconnection)()

| Description: Received when the connection between the game server and lobby-server has been droped.

typedef GSvoid( * CBRegServerRcv_LobbyServerGroupConfigUpdate)( GSuint uiGroupConfig, GSint iGroupID )

  | Description: This callback tells the game server that the group config was updated. Related Function: RegServerSend_MatchStart() RegServerSend_MatchFinish() Parameters:
  uiGroupConfig | The group config and status as defined in LobbyDefines.h
  iGroupID | The group ID.

typedef GSvoid( * CBRegServerRcv_LobbyServerLogin)( GSubyte ucType, GSint iReason, GSint iLobbyServerID, GSint iGroupID )

  | Description: The response from logging in to the lobby server Related Function: RegServerSend_LobbyServerLogin() Parameters:
  ucType | GSSUCCESS or GSFAIL
  iReason | Reason of the failure
  iLobbyServerID | The LobbyServerID
  iGroupID | The GroupID of the registred room

typedef GSvoid( * CBRegServerRcv_LobbyServerMatchFinishReply)( GSubyte ucType, GSint iReason, GSint iGroupID )

  | Description: The response from trying to finish a match. Related Function: RegServerSend_MatchFinish() Parameters:
  ucType | GSFAIL or GSSUCCESS.
  GSint | iReason The reason of the Failure.
  GSint | iGroupID The group ID.

typedef GSvoid( * CBRegServerRcv_LobbyServerMatchStartReply)( GSubyte ucType, GSint iReason, GSint iGroupID )

  | Description: The response from trying to start a match. Related Function: RegServerSend_MatchStart() Parameters:
  ucType | GSFAIL or GSSUCCESS.
  GSint | iReason The reason of the Failure.
  GSint | iGroupID The group ID.

typedef GSvoid( * CBRegServerRcv_LobbyServerMemberLeft)( const GSchar* szMember )

  | Description: A member left the room. Parameters:
  szMember | The name of the member.

typedef GSvoid( * CBRegServerRcv_LobbyServerMemberNew)( const GSchar* szMember, GSbool bSpectator, const GSchar* szIPAddress, const GSchar* szAltIPAddress, const GSvoid* pPlayerInfo, GSuint uiPlayerInfoSize, GSushort usPlayerStatus )

  | Description: A member joined the room registred by this game server. Parameters:
  szMember | The Name of the member ( array size NIKNAMELENTH )
  bSpectator | Tell if the member tried to join as spectator ( GS_TRUE ) or an player ( GS_FALSE )
  szIPAddress | The IP address of the member
  szAltIPAddress | The Alternate IP address of the member ( the local ip address behind the NAT )
  pPlayerInfo | Pointer on of the player info's buffer.
  uiPlayerInfoSize | The player info's buffer size.
  usPlayerStatus | The player ptatus as define in LobbyDefines.h.

typedef GSvoid( * CBRegServerRcv_LobbyServerMemberUpdateInfo)( const GSchar* szMember, const GSvoid* pPlayerInfo, GSuint uiPlayerInfoSize )

  | Description: Receive when a player's info changes. Parameters:
  szMember | The Name of the Member.
  pPlayerInfo | The player info buffer.
  GSuint | uiPlayerInfoSize The player info buffer size.

typedef GSvoid( * CBRegServerRcv_LobbyServerMemberUpdateStatus)( const GSchar* szMember, GSushort usMemberStatus )

  | Description: A member updated his status as defined in LobbyDefines.h. This information if useful to know if the member finished playing the match. Parameters:
  szMember | The Name of the member.
  usMemberStatus | The member status.

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 )

  | Description: Settings of the room as it is on the lobby-server. Received at the begining and when the group is updated. Parameters:
  usRoomType | The type of the room as define in LobbyDefines.h.
  szRoomName | The name of the room.
  iGroupID | The ID of the the group.
  iLobbyServerID | The ID of the lobby-server.
  iParentGroupID | The ID of the parent Lobby.
  uiGroupConfig | The group config or status as defined in LobbyDefines.h.
  sGroupLevel | The Level of the the registred group in the lobby-server group tree.
  szMaster | The master of the group. In the case of the regserver it correspond to the alias.
  szAllowedGames | The list of games allowed in the room ( useless on room worked only on lobbies )
  szGame | The game that represent that room.
  pGroupInfo | The group info buffer.
  uiGroupInfoSize | The size of the group info buffer.
  uiMatchEventID | The match event of the group.
  uiMaxPlayers | The maximum players allowed to join the room.
  uiNbPlayers | The number of player on the room.
  uiMaxSpectators | The maximum spectators allowed to join the room.
  uiNbSpectators | The number of spector on the room.
  szGameVersion | The game version.
  szGSGameVersion | The game version given by the Game Service team.
  szIPAddress | The ip address of the regserver detected by the router.
  szAltIPAddress | The alternate IP address of the regserver.

typedef GSvoid( * CBRegServerRcv_LobbyServerUpdateGroupSettings)(GSubyte ucType, GSint iReason, GSint iGroupID )

  | Description: The response from updating your group settings Related Function: RegServerSend_UpdateGroupSettings() Parameters:
  ucType | GSSUCCESS or GSFAIL
  iReason | Reason of the failure
  iGroupID | The group ID of the group you tried to update

typedef GSvoid( * CBRegServerRcv_LoginRouterResult)(GSubyte ucType, GSint lReason, const GSchar* szIPAddress)

  | Description: The result of logging in to the router. Related Function: RegServerSend_LoginRouter() Parameters:
  ucType | GSSUCCESS or GSFAIL
  lReason | The reason of the failure
  szIPAddress | The IP address of the router

typedef GSvoid( * CBRegServerRcv_RegisterServer)(GSubyte ucType, GSint lReason, GSint iGroupID, const GSchar* szAddress, GSushort usPort, const GSchar* szSessionName)

  | Description: The response from telling the router you want to register a server on a lobby Related Function: RegServerSend_RegisterServerOnLobby() Parameters:
  ucType | GSSUCCESS or GSFAIL
  lReason | Reason of the failure
  iGroupID | The group ID of the created room
  szAddress | The address of the lobbyserver
  usPort | The port of the lobby server
  szSessionName | The name of the created room

typedef GSvoid( * CBRegServerRcv_RequestParentGroup)(GSubyte ucType, GSint lReason, GSint iLobbyServerID, GSint iGroupID, const GSchar* szGroupName, GSuint uiNbPlayers, GSuint uiMaxPlayers )

  | Description: This Callback is called for each lobby sends by the router. You know than you received the last lobby when the variable iGroupID = 0. Related Function: RegServerSend_RequestParentGroupOnLobby() Parameters:
  ucType | GSSUCCESS or GSFAIL
  lReason | Reason of the failure
  iLobbyServerID | The lobby server ID
  iGroupID | The GroupID of the lobby ( aka Basic Group or Parent Group )
  szGroupName | The name of the Lobby
  uiNbPlayers | The number of the player of the Lobby
  uiMaxPlayers | The Number of Maximum players allowed in that lobby

typedef GSvoid( * CBRegServerRcv_RouterDisconnection)()

| Description: Called when you are disconnected from the router.

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