com.ibasco.agql.protocols.valve.steam.master

Class MasterServerMessenger

java.lang.Object

com.ibasco.agql.core.NettyMessenger<MasterServerRequest,MasterServerResponse>

com.ibasco.agql.protocols.valve.steam.master.MasterServerMessenger

All Implemented Interfaces:

Messenger<MasterServerRequest,MasterServerResponse>, ConfigurationSupport, Closeable, AutoCloseable

@MessengerProperties(optionClass=MasterServerOptions.class)
public final class MasterServerMessenger
extends NettyMessenger<MasterServerRequest,MasterServerResponse>

Handles the internal processing of the master server request/response.

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	configure(Options options) Populate configuration options.
protected NettyChannelFactory	createChannelFactory() createChannelFactory.
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.
CompletableFuture<MasterServerResponse>	send(MasterServerRequest request) Sends a new request to the master server

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

acquireContext, applyDefault, attach, close, createFactoryProvider, getChannelFactory, getExecutor, getFactoryProvider, getOptions, getTransport, lockedOption, send, 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

MasterServerMessenger

public MasterServerMessenger(Options options)

Constructor for MasterServerMessenger.

Parameters:

options - a Options object

Method Detail

send

public CompletableFuture<MasterServerResponse> send(MasterServerRequest request)

Sends a new request to the master server

Parameters:

request - The MasterServerRequest containing the details of the request.

Returns:

A CompletableFuture which is notified once the request has been completed.

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<MasterServerRequest,MasterServerResponse>

Parameters:

options - The Options instance holding the configuration data

createChannelFactory

protected NettyChannelFactory createChannelFactory()

createChannelFactory.

Specified by:

createChannelFactory in class NettyMessenger<MasterServerRequest,MasterServerResponse>

Returns:

a NettyChannelFactory object

receive

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.

Overrides:

receive in class NettyMessenger<MasterServerRequest,MasterServerResponse>

Parameters:

context - The NettyChannelContext contianing all the important transaction details.

response - The decoded AbstractResponse received

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