Class SocketClientThread

java.lang.Object

java.lang.Thread

net.sf.colossus.client.SocketClientThread

All Implemented Interfaces:

Runnable, IServerConnection, IServer

final class SocketClientThread
extends Thread
implements IServer, IServerConnection

Thread to handle server connection on client side.

Author:

David Ripton

Nested Class Summary

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	abandoned
private ClientThread	clientThread
private ClientThread	disposedClientThread
private boolean	goingDown
private String	host	Those are stored at the moment only to be able to reconnect
private BufferedReader	in
private String	initialLine
private final boolean	internalSpectator
private boolean	isWaiting
private final Object	isWaitingLock
private static final Logger	LOGGER
private PrintWriter	out
private int	ownMessageCounter
private String	playerName
private int	port
private Collection<String>	preliminaryPlayerNames
private String	reasonFail
private boolean	remote
private boolean	selfInterrupted
private static final String	sep
private boolean	serverReceiveTimedout
private Socket	socket
private boolean	spectator
private String	variantNameForInit

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface IServer

CLIENT_VERSION, CLIENT_VERSION_CAN_HANDLE_NAK, CLIENT_VERSION_CAN_RECONNECT, CLIENT_VERSION_UNDERSTANDS_PING, CLIENT_VERSION_VARIANT_XML_OK, MINIMUM_CLIENT_VERSION

Constructor Summary

Constructors

Constructor	Description
SocketClientThread(String host, int port, String initialName, boolean isRemote, boolean spectator)

Method Summary

Modifier and Type	Method	Description
int	abandonAndGetMessageCounter()
void	acquireAngel(Legion legion, CreatureType angelType)
void	appendToConnectionLog(String s)
void	applyCarries(BattleHex hex)
void	assignColor(PlayerColor color)
void	assignFirstMarker(String markerId)
void	assignStrikePenalty(String prompt)
private void	callMethod(String method, List<String> args)
void	checkServerConnection()
private void	cleanupSocket()
void	clientConfirmedCatchup()
void	concede(Legion legion)
static SocketClientThread	createConnection(String host, int port, String initialName, boolean remote, boolean spectator)
void	doBattleMove(int tag, BattleHex hex)
void	doMove(Legion legion, MasterHex hex, EntrySide entrySide, boolean teleport, CreatureType teleportingLord)
void	doneWithBattleMoves()
void	doneWithEngagements()
void	doneWithMoves()
void	doneWithRecruits()
void	doneWithSplits()
void	doneWithStrikes()
void	doNotConcede(Legion legion)
void	doNotFlee(Legion legion)
void	doRecruit(Recruitment event)
void	doSplit(Legion parent, String childMarker, List<CreatureType> creaturesToSplit)	Executes a split of certain creatures from a legion.
void	doSummon(Summoning event)	Handles a summon event
void	enforcedConnectionException()
void	engage(MasterHex hex)
void	fight(MasterHex hex)
void	flee(Legion legion)
int	getDisposedQueueLen()
IServer	getIServer()
Collection<String>	getPreliminaryPlayerNames()
private String	getPrintName()
String	getReasonFail()
String	getVariantNameForInit()
void	interrupt()
boolean	isAlreadyDown()
void	joinGame(String playerName)
void	leaveCarryMode()
void	loadGame(String filename)
void	makeProposal(String proposalString)
void	mulligan()
void	newGame()
private void	parseLine(String s)
private void	readAndParseUntilDone()
private String	readOneLine()
protected static SocketClientThread	recreateConnection(IServerConnection prevConnection)
void	replyToPing()
private void	requestGameInfo()
void	requestSyncDelta(int msgNr, int syncCounter)
void	run()
void	saveGame(String filename)
void	sendDisconnect()
private void	sendToServer(String message)
void	setClient(Client client)
private void	setWaiting(boolean val)
private void	signOn(String loginName, boolean isRemote, int version, String buildInfo, boolean spectator)
void	startThread()
void	stopGame()
void	stopSocketClientThread(boolean sendConnect)	Client originates the dispose: If done because all is over, player chose close etc, send also a disconnect so that server knows client is "gone".
void	strike(int tag, BattleHex hex)
void	undoBattleMove(BattleHex hex)
void	undoMove(Legion legion)
void	undoRecruit(Legion legion)
void	undoSplit(Legion splitoff)
void	updatePlayerName(String playerName)
private String	waitForGameInfo()
private String	waitForLine()
void	waitForPrompt()
private String	waitForSignonOk()
void	watchGame()
void	withdrawFromGame()

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

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

Field Details

LOGGER

private static final Logger LOGGER

clientThread

private ClientThread clientThread

disposedClientThread

private ClientThread disposedClientThread

socket

private Socket socket

in

private BufferedReader in

out

private PrintWriter out

goingDown

private boolean goingDown

selfInterrupted

private boolean selfInterrupted

serverReceiveTimedout

private boolean serverReceiveTimedout

host

private String host

Those are stored at the moment only to be able to reconnect

port

private int port

playerName

private String playerName

remote

private boolean remote

spectator

private boolean spectator

internalSpectator

private final boolean internalSpectator

sep

private static final String sep

See Also:

• Constant Field Values

reasonFail

private String reasonFail

initialLine

private String initialLine

variantNameForInit

private String variantNameForInit

preliminaryPlayerNames

private Collection<String> preliminaryPlayerNames

isWaitingLock

private final Object isWaitingLock

isWaiting

private boolean isWaiting

ownMessageCounter

private int ownMessageCounter

abandoned

private boolean abandoned

Constructor Details

SocketClientThread

SocketClientThread(String host,
 int port,
 String initialName,
 boolean isRemote,
 boolean spectator)

Method Details

createConnection

public static SocketClientThread createConnection(String host,
 int port,
 String initialName,
 boolean remote,
 boolean spectator)
                                           throws Client.ConnectionInitException

Throws:

Client.ConnectionInitException

recreateConnection

protected static SocketClientThread recreateConnection(IServerConnection prevConnection)
                                                throws Client.ConnectionInitException

Throws:

Client.ConnectionInitException

readOneLine

private String readOneLine()
                    throws IOException

Throws:

IOException

waitForPrompt

public void waitForPrompt()
                   throws SocketTimeoutException,
SocketException,
IOException

Throws:

SocketTimeoutException

SocketException

IOException

waitForSignonOk

private String waitForSignonOk()
                        throws IOException

Throws:

IOException

waitForGameInfo

private String waitForGameInfo()
                        throws IOException

Throws:

IOException

getReasonFail

public String getReasonFail()

Specified by:

getReasonFail in interface IServerConnection

appendToConnectionLog

public void appendToConnectionLog(String s)

getVariantNameForInit

public String getVariantNameForInit()

Specified by:

getVariantNameForInit in interface IServerConnection

getPreliminaryPlayerNames

public Collection<String> getPreliminaryPlayerNames()

Specified by:

getPreliminaryPlayerNames in interface IServerConnection

getIServer

public IServer getIServer()

Specified by:

getIServer in interface IServerConnection

setClient

public void setClient(Client client)

Specified by:

setClient in interface IServerConnection

getDisposedQueueLen

public int getDisposedQueueLen()

Specified by:

getDisposedQueueLen in interface IServerConnection

startThread

public void startThread()

Specified by:

startThread in interface IServerConnection

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

readAndParseUntilDone

private void readAndParseUntilDone()

setWaiting

private void setWaiting(boolean val)

waitForLine

private String waitForLine()

isAlreadyDown

public boolean isAlreadyDown()

Specified by:

isAlreadyDown in interface IServerConnection

cleanupSocket

private void cleanupSocket()

interrupt

public void interrupt()

Overrides:

interrupt in class Thread

stopSocketClientThread

public void stopSocketClientThread(boolean sendConnect)

Client originates the dispose: If done because all is over, player chose close etc, send also a disconnect so that server knows client is "gone". If done because of actually or suspected "connection dead/problems", just shut down the SCT peacefully, do not inform server, client might want to reconnect later with a new SCT / ClientThread pair.

Specified by:

stopSocketClientThread in interface IServerConnection

Parameters:

sendConnect - If true, sends a disconnect message to server

abandonAndGetMessageCounter

public int abandonAndGetMessageCounter()

Specified by:

abandonAndGetMessageCounter in interface IServerConnection

parseLine

private void parseLine(String s)

callMethod

private void callMethod(String method,
 List<String> args)

getPrintName

private String getPrintName()

sendToServer

private void sendToServer(String message)

signOn

private void signOn(String loginName,
 boolean isRemote,
 int version,
 String buildInfo,
 boolean spectator)

requestGameInfo

private void requestGameInfo()

updatePlayerName

public void updatePlayerName(String playerName)

Specified by:

updatePlayerName in interface IServerConnection

leaveCarryMode

public void leaveCarryMode()

Specified by:

leaveCarryMode in interface IServer

doneWithBattleMoves

public void doneWithBattleMoves()

Specified by:

doneWithBattleMoves in interface IServer

doneWithStrikes

public void doneWithStrikes()

Specified by:

doneWithStrikes in interface IServer

acquireAngel

public void acquireAngel(Legion legion,
 CreatureType angelType)

Specified by:

acquireAngel in interface IServer

doSummon

public void doSummon(Summoning event)

Description copied from interface: IServer

Handles a summon event

Specified by:

doSummon in interface IServer

Parameters:

event - The summon event or null if summoning is not wanted.

doRecruit

public void doRecruit(Recruitment event)

Specified by:

doRecruit in interface IServer

engage

public void engage(MasterHex hex)

Specified by:

engage in interface IServer

concede

public void concede(Legion legion)

Specified by:

concede in interface IServer

doNotConcede

public void doNotConcede(Legion legion)

Specified by:

doNotConcede in interface IServer

flee

public void flee(Legion legion)

Specified by:

flee in interface IServer

doNotFlee

public void doNotFlee(Legion legion)

Specified by:

doNotFlee in interface IServer

makeProposal

public void makeProposal(String proposalString)

Specified by:

makeProposal in interface IServer

fight

public void fight(MasterHex hex)

Specified by:

fight in interface IServer

doBattleMove

public void doBattleMove(int tag,
 BattleHex hex)

Specified by:

doBattleMove in interface IServer

strike

public void strike(int tag,
 BattleHex hex)

Specified by:

strike in interface IServer

applyCarries

public void applyCarries(BattleHex hex)

Specified by:

applyCarries in interface IServer

undoBattleMove

public void undoBattleMove(BattleHex hex)

Specified by:

undoBattleMove in interface IServer

assignStrikePenalty

public void assignStrikePenalty(String prompt)

Specified by:

assignStrikePenalty in interface IServer

mulligan

public void mulligan()

Specified by:

mulligan in interface IServer

undoSplit

public void undoSplit(Legion splitoff)

Specified by:

undoSplit in interface IServer

undoMove

public void undoMove(Legion legion)

Specified by:

undoMove in interface IServer

undoRecruit

public void undoRecruit(Legion legion)

Specified by:

undoRecruit in interface IServer

doneWithSplits

public void doneWithSplits()

Specified by:

doneWithSplits in interface IServer

doneWithMoves

public void doneWithMoves()

Specified by:

doneWithMoves in interface IServer

doneWithEngagements

public void doneWithEngagements()

Specified by:

doneWithEngagements in interface IServer

doneWithRecruits

public void doneWithRecruits()

Specified by:

doneWithRecruits in interface IServer

withdrawFromGame

public void withdrawFromGame()

Specified by:

withdrawFromGame in interface IServer

sendDisconnect

public void sendDisconnect()

Specified by:

sendDisconnect in interface IServer

stopGame

public void stopGame()

Specified by:

stopGame in interface IServer

doSplit

public void doSplit(Legion parent,
 String childMarker,
 List<CreatureType> creaturesToSplit)

Description copied from interface: IServer

Executes a split of certain creatures from a legion.

Specified by:

doSplit in interface IServer

Parameters:

parent - The legion to split the creatures out of.

childMarker - A marker for the new legion.

creaturesToSplit - The creatures to split out.

doMove

public void doMove(Legion legion,
 MasterHex hex,
 EntrySide entrySide,
 boolean teleport,
 CreatureType teleportingLord)

Specified by:

doMove in interface IServer

assignColor

public void assignColor(PlayerColor color)

Specified by:

assignColor in interface IServer

assignFirstMarker

public void assignFirstMarker(String markerId)

Specified by:

assignFirstMarker in interface IServer

newGame

public void newGame()

Specified by:

newGame in interface IServer

loadGame

public void loadGame(String filename)

Specified by:

loadGame in interface IServer

saveGame

public void saveGame(String filename)

Specified by:

saveGame in interface IServer

checkServerConnection

public void checkServerConnection()

Specified by:

checkServerConnection in interface IServer

clientConfirmedCatchup

public void clientConfirmedCatchup()

Specified by:

clientConfirmedCatchup in interface IServer

joinGame

public void joinGame(String playerName)

Specified by:

joinGame in interface IServer

watchGame

public void watchGame()

Specified by:

watchGame in interface IServer

requestSyncDelta

public void requestSyncDelta(int msgNr,
 int syncCounter)

Specified by:

requestSyncDelta in interface IServerConnection

replyToPing

public void replyToPing()

enforcedConnectionException

public void enforcedConnectionException()

Specified by:

enforcedConnectionException in interface IServerConnection