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

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

Methods

Modifier and Type	Method and Description
void	connect()
void	exit() Removes and closes all used resources to the TeamSpeak server.
TS3Api	getApi()
TS3ApiAsync	getAsyncApi()
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()

exit

public void exit()

Removes and closes all used resources to the TeamSpeak server.

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()

getAsyncApi

public TS3ApiAsync getAsyncApi()