com.github.theholywaffle.teamspeak3

Class TS3Query.FloodRate

java.lang.Object

com.github.theholywaffle.teamspeak3.TS3Query.FloodRate

Enclosing class:

TS3Query

public static class TS3Query.FloodRate
extends Object

Artificial delay between sending commands, measured in milliseconds.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static TS3Query.FloodRate	DEFAULT Default delay of 350 milliseconds between commands for queries that are not whitelisted.
static TS3Query.FloodRate	UNLIMITED No delay between commands.

Method Summary

Modifier and Type	Method and Description
static TS3Query.FloodRate	custom(int milliseconds) Creates a FloodRate object that represents a custom command delay.
int	getMs()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final TS3Query.FloodRate DEFAULT

Default delay of 350 milliseconds between commands for queries that are not whitelisted.

UNLIMITED

public static final TS3Query.FloodRate UNLIMITED

No delay between commands. If a query uses this without being whitelisted, it will likely be flood-banned.

Method Detail

custom

public static TS3Query.FloodRate custom(int milliseconds)

Creates a FloodRate object that represents a custom command delay.

Parameters:

milliseconds - the delay between sending commands in milliseconds

Returns:

a new FloodRate object representing a custom delay

getMs

public int getMs()