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

Class SourceRconMessenger

java.lang.Object

com.ibasco.agql.core.NettyMessenger<SourceRconRequest,SourceRconResponse>

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

All Implemented Interfaces:

Messenger<SourceRconRequest,SourceRconResponse>, ConfigurationSupport, Closeable, AutoCloseable

@MessengerProperties(optionClass=SourceRconOptions.class)
public final class SourceRconMessenger
extends NettyMessenger<SourceRconRequest,SourceRconResponse>

RCON Messenger

Author:

Rafael Luis Ibasco

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceRconMessenger.ConnectionStats
static class	SourceRconMessenger.Metadata
class	SourceRconMessenger.Statistics

Constructor Summary

Constructors

Constructor and Description
SourceRconMessenger(Options options) Constructor for SourceRconMessenger.

Method Summary

Modifier and Type	Method and Description
void	cleanup(boolean force) Cleanup inactive connections
void	close()
protected void	configure(Options options) Populate configuration options.
protected NettyChannelFactory	createChannelFactory() createChannelFactory.
ChannelRegistry	getChannelRegistry() Getter for the field registry.
CredentialsStore	getCredentialsStore() Getter for the field credentialsStore.
SourceRconMessenger.Statistics	getStatistics() Getter for the field statistics.
void	invalidate() Invalidate all registered addresses and the connections associated with it
void	invalidate(boolean onlyConnections) Invalidates all registered addresses along with its connections.
void	invalidate(InetSocketAddress address) Invalidate both credentials and all it's Channel's associated with it
void	invalidate(InetSocketAddress address, boolean connectionsOnly) Invalidate the credentials and/or the Channel's associated with it
boolean	isAuthenticated(InetSocketAddress address) Checks if the specified InetSocketAddress has been previously authenticated.
boolean	isReauthenticate() Check if reauthenticate flag is set
CompletableFuture<SourceRconResponse>	send(InetSocketAddress address, SourceRconRequest request) Send request to the underlying Transport

Methods inherited from class com.ibasco.agql.core.NettyMessenger

acquireContext, applyDefault, attach, createFactoryProvider, getChannelFactory, getExecutor, getFactoryProvider, getOptions, getTransport, lockedOption, receive, send, transformProperties

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.ConfigurationSupport

get, get, getOrDefault, getOrDefault, lock, set, unlock

Constructor Detail

SourceRconMessenger

public SourceRconMessenger(Options options)

Constructor for SourceRconMessenger.

Parameters:

options - a Options object

Method Detail

configure

protected void configure(Options options)

Populate configuration options. Subclasses should override this method. This is called right before the underlying transport is initialized.

Specified by:

configure in class NettyMessenger<SourceRconRequest,SourceRconResponse>

Parameters:

options - The Options instance holding the configuration data

createChannelFactory

protected NettyChannelFactory createChannelFactory()

createChannelFactory.

Specified by:

createChannelFactory in class NettyMessenger<SourceRconRequest,SourceRconResponse>

Returns:

a NettyChannelFactory object

send

public CompletableFuture<SourceRconResponse> send(InetSocketAddress address,
                                                  SourceRconRequest request)

Send request to the underlying Transport

Route the rcon request to it's appropriate handler

Specified by:

send in interface Messenger<SourceRconRequest,SourceRconResponse>

Overrides:

send in class NettyMessenger<SourceRconRequest,SourceRconResponse>

Parameters:

address - a InetSocketAddress object

request - a R object

Returns:

a CompletableFuture object

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class NettyMessenger<SourceRconRequest,SourceRconResponse>

Throws:

IOException

isReauthenticate

public boolean isReauthenticate()

Check if reauthenticate flag is set

Returns:

true if automatic re-authentication is enabled.

getChannelRegistry

public ChannelRegistry getChannelRegistry()

Getter for the field registry.

Returns:

a ChannelRegistry object

getCredentialsStore

public CredentialsStore getCredentialsStore()

Getter for the field credentialsStore.

Returns:

a CredentialsStore object

See Also:

InMemoryCredentialsStore

isAuthenticated

public boolean isAuthenticated(InetSocketAddress address)

Checks if the specified InetSocketAddress has been previously authenticated.

Note: This does not check the validity of the Credentials registered to the address.

Parameters:

address - The InetSocketAddress to check

Returns:

true if the address has been previously authenticated.

getStatistics

@ApiStatus.Experimental
 @ApiStatus.Internal
public SourceRconMessenger.Statistics getStatistics()

Getter for the field statistics.

Returns:

a SourceRconMessenger.Statistics object

cleanup

public void cleanup(boolean force)

Cleanup inactive connections

invalidate

public void invalidate()

Invalidate all registered addresses and the connections associated with it

invalidate

public void invalidate(boolean onlyConnections)

Invalidates all registered addresses along with its connections.

Parameters:

onlyConnections - true if we should only invalidate the Channel's for the specified address.

invalidate

public void invalidate(InetSocketAddress address,
                       boolean connectionsOnly)

Invalidate the credentials and/or the Channel's associated with it

Parameters:

address - The InetSocketAddress to invalidate

connectionsOnly - true if we should only also invalidate the connections associated with the specified address, credentials will remain valid.

invalidate

public void invalidate(InetSocketAddress address)

Invalidate both credentials and all it's Channel's associated with it

Parameters:

address - a InetSocketAddress object