net.sf.gogui.gtp

Class GtpClient

java.lang.Object

net.sf.gogui.gtp.GtpClientBase

net.sf.gogui.gtp.GtpClient

public final class GtpClient
extends GtpClientBase

Interface to a Go program that uses GTP over the standard I/O streams.

This class is final because it starts a thread in its constructor which might conflict with subclassing because the subclass constructor will be called after the thread is started.

Callbacks can be registered to monitor the input, output and error stream and to handle timeout and invalid responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GtpClient.ExecFailed Exception thrown if executing a GTP engine failed.
static interface	GtpClient.InvalidResponseCallback Callback if an invalid response occured.
static interface	GtpClient.IOCallback Callback interface for logging or displaying the GTP stream.
static interface	GtpClient.TimeoutCallback Callback if a timeout occured.

Field Summary

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

m_name

Constructor Summary

Constructors

Constructor and Description
GtpClient(java.io.InputStream in, java.io.OutputStream out, boolean log, GtpClient.IOCallback callback) Constructor for given input and output streams.
GtpClient(java.lang.String program, java.io.File workingDirectory, boolean log, GtpClient.IOCallback callback) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the output stream to the program.
void	destroyProcess() Kill the Go program.
boolean	getAnyCommandsResponded() Did the engine ever send a valid response to a command?
java.lang.String	getFullResponse() Get full response including status and ID and last command.
java.lang.String	getProgramCommand() Get the command line that was used for invoking the Go program.
java.lang.String	getResponse() Get response to last command sent.
boolean	isProgramDead() Check if program is dead.
void	queryName(long timeout, GtpClient.TimeoutCallback timeoutCallback)
java.lang.String	send(java.lang.String command) Send a command.
java.lang.String	send(java.lang.String command, long timeout, GtpClient.TimeoutCallback timeoutCallback) Send a command with timeout.
void	sendComment(java.lang.String comment) Send comment.
void	sendPlay(Move move, long timeout, GtpClient.TimeoutCallback timeoutCallback)
void	setAutoNumber(boolean enable) Enable auto-numbering commands.
void	setInvalidResponseCallback(GtpClient.InvalidResponseCallback callback) Set the callback for invalid responses.
void	setIOCallback(GtpClient.IOCallback callback)
void	setLogPrefix(java.lang.String prefix) Set a prefix for logging to standard error.
void	waitForExit() Wait until the process of the program exits.
void	waitForExit(int timeout, GtpClient.TimeoutCallback timeoutCallback) More sophisticated version of waitFor with timeout.
boolean	wasKilled() Was program forcefully terminated by calling destroyProcess()

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

GtpClient

public GtpClient(java.lang.String program,
         java.io.File workingDirectory,
         boolean log,
         GtpClient.IOCallback callback)
          throws GtpClient.ExecFailed

Constructor.

Parameters:

program - Command line for program. Will be split into words with respect to " as in StringUtil.tokenize. If the command line contains the string "%SRAND", it will be replaced by a random seed. This is useful if the random seed can be set by a command line option to produce deterministic randomness (the command returned by getProgramCommand() will contain the actual random seed used).

workingDirectory - The working directory to run the program in or null for the current directory

log - Log input, output and error stream to standard error.

callback - Callback for external display of the streams.

Throws:

GtpClient.ExecFailed

GtpClient

public GtpClient(java.io.InputStream in,
         java.io.OutputStream out,
         boolean log,
         GtpClient.IOCallback callback)
          throws GtpError

Constructor for given input and output streams.

Throws:

GtpError

Method Detail

close

public void close()

Close the output stream to the program. Some engines don't handle closing the command stream without an explicit quit command well, so the preferred way to terminate a connection is to send a quit command. Closing the output stream after a quit is not strictly necessary, but may improve compatibility with engines that read the input stream in a different thread

Specified by:

close in class GtpClientBase

destroyProcess

public void destroyProcess()

Kill the Go program.

getAnyCommandsResponded

public boolean getAnyCommandsResponded()

Did the engine ever send a valid response to a command?

getResponse

public java.lang.String getResponse()

Get response to last command sent.

getFullResponse

public java.lang.String getFullResponse()

Get full response including status and ID and last command.

getProgramCommand

public java.lang.String getProgramCommand()

Get the command line that was used for invoking the Go program.

Returns:

The command line that was given to the constructor.

isProgramDead

public boolean isProgramDead()

Check if program is dead.

Overrides:

isProgramDead in class GtpClientBase

send

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

Send a command.

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.

queryName

public void queryName(long timeout,
             GtpClient.TimeoutCallback timeoutCallback)
               throws GtpError

Throws:

GtpError

send

public java.lang.String send(java.lang.String command,
                    long timeout,
                    GtpClient.TimeoutCallback timeoutCallback)
                      throws GtpError

Send a command with timeout.

Parameters:

command - The command to send

timeout - Timeout in milliseconds or -1, if no timeout

timeoutCallback - Timeout callback or null if no timeout.

Returns:

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

Throws:

GtpError - containing the response if the command fails.

See Also:

GtpClient.TimeoutCallback

sendPlay

public void sendPlay(Move move,
            long timeout,
            GtpClient.TimeoutCallback timeoutCallback)
              throws GtpError

Throws:

GtpError

sendComment

public void sendComment(java.lang.String comment)

Send comment.

Specified by:

sendComment in class GtpClientBase

Parameters:

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

setAutoNumber

public void setAutoNumber(boolean enable)

Enable auto-numbering commands. Every command will be prepended by an integer as defined in the GTP standard, the integer is incremented after each command.

setInvalidResponseCallback

public void setInvalidResponseCallback(GtpClient.InvalidResponseCallback callback)

Set the callback for invalid responses.

See Also:

GtpClient.InvalidResponseCallback

setIOCallback

public void setIOCallback(GtpClient.IOCallback callback)

setLogPrefix

public void setLogPrefix(java.lang.String prefix)

Set a prefix for logging to standard error. Only used if logging was enabled in the constructor.

waitForExit

public void waitForExit()

Wait until the process of the program exits.

Specified by:

waitForExit in class GtpClientBase

waitForExit

public void waitForExit(int timeout,
               GtpClient.TimeoutCallback timeoutCallback)

More sophisticated version of waitFor with timeout.

wasKilled

public boolean wasKilled()

Was program forcefully terminated by calling destroyProcess()