Server Browsing SDK Functions
SBServerDirectConnect | Indicates whether the server supports direct UDP connections. |
SBServerEnumKeys | Enumerates the keys/values for a given server by calling KeyEnumFn with each key/value. The user-defined instance data will be passed to the KeyFn callback. |
SBServerGetBoolValue | Returns the value associated with the specified key. This value is returned as the appropriate type: SBBool, float, int or string. |
SBServerGetConnectionInfo | Checks if Nat Negotiation is required, based off whether it is a LAN game, a public IP is present and several other factors. Fills a supplied pointer with an IP string to use for Nat Negotiation, or a direct connection if possible. |
SBServerGetFloatValue | Returns the value associated with the specified key. This value is returned as the appropriate type: SBBool, float, int or string. |
SBServerGetIntValue | Returns the value associated with the specified key. This value is returned as the appropriate type: SBBool, float, int or string. |
SBServerGetPing | Returns the stored ping time for the specified server. |
SBServerGetPlayerFloatValue | Returns the value associated with the specified player's key. This value is returned as the appropriate type. Float, int or string. |
SBServerGetPlayerIntValue | Returns the value associated with the specified player's key. This value is returned as the appropriate type. Float, int or string. |
SBServerGetPlayerStringValue | Returns the value associated with the specified player's key. This value is returned as the appropriate type. Float, int or string. |
SBServerGetPrivateAddress | Returns the internal address of the SBServer, if any. For users behind a NAT or firewall, this is the local DHCP or assigned IP address of the machine. |
SBServerGetPrivateInetAddress | Returns the internal address of the SBServer, if any. For users behind a NAT or firewall, this is the local DHCP or assigned IP address of the machine. |
SBServerGetPrivateQueryPort | Returns the private query port of the specified server. This is the internal port on which the server communicates to the GameSpy backend. |
SBServerGetPublicAddress | Returns the external address of the SBServer, if any. For users behind a NAT or firewall, this is the address of the outermost NAT or firewall layer. |
SBServerGetPublicInetAddress | Returns the external address of the SBServer, if any. For users behind a NAT or firewall, this is the address of the outermost NAT or firewall layer. |
SBServerGetPublicQueryPort | Returns the public query port of the specified server. This is the external port on which the GameSpy backend communicates with the server. |
SBServerGetStringValue | Returns the value associated with the specified key. This value is returned as the appropriate type. SBBool, float, int or string. |
SBServerGetTeamFloatValue | Returns the value associated with the specified teams’ key. This value is returned as the appropriate type; Float, int or string. |
SBServerGetTeamIntValue | Returns the value associated with the specified teams’ key. This value is returned as the appropriate type; Float, int or string. |
SBServerGetTeamStringValue | Returns the value associated with the specified teams’ key. This value is returned as the appropriate type; Float, int or string. |
SBServerHasBasicKeys | Determine if basic information is available for the specified server. |
SBServerHasFullKeys | Determine if full information is available for the specified server. |
SBServerHasPrivateAddress | Tests to see fi a private address is available for the server. |
SBServerHasValidPing | Determines if a server has a valid ping value (otherwise the ping will be 0). |
ServerBrowserAuxUpdateIP | Queries key/values from a single server. |
ServerBrowserAuxUpdateServer | Query key/values from a single server that has already been added to the internal list. |
ServerBrowserClear | Clear the current server list. |
ServerBrowserConnectToServer | Connects to a game server. |
ServerBrowserCount | Retrieves the current list of games from the GameSpy master server. |
ServerBrowserDisconnect | Disconnect from the GameSpy master server. |
ServerBrowserErrorDesc | Returns a human readable string for the specified SBError. |
ServerBrowserFree | Frees memory allocated by the ServerBrowser SDK. Terminates any pending queries. |
ServerBrowserGetMyPublicIP | Returns the local client's external (firewall) address. |
ServerBrowserGetMyPublicIPAddr | Returns the local client's external (firewall) address. |
ServerBrowserGetServer | Returns the SBServer object at the specified index. |
ServerBrowserGetServerByIP | Returns the SBServer with the specified IP |
ServerBrowserHalt | Stop an update in progress. |
ServerBrowserLANSetLocalAddr | Sets the network adapter to use for LAN broadcasts (optional) |
ServerBrowserLANUpdate | Retrieves the current list of games broadcasting on the local network. |
ServerBrowserLimitUpdate | Retrieves the current limited list of games from the GameSpy master server. Useful for low-memory systems. |
ServerBrowserListQueryError | Returns the ServerList error string, if any. |
ServerBrowserNew | Initialize the ServerBrowser SDK. |
ServerBrowserPendingQueryCount | Retrieves the number of servers with outstanding queries. Use this to check progress while asynchronously updating the server list. |
ServerBrowserRemoveIP | Removes a server from the local list. |
ServerBrowserRemoveServer | Removes a server from the local list. |
ServerBrowserSendMessageToServer | Sends a game specific message to the specified IP/port. This message is routed through the master server. |
ServerBrowserSendNatNegotiateCookieToServer | Sends a nat negotiation cookie to the server. The cookie is sent via the master server. |
ServerBrowserSort | Sort the current list of servers. |
ServerBrowserState | Gets current state of the Server Browser object. |
ServerBrowserThink | Allows ServerBrowsingSDK to continue internal processing including processing query replies. |
ServerBrowserUpdate | Retrieves the current list of games from the GameSpy master server. |