com.ibasco.agql.protocols.valve.source.query.rcon

Class SourceRconOptions

java.lang.Object

com.ibasco.agql.core.util.AbstractOptions

com.ibasco.agql.protocols.valve.source.query.rcon.SourceRconOptions

All Implemented Interfaces:

Options, Cloneable, Iterable<Map.Entry<Option<?>,Object>>

@Inherit(options={FailsafeOptions.class,ConnectOptions.class})
public final class SourceRconOptions
extends AbstractOptions

Configuration options container for the Source RCON module.

Author:

Rafael Luis Ibasco

See Also:

OptionBuilder, Options, SourceRconClient

Field Summary

Fields

Modifier and Type	Field and Description
static Option<Integer>	CLOSE_INACTIVE_CHANNELS Automatically close inactive channels/connections once it has reached the threshold value (value is in seconds).
static Option<CredentialsStore>	CREDENTIALS_STORE The CredentialsStore to be used by the rcon authentication module.
static Option<Integer>	INACTIVE_CHECK_INTERVAL Number of seconds to check for inactive Channel's/connections (Unit: Seconds, Default Value: 1 sec)
static Option<Boolean>	REAUTHENTICATE Automatically send a re-authentication request if the connection is no longer valid.
static Option<Boolean>	STRICT_MODE Enable strict mode.
static Option<Boolean>	USE_TERMINATOR_PACKET Enable the use of "terminating packets" (Enabled by default).

Constructor Summary

Constructors

Constructor and Description
SourceRconOptions()

Method Summary

Modifier and Type	Method and Description
static OptionBuilder<SourceRconOptions>	builder() Create a new OptionBuilder for SourceRconOptions

Methods inherited from class com.ibasco.agql.core.util.AbstractOptions

contains, get, get, get, getOrDefault, isLocked, iterator, put, put, putIfAbsent, remove, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibasco.agql.core.util.Options

get, getOrDefault, getOrDefault, isEmpty

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

USE_TERMINATOR_PACKET

public static final Option<Boolean> USE_TERMINATOR_PACKET

Enable the use of "terminating packets" (Enabled by default).

Simply put, a terminator packet allows the library to accurately determine the end of a response ensuring the integrity of the data received from the game server. If disabled, a special heuristics will be performed to determine the end of response but this is not always accurate in some cases and its possible that you won't be receiving the entire response from the server (especially when dealing with large response packets).

Detailed description

If enabled, an empty rcon response packet is sent after every command. The game server will then mirror it back at the end of the response, followed by an additional terminator packet with a terminating byte equals to 1 (0x01). This is mostly useful for large response packets that are sent in smaller chunks by the server, which would then have to be re-assembled by the library back into a single SourceRconPacket instance.

Keep in mind that some games such as Minecraft do not support "terminator packets" as it does not echo back the response packets receives. So if the game server does not support this, then this configuration option should be disabled. A special heuristics will be used instead to determine the end of the response.

See Also:

Multi-Packet Responses, SourceRconPacket, SourceRconPacketAssembler

STRICT_MODE

public static final Option<Boolean> STRICT_MODE

Enable strict mode. When false the library will attempt to recover from malformed/corrupted packets. Please note that disabling this option does not always guarantee that the decode process would succeed.

REAUTHENTICATE

public static final Option<Boolean> REAUTHENTICATE

Automatically send a re-authentication request if the connection is no longer valid. This applies only to authenticated and registered addresses (registered via SourceRconClient.authenticate(InetSocketAddress, byte[])).

CREDENTIALS_STORE

public static final Option<CredentialsStore> CREDENTIALS_STORE

The CredentialsStore to be used by the rcon authentication module. Default is InMemoryCredentialsStore.

See Also:

Credentials, CredentialsStore, SourceRconMessenger

CLOSE_INACTIVE_CHANNELS

public static final Option<Integer> CLOSE_INACTIVE_CHANNELS

Automatically close inactive channels/connections once it has reached the threshold value (value is in seconds). Set to -1 to disable.

INACTIVE_CHECK_INTERVAL

public static final Option<Integer> INACTIVE_CHECK_INTERVAL

Number of seconds to check for inactive Channel's/connections (Unit: Seconds, Default Value: 1 sec)

See Also:

CLOSE_INACTIVE_CHANNELS

Constructor Detail

SourceRconOptions

public SourceRconOptions()

Method Detail

builder

public static OptionBuilder<SourceRconOptions> builder()

Create a new OptionBuilder for SourceRconOptions

Returns:

a newly instantiated OptionBuilder object