com.github.theholywaffle.teamspeak3

Class TS3Config

java.lang.Object

com.github.theholywaffle.teamspeak3.TS3Config

public class TS3Config
extends Object

Class used to configure the behavior of a TS3Query.

Constructor Summary

Constructors

Constructor and Description
TS3Config()

Method Summary

Modifier and Type	Method and Description
TS3Config	setCommandTimeout(int commandTimeout) Sets how long the query should wait for any response to a command before disconnecting.
TS3Config	setConnectionHandler(ConnectionHandler connectionHandler) Sets the ConnectionHandler that defines the query's behaviour when connecting or disconnecting.
TS3Config	setEnableCommunicationsLogging(boolean enable) Setting this value to true will log the communication between the query client and the TS3 server at the DEBUG level.
TS3Config	setFloodRate(TS3Query.FloodRate rate) Sets the delay between sending commands.
TS3Config	setHost(String host) Sets the hostname or IP address of the TeamSpeak3 server to connect to.
TS3Config	setLoginCredentials(String username, String password) Authenticates the query with the TeamSpeak3 server using the given login credentials immediately after connecting.
TS3Config	setProtocol(TS3Query.Protocol protocol) Defines the protocol used to connect to the TeamSpeak3 server.
TS3Config	setQueryPort(int queryPort) Sets the query port to use when connecting to the TeamSpeak3 server.
TS3Config	setReconnectStrategy(ReconnectStrategy reconnectStrategy) Sets what strategy the query uses to reconnect after having been disconnected.

Methods inherited from class java.lang.Object

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

Constructor Detail

TS3Config

public TS3Config()

Method Detail

setHost

public TS3Config setHost(String host)

Sets the hostname or IP address of the TeamSpeak3 server to connect to.

Note that the query port is not part of the hostname - use setQueryPort(int) for that purpose.

If the application is running on the same machine as the TS3 server, you can use null as the hostname. You can also use any other loopback address, such as localhost or 127.0.0.1.

Parameters:

host - a valid hostname or IP address of a TeamSpeak3 server, or null

Returns:

this TS3Config object for chaining

setQueryPort

public TS3Config setQueryPort(int queryPort)

Sets the query port to use when connecting to the TeamSpeak3 server.

Note that the query uses a different port to connect to a server than the regular TeamSpeak3 clients. Regular clients use "voice ports", the query uses the "query port".

If you don't set the query port by calling this method, the query will use the default query port:

• 10011 when connecting using TS3Query.Protocol.RAW
• 10022 when connecting using TS3Query.Protocol.SSH

Parameters:

queryPort - the query port to use, must be between 1 and 65535

Returns:

this TS3Config object for chaining

Throws:

IllegalArgumentException - if the port is out of range

setProtocol

public TS3Config setProtocol(TS3Query.Protocol protocol)

Defines the protocol used to connect to the TeamSpeak3 server. By default, TS3Query.Protocol.RAW is used.

Parameters:

protocol - the connection protocol to use

Returns:

this TS3Config object for chaining

Throws:

IllegalArgumentException - if protocol is null

See Also:

Protocol

setLoginCredentials

public TS3Config setLoginCredentials(String username,
                                     String password)

Authenticates the query with the TeamSpeak3 server using the given login credentials immediately after connecting.

Setting the login credentials is mandatory when using the TS3Query.Protocol.SSH protocol.

A server query login can be generated by heading over to the TeamSpeak3 Client, Tools, ServerQuery Login. Note that the server query will have the same permissions as the client who generated the credentials.

Parameters:

username - the username used to authenticate the query

password - the password corresponding to username

Returns:

this TS3Config object for chaining

setFloodRate

public TS3Config setFloodRate(TS3Query.FloodRate rate)

Sets the delay between sending commands.

If the query's hostname / IP has not been added to the server's query_ip_whitelist.txt, you need to use TS3Query.FloodRate.DEFAULT to prevent the query from being flood-banned.

Calling TS3Query.FloodRate.custom(int) allows you to use a custom command delay if neither TS3Query.FloodRate.UNLIMITED nor TS3Query.FloodRate.DEFAULT fit your needs.

Parameters:

rate - a TS3Query.FloodRate object that defines the delay between commands

Returns:

this TS3Config object for chaining

Throws:

IllegalArgumentException - if rate is null

See Also:

FloodRate

setEnableCommunicationsLogging

public TS3Config setEnableCommunicationsLogging(boolean enable)

Setting this value to true will log the communication between the query client and the TS3 server at the DEBUG level.

By default, this is turned off to prevent leaking IPs, tokens, passwords, etc. into the console and / or log files.

Parameters:

enable - whether to log query commands

Returns:

this TS3Config object for chaining

setCommandTimeout

public TS3Config setCommandTimeout(int commandTimeout)

Sets how long the query should wait for any response to a command before disconnecting.

If the query doesn't receive any data from the TeamSpeak server after having waited for at least commandTimeout milliseconds, the connection is considered to be interrupted, and the query will try to reconnect according to its reconnect strategy.

By default, this timeout is 4000 milliseconds.

Parameters:

commandTimeout - the minimum amount of time to wait for any response, in milliseconds

Returns:

this TS3Config object for chaining

Throws:

IllegalArgumentException - if the timeout value is less than or equal to 0

setReconnectStrategy

public TS3Config setReconnectStrategy(ReconnectStrategy reconnectStrategy)

Sets what strategy the query uses to reconnect after having been disconnected.

The different reconnect strategies let you control whether and after which delay the query will try to reconnect. By default, ReconnectStrategy.disconnect() is used, which doesn't try to reconnect and simply stops the query.

Note that when using a reconnect strategy, you probably also want to set the ConnectionHandler using setConnectionHandler(ConnectionHandler).

Parameters:

reconnectStrategy - the reconnect strategy used when the query loses connection

Returns:

this TS3Config object for chaining

See Also:

The reconnect strategies, The connection handler

setConnectionHandler

public TS3Config setConnectionHandler(ConnectionHandler connectionHandler)

Sets the ConnectionHandler that defines the query's behaviour when connecting or disconnecting.

The following sample code illustrates how a reconnect strategy and connection handler can be used to print a message to the console every time the query connects or disconnects:

 config.setReconnectStrategy(ReconnectStrategy.exponentialBackoff());
 config.setConnectionHandler(new ConnectionHandler() {
        @Override
        public void onConnect(TS3Api api) {
                System.out.println("Successfully connected!");
        }

        @Override
        public void onDisconnect(TS3Query query) {
                System.out.println("The query was disconnected!");
        }
 });
 

Parameters:

connectionHandler - the ConnectionHandler object

Returns:

this TS3Config object for chaining

See Also:

setReconnectStrategy(ReconnectStrategy)