BiosLobbyService Class Reference

Private Member Functions
proto native EBiosError	GetServers (GetServersInput inputValues)
	Query game servers.
proto native EBiosError	GetFirstServerWithEmptySlot (GetFirstServerWithEmptySlotInput inputValues)
	First 1st free server.
proto native void	AddServerFavorite (string ipAddress, int port, int steamQueryPort)
proto native void	RemoveServerFavorite (string ipAddress, int port, int steamQueryPort)
proto native void	GetFavoriteServers (TStringArray favServers)
proto native void	GetCachedFavoriteServerInfo (array< ref CachedServerInfo > favServersInfoCache)
	Get cached info about favorited servers (ONLY ON WINDOWS)
proto native EBiosError	GetServerModList (string serverId)
void	OnDoneAsync (GetServersResult result_list, EBiosError error, string response)
	Async callback for GetServers.
void	OnGetFirstServerWithEmptySlot (GetFirstServerWithEmptySlotResult result_list, EBiosError error)
void	OnServerModList (GetServerModListResult result_list, EBiosError error)
	Async callback for GetServerModList.

Member Function Documentation

AddServerFavorite()

proto native void AddServerFavorite ( string  ipAddress, int  port, int  steamQueryPort  )

private

Referenced by OnlineServices::SetServerFavorited().

GetCachedFavoriteServerInfo()

proto native void GetCachedFavoriteServerInfo ( array< ref CachedServerInfo >  favServersInfoCache )

private

Get cached info about favorited servers (ONLY ON WINDOWS)

Parameters

favServersInfoCache

gets populated with data with format: key = Query End Point, value.param1 = Server Name, value.param2 = Connection Port

Referenced by OnlineServices::GetCachedFavServerInfo().

GetFavoriteServers()

proto native void GetFavoriteServers ( TStringArray  favServers )

private

Referenced by OnlineServices::GetFavoriteServers().

GetFirstServerWithEmptySlot()

proto native EBiosError GetFirstServerWithEmptySlot ( GetFirstServerWithEmptySlotInput  inputValues )

private

First 1st free server.

The async result is returned in the OnGetFirstServerWithEmptySlot callback.

Referenced by OnlineServices::AutoConnectToEmptyServer(), and OnlineServices::OnAutoConnectToEmptyServer().

GetServerModList()

proto native EBiosError GetServerModList ( string  serverId )

private

Async function to retrieve info about mods for specific server (only for PC)

Parameters

serverId

have to be an id returned by callbacks issued by last call to GetServers if GetServers is used another time the id's must be upated

Referenced by OnlineServices::GetServerModList().

GetServers()

proto native EBiosError GetServers ( GetServersInput  inputValues )

private

Query game servers.

The async result is returned in the OnDoneAsync callback. Expected errors: BAD_PARAMETER - if atleast one of the permissions is not supported on the current platform, or atleast one of the input arrays is NULL.

Parameters

inputValues

input structure

Referenced by OnlineServices::GetCurrentServerInfo(), and OnlineServices::LoadServers().

OnDoneAsync()

void OnDoneAsync ( GetServersResult  result_list, EBiosError  error, string  response  )

inlineprivate

Async callback for GetServers.

Parameters

result_list	result object
error	error indicating success or fail of the async operation.
response	for debugging - this is the data returned by the server; or an empty string ;)

References OnlineServices::OnLoadServersAsync().

OnGetFirstServerWithEmptySlot()

void OnGetFirstServerWithEmptySlot ( GetFirstServerWithEmptySlotResult  result_list, EBiosError  error  )

inlineprivate

References OnlineServices::OnAutoConnectToEmptyServer().

OnServerModList()

void OnServerModList ( GetServerModListResult  result_list, EBiosError  error  )

inlineprivate

Async callback for GetServerModList.

References OnlineServices::OnGetServerModList().

RemoveServerFavorite()

proto native void RemoveServerFavorite ( string  ipAddress, int  port, int  steamQueryPort  )

private

Referenced by OnlineServices::SetServerFavorited().

---

The documentation for this class was generated from the following file:

• P:/scripts/3_Game/Services/BiosLobbyService.c