net.sf.gogui.gui

Class GuiGtpClient

java.lang.Object

net.sf.gogui.gtp.GtpClientBase

net.sf.gogui.gui.GuiGtpClient

public class GuiGtpClient
extends GtpClientBase

Wrapper around gtp.GtpClient to be used in a GUI environment. Allows to send fast commands with the GtpClientBase.send() function immediately in the event dispatch thread and potentially slow commands in a separate thread with a callback in the event thread after the command finished. Fast commands are ones that the Go engine is supposed to answer quickly (like boardsize, play and undo), however they have a timeout to prevent the GUI to hang, if the program does not respond. After the timeout a dialog is opened that allows to kill the program or continue to wait. This class also contains a GtpSynchronizer.

Field Summary

Fields inherited from class net.sf.gogui.gtp.GtpClientBase

m_name

Constructor Summary

Constructors

Constructor and Description
GuiGtpClient(GtpClient gtp, java.awt.Component owner, GtpSynchronizer.Listener listener, MessageDialogs messageDialogs)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close output connection.
void	destroyGtp()
boolean	getAnyCommandsResponded()
GtpError	getException() Get exception of asynchronous command.
java.lang.String	getProgramCommand()
java.lang.String	getResponse() Get response to asynchronous command.
void	initSynchronize(ConstBoard board, Komi komi, TimeSettings timeSettings)
boolean	isCommandInProgress()
boolean	isOutOfSync()
boolean	isProgramDead() Is the program in a state, that all subsequent commands will fail.
java.lang.String	send(java.lang.String command) Send command in event dispatch thread.
void	send(java.lang.String command, java.lang.Runnable callback) Send asynchronous command.
void	sendComment(java.lang.String comment) Send comment.
void	setAutoNumber(boolean enable)
void	synchronize(ConstBoard board, Komi komi, TimeSettings timeSettings)
void	updateAfterGenmove(ConstBoard board)
void	updateHumanMove(ConstBoard board, Move move)
void	waitForExit() Wait until the process of the program exits.
boolean	wasKilled()

Methods inherited from class net.sf.gogui.gtp.GtpClientBase

getCommandBoardsize, getCommandClearBoard, getCommandGenmove, getCommandPlay, getCpuTime, getLabel, getName, getProtocolVersion, getSupportedCommands, isCpuTimeSupported, isGenmoveSupported, isInterruptSupported, isSupported, queryInterruptSupport, queryName, queryProtocolVersion, querySupportedCommands, queryVersion, sendBoardsize, sendClearBoard, sendInterrupt, sendPlay, setLowerCase

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiGtpClient

public GuiGtpClient(GtpClient gtp,
            java.awt.Component owner,
            GtpSynchronizer.Listener listener,
            MessageDialogs messageDialogs)

Method Detail

close

public void close()

Description copied from class: GtpClientBase

Close output connection. Should do nothing if the concrete class does not communicate through streams.

Specified by:

close in class GtpClientBase

destroyGtp

public void destroyGtp()

getAnyCommandsResponded

public boolean getAnyCommandsResponded()

getException

public GtpError getException()

Get exception of asynchronous command. You must call this before you are allowed to send new a command.

getProgramCommand

public java.lang.String getProgramCommand()

getResponse

public java.lang.String getResponse()

Get response to asynchronous command. You must call getException() first.

initSynchronize

public void initSynchronize(ConstBoard board,
                   Komi komi,
                   TimeSettings timeSettings)
                     throws GtpError

Throws:

GtpError

isCommandInProgress

public boolean isCommandInProgress()

isOutOfSync

public boolean isOutOfSync()

isProgramDead

public boolean isProgramDead()

Description copied from class: GtpClientBase

Is the program in a state, that all subsequent commands will fail. Returns false, but can be reimplemented in a subclass.

Overrides:

isProgramDead in class GtpClientBase

send

public void send(java.lang.String command,
        java.lang.Runnable callback)

Send asynchronous command.

sendComment

public void sendComment(java.lang.String comment)

Description copied from class: GtpClientBase

Send comment.

Specified by:

sendComment in class GtpClientBase

Parameters:

comment - comment line (must start with '#').

send

public java.lang.String send(java.lang.String command)
                      throws GtpError

Send command in event dispatch thread.

Specified by:

send in class GtpClientBase

Returns:

The response text of the successful response not including the status character.

Throws:

GtpError - containing the response if the command fails.

setAutoNumber

public void setAutoNumber(boolean enable)

synchronize

public void synchronize(ConstBoard board,
               Komi komi,
               TimeSettings timeSettings)
                 throws GtpError

Throws:

GtpError

updateAfterGenmove

public void updateAfterGenmove(ConstBoard board)

updateHumanMove

public void updateHumanMove(ConstBoard board,
                   Move move)
                     throws GtpError

Throws:

GtpError

waitForExit

public void waitForExit()

Description copied from class: GtpClientBase

Wait until the process of the program exits. Should do nothing if the concrete class does not create a process.

Specified by:

waitForExit in class GtpClientBase

wasKilled

public boolean wasKilled()