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

Class MasterServerQueryClient

java.lang.Object

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

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

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

All Implemented Interfaces:

Client, Closeable, AutoCloseable

public final class MasterServerQueryClient
extends NettySocketClient<MasterServerRequest,MasterServerResponse>

Queries Valve Master Server to retrieve a list of game servers. Note that the master servers are rate-limited by default.

Author:

Rafael Luis Ibasco

See Also:

MasterServerOptions

Constructor Summary

Constructors

Constructor and Description
MasterServerQueryClient() Create a new MasterServerQueryClient instance using the pre-defined configuration Options for this client
MasterServerQueryClient(MasterServerOptions options) Create a new MasterServerQueryClient instance using the provided configuration Options

Method Summary

Modifier and Type	Method and Description
protected MasterServerMessenger	createMessenger(Options options) Factory method for Messenger.
protected MasterServerMessenger	getMessenger() Getter for the field messenger.
CompletableFuture<MasterServerResponse>	getServers(MasterServerType type, MasterServerRegion region, MasterServerFilter filter) Retrieves a list of servers from the Steam Master Server.
CompletableFuture<MasterServerResponse>	getServers(MasterServerType type, MasterServerRegion region, MasterServerFilter filter, TriConsumer<InetSocketAddress,InetSocketAddress,Throwable> callback) Retrieves a list of servers from the Steam Master Server.

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

close, equals, getExecutor, hashCode

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

getOptions, id, send, send

Methods inherited from class java.lang.Object

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

Constructor Detail

MasterServerQueryClient

public MasterServerQueryClient()

Create a new MasterServerQueryClient instance using the pre-defined configuration Options for this client

MasterServerQueryClient

public MasterServerQueryClient(MasterServerOptions options)

Create a new MasterServerQueryClient instance using the provided configuration Options

Parameters:

options - The user-defined Options containing the configuration settings to be used by this client.

See Also:

Options, OptionBuilder

Method Detail

getServers

public CompletableFuture<MasterServerResponse> getServers(MasterServerType type,
                                                          MasterServerRegion region,
                                                          MasterServerFilter filter)

Retrieves a list of servers from the Steam Master Server.

Parameters:

region - A MasterServerRegion value that specifies which server region the master server should return

filter - A MasterServerFilter containing the filters to be applied in the query

type - a MasterServerType object

Returns:

A CompletableFuture which is notified once the request has been marked as complete. Returns a Vector containing the InetSocketAddress instances of the servers.

See Also:

getServers(MasterServerType, MasterServerRegion, MasterServerFilter, TriConsumer)

getServers

public CompletableFuture<MasterServerResponse> getServers(MasterServerType type,
                                                          MasterServerRegion region,
                                                          MasterServerFilter filter,
                                                          TriConsumer<InetSocketAddress,InetSocketAddress,Throwable> callback)

Retrieves a list of servers from the Steam Master Server. Passing a callback will allow you to partially receive a batch of addresses in real-time as it queries the master server

Parameters:

type - The MasterServerType describing the type of master server to query

region - A MasterServerRegion value that specifies which server region the master server should return

filter - A MasterServerFilter containing the filters to be applied in the query

callback - Accepts a TriConsumer callback that will be called repeatedly for every batch of addresses received from the master server. (Parameters: Server Address, Master Server Address, Exception)

Returns:

A CompletableFuture which is notified once the request has been marked as complete. Returns a Vector containing the InetSocketAddress instances of the servers.

See Also:

getServers(MasterServerType, MasterServerRegion, MasterServerFilter)

createMessenger

protected MasterServerMessenger createMessenger(Options options)

Factory method for Messenger.

Specified by:

createMessenger in class NettySocketClient<MasterServerRequest,MasterServerResponse>

Parameters:

options - a Options object

Returns:

a Messenger object

getMessenger

protected MasterServerMessenger getMessenger()

Getter for the field messenger.

Overrides:

getMessenger in class NettySocketClient<MasterServerRequest,MasterServerResponse>

Returns:

a Messenger object