com.github.theholywaffle.teamspeak3

Class TS3Config

java.lang.Object

com.github.theholywaffle.teamspeak3.TS3Config

public class TS3Config
extends Object

Constructor Summary

Constructors

Constructor and Description
TS3Config()

Method Summary

Methods

Modifier and Type	Method and Description
TS3Config	setCommandTimeout(int commandTimeout) Sets how many milliseconds a call in TS3Api should block at most until a command without response fails.
TS3Config	setConnectionHandler(ConnectionHandler connectionHandler)
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)
TS3Config	setHost(String host)
TS3Config	setQueryPort(int queryPort)
TS3Config	setReconnectStrategy(ReconnectStrategy reconnectStrategy)

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)

setQueryPort

public TS3Config setQueryPort(int queryPort)

setFloodRate

public TS3Config setFloodRate(TS3Query.FloodRate rate)

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 many milliseconds a call in TS3Api should block at most until a command without response fails. By default, this timeout is 4000 milliseconds.

Parameters:

commandTimeout - the maximum time to wait for a response until a synchronous command call fails

Returns:

this TS3Config object for chaining

Throws:

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

setReconnectStrategy

public TS3Config setReconnectStrategy(ReconnectStrategy reconnectStrategy)

setConnectionHandler

public TS3Config setConnectionHandler(ConnectionHandler connectionHandler)