Package net.sf.colossus.webcommon

Interface IWebClient

All Known Implementing Classes:

CmdLineWebClient, WebClient, WebServerClient

public interface IWebClient

Interface for what WebServer (Public Game Server) sends to WebClient

Author:

Clemens Katzer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	alreadyLoggedIn
static java.lang.String	chatDeliver
static java.lang.String	connectionClosed
static java.lang.String	didEnroll
static java.lang.String	didUnenroll
static java.lang.String	forcedLogout
static java.lang.String	gameCancelled
static java.lang.String	gameInfo
static java.lang.String	gameStarted
static java.lang.String	gameStartsNow
static java.lang.String	gameStartsSoon
static java.lang.String	generalMessage
static java.lang.String	grantAdmin
static java.lang.String	pingRequest
static java.lang.String	requestAttention
static java.lang.String	systemMessage
static java.lang.String	tooManyUsers
static java.lang.String	userInfo
static java.lang.String	watchGameInfo

Method Summary

Modifier and Type	Method	Description
void	chatDeliver(java.lang.String chatId, long when, java.lang.String sender, java.lang.String message, boolean resent)
void	connectionReset(boolean forcedLogout)
void	deliverGeneralMessage(long when, boolean error, java.lang.String title, java.lang.String message)
void	didEnroll(java.lang.String gameId, java.lang.String username)
void	didUnenroll(java.lang.String gameId, java.lang.String username)
void	gameCancelled(java.lang.String gameId, java.lang.String byUser)
void	gameInfo(GameInfo gi)
void	gameStartsNow(java.lang.String gameId, int port, java.lang.String hostingHost)
void	gameStartsSoon(java.lang.String gameId, java.lang.String startUser)
int	getClientVersion()
void	grantAdminStatus()
void	requestAttention(long when, java.lang.String byUser, boolean byAdmin, java.lang.String message, int beepCount, long beepInterval, boolean windows)
void	systemMessage(long when, java.lang.String message)
void	userInfo(int loggedin, int enrolled, int playing, int dead, long ago, java.lang.String text)
void	watchGameInfo(java.lang.String gameId, java.lang.String host, int port)

Field Detail

alreadyLoggedIn

static final java.lang.String alreadyLoggedIn

See Also:

Constant Field Values

grantAdmin

static final java.lang.String grantAdmin

See Also:

Constant Field Values

tooManyUsers

static final java.lang.String tooManyUsers

See Also:

Constant Field Values

connectionClosed

static final java.lang.String connectionClosed

See Also:

Constant Field Values

forcedLogout

static final java.lang.String forcedLogout

See Also:

Constant Field Values

didEnroll

static final java.lang.String didEnroll

See Also:

Constant Field Values

didUnenroll

static final java.lang.String didUnenroll

See Also:

Constant Field Values

gameInfo

static final java.lang.String gameInfo

See Also:

Constant Field Values

userInfo

static final java.lang.String userInfo

See Also:

Constant Field Values

gameStarted

static final java.lang.String gameStarted

See Also:

Constant Field Values

gameStartsNow

static final java.lang.String gameStartsNow

See Also:

Constant Field Values

gameStartsSoon

static final java.lang.String gameStartsSoon

See Also:

Constant Field Values

gameCancelled

static final java.lang.String gameCancelled

See Also:

Constant Field Values

chatDeliver

static final java.lang.String chatDeliver

See Also:

Constant Field Values

generalMessage

static final java.lang.String generalMessage

See Also:

Constant Field Values

systemMessage

static final java.lang.String systemMessage

See Also:

Constant Field Values

requestAttention

static final java.lang.String requestAttention

See Also:

Constant Field Values

watchGameInfo

static final java.lang.String watchGameInfo

See Also:

Constant Field Values

pingRequest

static final java.lang.String pingRequest

See Also:

Constant Field Values

Method Detail

grantAdminStatus

void grantAdminStatus()

didEnroll

void didEnroll(java.lang.String gameId,
               java.lang.String username)

didUnenroll

void didUnenroll(java.lang.String gameId,
                 java.lang.String username)

userInfo

void userInfo(int loggedin,
              int enrolled,
              int playing,
              int dead,
              long ago,
              java.lang.String text)

gameInfo

void gameInfo(GameInfo gi)

gameStartsNow

void gameStartsNow(java.lang.String gameId,
                   int port,
                   java.lang.String hostingHost)

gameStartsSoon

void gameStartsSoon(java.lang.String gameId,
                    java.lang.String startUser)

gameCancelled

void gameCancelled(java.lang.String gameId,
                   java.lang.String byUser)

chatDeliver

void chatDeliver(java.lang.String chatId,
                 long when,
                 java.lang.String sender,
                 java.lang.String message,
                 boolean resent)

connectionReset

void connectionReset(boolean forcedLogout)

getClientVersion

int getClientVersion()

deliverGeneralMessage

void deliverGeneralMessage(long when,
                           boolean error,
                           java.lang.String title,
                           java.lang.String message)

systemMessage

void systemMessage(long when,
                   java.lang.String message)

requestAttention

void requestAttention(long when,
                      java.lang.String byUser,
                      boolean byAdmin,
                      java.lang.String message,
                      int beepCount,
                      long beepInterval,
                      boolean windows)

watchGameInfo

void watchGameInfo(java.lang.String gameId,
                   java.lang.String host,
                   int port)