com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor Class Reference

Collaboration diagram for com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor:

Public Member Functions
void	addMetaserver (@NotNull final Metaserver metaserver)
	MetaserverProcessor (@NotNull final GuiStateManager guiStateManager, @Nullable final Path metaserverCacheFile, @NotNull final MetaserverModel metaserverModel)
void	start ()
void	stop ()

Private Member Functions
void	disable ()
void	enable ()
void	updateMetaList (@NotNull final Metaserver metaserver)

Private Attributes
boolean	enabled
final GuiStateListener	guiStateListener
long	lastQuery = nextQuery-MIN_UPDATE_INTERVAL*1000
final MetaserverModel	metaserverModel
final Collection< Metaserver >	metaservers = new ArrayList<>()
long	nextQuery = System.currentTimeMillis()
final Runnable	runnable
final ServerCache	serverCache
final Object	sync = new Object()
Thread	thread

Static Private Attributes
static final long	EXPIRE_INTERVAL = 60L*60*24*2
static final int	MIN_UPDATE_INTERVAL = 5*60
static final int	UPDATE_INTERVAL = 15*60

Detailed Description

Asynchronously queries the metaserver and updates a MetaserverModel instance. Queries are performed regularly every UPDATE_INTERVAL. Queries are stopped when the server selection GUI is left. Automatically re-starts queries when the server selection GUI is shown again.

Author

Andreas Kirschbaum

Definition at line 42 of file MetaserverProcessor.java.

Constructor & Destructor Documentation

MetaserverProcessor()

com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.MetaserverProcessor	(	@NotNull final GuiStateManager	guiStateManager,
		@Nullable final Path	metaserverCacheFile,
		@NotNull final MetaserverModel	metaserverModel
	)

Creates a new instance.

Parameters

guiStateManager	the gui state manager to watch
metaserverCacheFile	the metaserver cache file or null to not use a cache file
metaserverModel	the metaserver model instance to update

Definition at line 192 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverModel.begin(), com.realtime.crossfire.jxclient.metaserver.MetaserverModel.commit(), com.realtime.crossfire.jxclient.metaserver.ServerCache.getAll(), com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.guiStateListener, com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.metaserverModel, and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.serverCache.

Here is the call graph for this function:

Member Function Documentation

addMetaserver()

void com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.addMetaserver

(

@NotNull final Metaserver

metaserver

)

Adds a metaserver to track.

Parameters

metaserver

the metaserver instance to query

Definition at line 205 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.metaservers, and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.sync.

Referenced by com.realtime.crossfire.jxclient.main.JXClient.JXClient(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessorTest.start_queryMetaserver_updatesMetaserverModel().

Here is the caller graph for this function:

disable()

void com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.disable ( )

private

Disables periodic re-queries.

Definition at line 251 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enabled, and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.sync.

enable()

void com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enable ( )

private

Enables periodic re-queries.

Definition at line 261 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enabled, com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.nextQuery, and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.sync.

start()

void com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.start

(

)

Starts querying the added metaservers.

Definition at line 214 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.nextQuery, com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.runnable, com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.sync, and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.thread.

Referenced by com.realtime.crossfire.jxclient.main.JXClient.JXClient(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessorTest.start_queryMetaserver_updatesMetaserverModel().

Here is the caller graph for this function:

stop()

void com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.stop

(

)

Stops querying the added metaservers.

Definition at line 229 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.sync, and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.thread.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessorTest.start_queryMetaserver_updatesMetaserverModel().

Here is the caller graph for this function:

updateMetaList()

void com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.updateMetaList ( @NotNull final Metaserver  metaserver )

private

Queries one metaserver and updates metaserverModel accordingly.

Parameters

metaserver

the metaserver

Definition at line 273 of file MetaserverProcessor.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverModel.addMetaserverEntry(), com.realtime.crossfire.jxclient.metaserver.MetaserverModel.begin(), com.realtime.crossfire.jxclient.metaserver.MetaserverModel.commit(), com.realtime.crossfire.jxclient.metaserver.ServerCache.expire(), com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.EXPIRE_INTERVAL, com.realtime.crossfire.jxclient.metaserver.ServerCache.getAll(), com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.metaserverModel, com.realtime.crossfire.jxclient.metaserver.ServerCache.put(), com.realtime.crossfire.jxclient.metaserver.ServerCache.save(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.serverCache.

Here is the call graph for this function:

Member Data Documentation

enabled

boolean com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enabled

private

Whether periodic queries are enabled.

Definition at line 92 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.disable(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enable().

EXPIRE_INTERVAL

final long com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.EXPIRE_INTERVAL = 60L*60*24*2

staticprivate

The time (in seconds) to forget about old metaserver entries.

Definition at line 57 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.updateMetaList().

guiStateListener

final GuiStateListener com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.guiStateListener

private

The GuiStateListener for detecting established or dropped connections.

Definition at line 146 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.MetaserverProcessor().

lastQuery

long com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.lastQuery = nextQuery-MIN_UPDATE_INTERVAL*1000

private

The timestamp at which the last query was done.

Definition at line 102 of file MetaserverProcessor.java.

metaserverModel

final MetaserverModel com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.metaserverModel

private

The MetaserverModel instance to update.

Definition at line 69 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.MetaserverProcessor(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.updateMetaList().

metaservers

final Collection<Metaserver> com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.metaservers = new ArrayList<>()

private

The Metaserver instances to query.

Definition at line 63 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.addMetaserver().

MIN_UPDATE_INTERVAL

final int com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.MIN_UPDATE_INTERVAL = 5*60

staticprivate

The minimal update-interval in seconds.

Definition at line 52 of file MetaserverProcessor.java.

nextQuery

long com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.nextQuery = System.currentTimeMillis()

private

The timestamp at which a query is done.

Definition at line 97 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enable(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.start().

runnable

final Runnable com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.runnable

private

The query Thread.

Definition at line 108 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.start().

serverCache

final ServerCache com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.serverCache

private

The cached metaserver entries.

Definition at line 75 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.MetaserverProcessor(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.updateMetaList().

sync

final Object com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.sync = new Object()

private

The object used for synchronization.

Definition at line 81 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.addMetaserver(), com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.disable(), com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.enable(), com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.start(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.stop().

thread

Thread com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.thread

private

The thread for runnable or

null 

when not running.

Definition at line 87 of file MetaserverProcessor.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.start(), and com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.stop().

UPDATE_INTERVAL

final int com.realtime.crossfire.jxclient.metaserver.MetaserverProcessor.UPDATE_INTERVAL = 15*60

staticprivate

The regular update-interval in seconds.

Definition at line 47 of file MetaserverProcessor.java.

---

The documentation for this class was generated from the following file:

• src/network/src/main/java/com/realtime/crossfire/jxclient/metaserver/MetaserverProcessor.java