com.ibasco.agql.core

Class NettyMessenger<R extends AbstractRequest,S extends AbstractResponse>

java.lang.Object

com.ibasco.agql.core.NettyMessenger<R,S>

All Implemented Interfaces:

Messenger<R,S>, ConfigurationSupport, Closeable, AutoCloseable

Direct Known Subclasses:

MasterServerMessenger, SourceQueryMessenger, SourceRconMessenger

public abstract class NettyMessenger<R extends AbstractRequest,S extends AbstractResponse>
extends Object
implements Messenger<R,S>

Base class for modules utilizing Netty as the mode of transport

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NettyMessenger(Options options) Constructor for NettyMessenger.

Method Summary

Modifier and Type	Method and Description
protected CompletableFuture<NettyChannelContext>	acquireContext(Object data) Acquire context
protected <X> void	applyDefault(Option<X> option, X value) Apply a default option value if not specified by the user
protected static NettyChannelContext	attach(NettyChannelContext context, AbstractRequest request) Attach a request to the context
void	close()
protected abstract void	configure(Options options) Populate configuration options.
protected abstract NettyChannelFactory	createChannelFactory() createChannelFactory.
protected NettyChannelFactoryProvider	createFactoryProvider() createFactoryProvider.
NettyChannelFactory	getChannelFactory() Getter for the field channelFactory.
io.netty.channel.EventLoopGroup	getExecutor() The Executor utilized by this messenger
protected NettyChannelFactoryProvider	getFactoryProvider() Getter for the field factoryProvider.
Options	getOptions() getOptions.
NettyTransport	getTransport() The underlying Transport used by this instance
protected <X> void	lockedOption(Options map, Option<X> option, X value) Lock an option and prevent future updates for this option
protected void	receive(@NotNull NettyChannelContext context, AbstractResponse response, Throwable error) The method that will be called by the last ChannelHandler once a response has been received from the remote server.
<C extends NettyChannelContext> CompletableFuture<C>	send(C context) Send context to the underlying Transport
CompletableFuture<S>	send(InetSocketAddress address, R request) Send request to the underlying Transport
protected Object	transformProperties(InetSocketAddress address, R request) 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

NettyMessenger

protected NettyMessenger(Options options)

Constructor for NettyMessenger.

Parameters:

options - a Options object

Method Detail

configure

protected abstract void configure(Options options)

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

Parameters:

options - The Options instance holding the configuration data

createFactoryProvider

protected NettyChannelFactoryProvider createFactoryProvider()

createFactoryProvider.

Returns:

a NettyChannelFactoryProvider object

createChannelFactory

protected abstract NettyChannelFactory createChannelFactory()

createChannelFactory.

Returns:

a NettyChannelFactory object

getOptions

public Options getOptions()

getOptions.

Specified by:

getOptions in interface ConfigurationSupport

Returns:

a Options object

send

public CompletableFuture<S> send(InetSocketAddress address,
                                 R request)

Send request to the underlying Transport

Specified by:

send in interface Messenger<R extends AbstractRequest,S extends AbstractResponse>

Parameters:

address - a InetSocketAddress object

request - a R object

Returns:

a CompletableFuture object

acquireContext

protected final CompletableFuture<NettyChannelContext> acquireContext(Object data)

Acquire context

Parameters:

data - a Object object

Returns:

a CompletableFuture object

transformProperties

protected Object transformProperties(InetSocketAddress address,
                                     R request)

transformProperties.

Parameters:

address - a InetSocketAddress object

request - a R object

Returns:

a Object object

attach

protected static NettyChannelContext attach(NettyChannelContext context,
                                            AbstractRequest request)

Attach a request to the context

Parameters:

context - a NettyChannelContext object

request - a AbstractRequest object

Returns:

a NettyChannelContext object

send

public final <C extends NettyChannelContext> CompletableFuture<C> send(C context)

Send context to the underlying Transport

Type Parameters:

C - A type of NettyChannelContext

Parameters:

context - The context containing the transaction details

Returns:

a CompletableFuture object

getTransport

public final NettyTransport getTransport()

The underlying Transport used by this instance

Specified by:

getTransport in interface Messenger<R extends AbstractRequest,S extends AbstractResponse>

Returns:

a Transport object

getExecutor

public final io.netty.channel.EventLoopGroup getExecutor()

The Executor utilized by this messenger

Specified by:

getExecutor in interface Messenger<R extends AbstractRequest,S extends AbstractResponse>

Returns:

a Executor object

receive

@ApiStatus.Internal
protected void receive(@NotNull
                                           @NotNull NettyChannelContext context,
                                           AbstractResponse response,
                                           Throwable error)

The method that will be called by the last ChannelHandler once a response has been received from the remote server.

Parameters:

context - The NettyChannelContext contianing all the important transaction details.

error - The error that occured during send/receive operation. null if no error occured.

response - The decoded AbstractResponse received

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getChannelFactory

public final NettyChannelFactory getChannelFactory()

Getter for the field channelFactory.

Returns:

a NettyChannelFactory object

getFactoryProvider

protected final NettyChannelFactoryProvider getFactoryProvider()

Getter for the field factoryProvider.

Returns:

a NettyChannelFactoryProvider object

lockedOption

protected final <X> void lockedOption(Options map,
                                      Option<X> option,
                                      X value)

Lock an option and prevent future updates for this option

Type Parameters:

X - a X class

Parameters:

map - a Options object

option - a Option object

value - a X object

applyDefault

protected final <X> void applyDefault(Option<X> option,
                                      X value)

Apply a default option value if not specified by the user

Type Parameters:

X - a X class

Parameters:

option - a Option object

value - a X object