com.github.theholywaffle.teamspeak3

Class TS3Query

java.lang.Object

com.github.theholywaffle.teamspeak3.TS3Query

public class TS3Query
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TS3Query.FloodRate Artificial delay between sending commands, measured in milliseconds.
static class	TS3Query.Protocol The protocol used to communicate with the TeamSpeak3 server.

Constructor Summary

Constructors

Constructor and Description
TS3Query() Creates a TS3Query that connects to a TS3 server at localhost:10011 using default settings.
TS3Query(TS3Config config) Creates a customized TS3Query that connects to a server specified by config.

Method Summary

Modifier and Type	Method and Description
void	connect() Tries to establish a connection to the TeamSpeak3 server.
void	exit() Disconnects the query and closes all open resources.
TS3Api	getApi() Gets the API object that can be used to send commands to the TS3 server.
TS3ApiAsync	getAsyncApi() Gets the asynchronous API object that can be used to send commands to the TS3 server in a non-blocking manner.
boolean	isConnected() Returns true if the query is likely connected, false if the query is disconnected or currently trying to reconnect.

Methods inherited from class java.lang.Object

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

Constructor Detail

TS3Query

public TS3Query()

Creates a TS3Query that connects to a TS3 server at localhost:10011 using default settings.

TS3Query

public TS3Query(TS3Config config)

Creates a customized TS3Query that connects to a server specified by config.

Parameters:

config - configuration for this TS3Query

Method Detail

connect

public void connect()

Tries to establish a connection to the TeamSpeak3 server.

Throws:

IllegalStateException - if this method was called from ConnectionHandler.onConnect(com.github.theholywaffle.teamspeak3.TS3Api)

TS3ConnectionFailedException - if the query can't connect to the server or the ConnectionHandler throws an exception

exit

public void exit()

Disconnects the query and closes all open resources.

If the command queue still contains commands when this method is called, the query will first process these commands, causing this method to block. However, the query will reject any new commands as soon as this method is called.

Throws:

IllegalStateException - if this method was called from ConnectionHandler.onConnect(com.github.theholywaffle.teamspeak3.TS3Api)

isConnected

public boolean isConnected()

Returns true if the query is likely connected, false if the query is disconnected or currently trying to reconnect.

Note that the only way to really determine whether the query is connected or not is to send a command and check whether it succeeds. Thus this method could return true almost a minute after the connection has been lost, when the last keep-alive command was sent.

Please do not use this method to write your own connection handler. Instead, use the built-in classes in the api.reconnect package.

Returns:

whether the query is connected or not

See Also:

TS3Config.setReconnectStrategy(ReconnectStrategy), TS3Config.setConnectionHandler(ConnectionHandler)

getApi

public TS3Api getApi()

Gets the API object that can be used to send commands to the TS3 server.

Returns:

a TS3Api object

getAsyncApi

public TS3ApiAsync getAsyncApi()

Gets the asynchronous API object that can be used to send commands to the TS3 server in a non-blocking manner.

Please only use the asynchronous API if it is really necessary and if you understand the implications of having multiple threads interact with your program.

Returns:

a TS3ApiAsync object