SgGtpClient.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
/** @file SgGtpClient.h */
//----------------------------------------------------------------------------

#ifndef SG_GTPCLIENT_H
#define SG_GTPCLIENT_H

#include <iostream>
#include <string>
#include "SgException.h"

//----------------------------------------------------------------------------

/** Error thrown by SgGtpClient::Send() if command fails or connection is
    broken. */
class SgGtpFailure
    : public SgException
{
public:
    /** Constructor.
        @param message The failure response of the command or other error
        message. */
    SgGtpFailure(const std::string& message);
};

//----------------------------------------------------------------------------

/** Client connection to an external GTP engine.
    Usage example:
@code
    // Run GNU Go and send a GTP command
    try
    {
        SgProcess process("gnugo --mode gtp");
        SgGtpClient gtp(process.Input(), process.Output());
        string result = gtp.Send("version");
        SgDebug() << "Success response: " << result << '\n';
    }
    catch (const SgGtpFailure& e)
    {
        SgDebug() << "Error response: " << e.what() << '\n';
    }
    catch (const SgException& e)
    {
        SgDebug() << "Error running GNU Go: " << e.what() << '\n';
    }

@endcode */
class SgGtpClient
{
public:
    /** Constructor.
        @param in Input stream.
        @param out Output stream.
        @param verbose Log stream to SgDebug() */
    SgGtpClient(std::istream& in, std::ostream& out, bool verbose = false);

    virtual ~SgGtpClient();

    /** Send a command.
        @return The response if command succeeds (without status character
        and whitespace after status character)
        @throws SgGtpFailure If command fails or connection is broken. */
    std::string Send(const std::string& command);

private:
    bool m_verbose;

    std::istream& m_in;

    std::ostream& m_out;
};

//----------------------------------------------------------------------------

#endif // SG_GTPCLIENT_H