com.ibasco.agql.protocols.valve.source.query.info

Class SourceServer

java.lang.Object

com.ibasco.agql.protocols.valve.source.query.info.SourceServer

public class SourceServer
extends Object

SourceServer class.

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

Constructor and Description
SourceServer()

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	getAddress() The address of the connection to the server
int	getAppId() The App ID of the game
String	getGameDescription() Full name of the game
String	getGameDirectory() The name of the folder containing the game files
long	getGameId() The server's 64-bit game id
int	getGamePort() The game port of the server
String	getGameVersion() The version of the game installed on the server
String	getHostAddress() The IP address of the server.
String	getMapName() The name of the map currently loaded by the server
int	getMaxPlayers() The maximum number of players supported by the server
String	getName() The name of the server
byte	getNetworkVersion() Protocol version used by the server
int	getNumOfBots() The number of bots on the server
int	getNumOfPlayers() The number of players on the server
String	getOperatingSystem() The operating system of the server (l = linux, w = windows, m = mac)
int	getPort() The query port of the server.
long	getServerId() The server's 64-bit steam id
String	getServerTags() Tags that describe the game according to the server
String	getTvName() Source TV name
int	getTvPort() Source TV Port
boolean	isDedicated() Specified whether the server is dedicated or not
boolean	isPasswordProtected() Deprecated. Use isPrivateServer()
boolean	isPrivateServer() Specifies if the server is a private server and password protected
boolean	isSecure() Specifies whether the server uses VAC
boolean	isSourceTvProxy() Specifies whether the server is a Source TV proxy/relay
void	setAddress(InetSocketAddress address) Setter for the field address.
void	setAppId(int appId) Setter for the field appId.
void	setDedicated(boolean dedicated) Setter for the field dedicated.
void	setGameDescription(String gameDescription) Setter for the field gameDescription.
void	setGameDirectory(String gameDirectory) Setter for the field gameDirectory.
void	setGameId(long gameId) Setter for the field gameId.
void	setGamePort(int gamePort)
void	setGameVersion(String gameVersion) Setter for the field gameVersion.
void	setMapName(String mapName) Setter for the field mapName.
void	setMaxPlayers(int maxPlayers) Setter for the field maxPlayers.
void	setName(String name) Setter for the field name.
void	setNetworkVersion(byte networkVersion) Setter for the field networkVersion.
void	setNumOfBots(int numOfBots) Setter for the field numOfBots.
void	setNumOfPlayers(int numOfPlayers) Setter for the field numOfPlayers.
void	setOperatingSystem(String operatingSystem) Setter for the field operatingSystem.
void	setPasswordProtected(boolean passwordProtected) Deprecated. Use setPrivateServer(boolean)
void	setPrivateServer(boolean privateServer) Setter for the field privateServer.
void	setSecure(boolean secure) Setter for the field secure.
void	setServerId(long serverId) Setter for the field serverId.
void	setServerTags(String serverTags) Setter for the field serverTags.
void	setSourceTvProxy(boolean sourceTvProxy)
void	setTvName(String tvName) Setter for the field tvName.
void	setTvPort(int tvPort) The Source TV port

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceServer

public SourceServer()

Method Detail

isPrivateServer

public boolean isPrivateServer()

Specifies if the server is a private server and password protected

Returns:

true if the server is a private server and requires a password. otherwise false if the server is public.

setPrivateServer

public void setPrivateServer(boolean privateServer)

Setter for the field privateServer.

Parameters:

privateServer - a boolean

getNetworkVersion

public byte getNetworkVersion()

Protocol version used by the server

Returns:

A byte representing the protocol version of the server.

setNetworkVersion

public void setNetworkVersion(byte networkVersion)

Setter for the field networkVersion.

Parameters:

networkVersion - a byte

getMapName

public String getMapName()

The name of the map currently loaded by the server

Returns:

The map name string

setMapName

public void setMapName(String mapName)

Setter for the field mapName.

Parameters:

mapName - a String object

getGameDirectory

public String getGameDirectory()

The name of the folder containing the game files

Returns:

a String object

setGameDirectory

public void setGameDirectory(String gameDirectory)

Setter for the field gameDirectory.

Parameters:

gameDirectory - a String object

getGameDescription

public String getGameDescription()

Full name of the game

Returns:

A String representing the full name of the game

setGameDescription

public void setGameDescription(String gameDescription)

Setter for the field gameDescription.

Parameters:

gameDescription - a String object

getAppId

public int getAppId()

The App ID of the game

Returns:

An integer representing the app id of the game

setAppId

public void setAppId(int appId)

Setter for the field appId.

Parameters:

appId - a int

getNumOfPlayers

public int getNumOfPlayers()

The number of players on the server

Returns:

The number of players currently on the server

setNumOfPlayers

public void setNumOfPlayers(int numOfPlayers)

Setter for the field numOfPlayers.

Parameters:

numOfPlayers - a int

getMaxPlayers

public int getMaxPlayers()

The maximum number of players supported by the server

Returns:

The maximum number of players supported by the server

setMaxPlayers

public void setMaxPlayers(int maxPlayers)

Setter for the field maxPlayers.

Parameters:

maxPlayers - a int

getNumOfBots

public int getNumOfBots()

The number of bots on the server

Returns:

The number of bots on the server

setNumOfBots

public void setNumOfBots(int numOfBots)

Setter for the field numOfBots.

Parameters:

numOfBots - a int

isDedicated

public boolean isDedicated()

Specified whether the server is dedicated or not

Returns:

true if the server is dedicated, otherwise false if it is non-dedicated OR a source tv proxy

See Also:

isSourceTvProxy()

setDedicated

public void setDedicated(boolean dedicated)

Setter for the field dedicated.

Parameters:

dedicated - a boolean

getOperatingSystem

public String getOperatingSystem()

The operating system of the server (l = linux, w = windows, m = mac)

Returns:

The code representing the operating system of the server

setOperatingSystem

public void setOperatingSystem(String operatingSystem)

Setter for the field operatingSystem.

Parameters:

operatingSystem - a String object

isPasswordProtected

@Deprecated
 @ApiStatus.ScheduledForRemoval
public boolean isPasswordProtected()

Deprecated. Use isPrivateServer()

Specifies if the server is password

Returns:

a boolean

setPasswordProtected

@Deprecated
 @ApiStatus.ScheduledForRemoval
public void setPasswordProtected(boolean passwordProtected)

Deprecated. Use setPrivateServer(boolean)

Setter for the field passwordProtected.

Parameters:

passwordProtected - a boolean

isSecure

public boolean isSecure()

Specifies whether the server uses VAC

Returns:

true if the server has VAC enabled.

setSecure

public void setSecure(boolean secure)

Setter for the field secure.

Parameters:

secure - a boolean

getGameVersion

public String getGameVersion()

The version of the game installed on the server

Returns:

a String object

setGameVersion

public void setGameVersion(String gameVersion)

Setter for the field gameVersion.

Parameters:

gameVersion - a String object

getServerId

public long getServerId()

The server's 64-bit steam id

Returns:

The server's 64-bit steam id

setServerId

public void setServerId(long serverId)

Setter for the field serverId.

Parameters:

serverId - a long

getTvPort

public int getTvPort()

Source TV Port

Returns:

The Source TV port number

setTvPort

public void setTvPort(int tvPort)

The Source TV port

Parameters:

tvPort - The Source TV port number of the server

getTvName

public String getTvName()

Source TV name

Returns:

The Source TV name

setTvName

public void setTvName(String tvName)

Setter for the field tvName.

Parameters:

tvName - a String object

getServerTags

public String getServerTags()

Tags that describe the game according to the server

Returns:

A string of comma-delimited tags

setServerTags

public void setServerTags(String serverTags)

Setter for the field serverTags.

Parameters:

serverTags - a String object

getGameId

public long getGameId()

The server's 64-bit game id

Returns:

The server's 64-bit game id

setGameId

public void setGameId(long gameId)

Setter for the field gameId.

Parameters:

gameId - a long

getName

public String getName()

The name of the server

Returns:

a String object

setName

public void setName(String name)

Setter for the field name.

Parameters:

name - a String object

getAddress

public InetSocketAddress getAddress()

The address of the connection to the server

Returns:

An InetSocketAddress containing the host and query port of the server

setAddress

public void setAddress(InetSocketAddress address)

Setter for the field address.

Parameters:

address - a InetSocketAddress object

getHostAddress

public String getHostAddress()

The IP address of the server. This is similar to calling getAddress().getHostAddress()

Returns:

a String representing the host address of the server

getPort

public int getPort()

The query port of the server. This is similar to calling getAddress().getPort().

Note: For most servers, the query and game ports are usually the same. If this is not the case and you need to get the actual game port number of the server, use getGamePort()

Returns:

The query port number of the server.

See Also:

getGamePort()

getGamePort

public int getGamePort()

The game port of the server

Returns:

The game port number of the server.

setGamePort

public void setGamePort(int gamePort)

isSourceTvProxy

public boolean isSourceTvProxy()

Specifies whether the server is a Source TV proxy/relay

Returns:

true if the server is a Source TV proxy

setSourceTvProxy

public void setSourceTvProxy(boolean sourceTvProxy)