Package net.sf.freecol.server.model

Class TimedSession

java.lang.Object

net.sf.freecol.server.model.Session

net.sf.freecol.server.model.TimedSession

Direct Known Subclasses:

DiplomacySession, NativeDemandSession

public abstract class TimedSession
extends Session

Root class for timed sessions.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.logging.Logger	logger
private java.util.Timer	timer	The timer that controls the session duration.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TimedSession(java.lang.String key, long timeout)	Protected constructor, we only really instantiate specific types of transactions.

Method Summary

Modifier and Type	Method	Description
protected void	cancel()	Cancel the timer task.
protected abstract boolean	complete(boolean result)	Complete this task with the given result.
boolean	complete(ChangeSet cs)	All transaction types must implement a completion action.

Methods inherited from class net.sf.freecol.server.model.Session

clearAll, completeAll, findSession, getKey, lookup, lookup, lookup, makeSessionKey, makeSessionKey, register

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

timer

private java.util.Timer timer

The timer that controls the session duration.

Constructor Detail

TimedSession

protected TimedSession(java.lang.String key,
                       long timeout)

Protected constructor, we only really instantiate specific types of transactions.

Parameters:

key - A unique key to lookup this transaction with.

timeout - The timeout for the session.

Method Detail

complete

protected abstract boolean complete(boolean result)

Complete this task with the given result. By default this will be called (with value == false) when the timer expires.

Parameters:

result - The result to complete the session with.

Returns:

The result of the session.

cancel

protected void cancel()

Cancel the timer task.

complete

public boolean complete(ChangeSet cs)

All transaction types must implement a completion action. This is called by the controller at the end of turn to complete any sessions that have not yet completed, or if the controller gets the required response to complete the session.

Overrides:

complete in class Session

Parameters:

cs - A ChangeSet to update with changes that occur when completing this session.

Returns:

True if the session was already complete.