Interface IWebServer

All Known Implementing Classes:

WebClientSocketThread, WebServer

public interface IWebServer

Interface for what WebClient sends to WebServer

Author:

Clemens Katzer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Cancel
static final String	ChangePassword
static final String	ChatSubmit
static final String	ConfirmCommand
static final String	ConfirmRegistration
static final String	DumpInfo
static final String	Echo
static final String	Enroll
static final String	generalChatName
static final String	LocallyGameOver
static final String	Login
static final String	Logout
static final String	PingResponse
static final String	Propose
static final String	RegisterUser
static final String	RequestUserAttention
static final String	RereadLoginMessage
static final String	ShutdownServer
static final String	Start
static final String	StartAtPlayer
static final String	StartedByPlayer
static final String	Unenroll
static final String	WatchGame
static final String	WebProtocolSeparator

Method Summary

Modifier and Type	Method	Description
void	cancelGame(String gameId, String byUser)
String	changeProperties(String username, String oldPW, String newPW, String email, Boolean isAdminObj)
void	chatSubmit(String chatId, String sender, String message)
void	dumpInfo()
void	enrollUserToGame(String gameId, String username)
void	informLocallyGameOver(String gameId)
void	informStartedByPlayer(String gameId)
void	logout()
GameInfo	proposeGame(String initiator, String variant, String viewmode, long startAt, int duration, String summary, String expire, boolean unlimMulli, boolean balTowers, int min, int target, int max)
void	requestUserAttention(long when, String sender, boolean isAdmin, String recipient, String message, int beepCount, long beepInterval, boolean windows)
void	rereadLoginMessage()
void	shutdownServer()
void	startGame(String gameId, User user)
void	startGameOnPlayerHost(String gameId, String hostingPlayer, String playerHost, int port)	A game was started by a WebClient user locally on his computer and is ready to accept the other players as remote client; so we notify them and tell them host and port to where to connect.
void	unenrollUserFromGame(String gameId, String username)
void	watchGame(String gameId, String username)

Field Details

Login

static final String Login

See Also:

• Constant Field Values

Logout

static final String Logout

See Also:

• Constant Field Values

RegisterUser

static final String RegisterUser

See Also:

• Constant Field Values

ConfirmRegistration

static final String ConfirmRegistration

See Also:

• Constant Field Values

ChangePassword

static final String ChangePassword

See Also:

• Constant Field Values

Propose

static final String Propose

See Also:

• Constant Field Values

Enroll

static final String Enroll

See Also:

• Constant Field Values

Unenroll

static final String Unenroll

See Also:

• Constant Field Values

Start

static final String Start

See Also:

• Constant Field Values

StartAtPlayer

static final String StartAtPlayer

See Also:

• Constant Field Values

StartedByPlayer

static final String StartedByPlayer

See Also:

• Constant Field Values

LocallyGameOver

static final String LocallyGameOver

See Also:

• Constant Field Values

Cancel

static final String Cancel

See Also:

• Constant Field Values

ChatSubmit

static final String ChatSubmit

See Also:

• Constant Field Values

ShutdownServer

static final String ShutdownServer

See Also:

• Constant Field Values

Echo

static final String Echo

See Also:

• Constant Field Values

RereadLoginMessage

static final String RereadLoginMessage

See Also:

• Constant Field Values

RequestUserAttention

static final String RequestUserAttention

See Also:

• Constant Field Values

PingResponse

static final String PingResponse

See Also:

• Constant Field Values

WatchGame

static final String WatchGame

See Also:

• Constant Field Values

ConfirmCommand

static final String ConfirmCommand

See Also:

• Constant Field Values

DumpInfo

static final String DumpInfo

See Also:

• Constant Field Values

generalChatName

static final String generalChatName

See Also:

• Constant Field Values

WebProtocolSeparator

static final String WebProtocolSeparator

See Also:

• Constant Field Values

Method Details

proposeGame

GameInfo proposeGame(String initiator,
 String variant,
 String viewmode,
 long startAt,
 int duration,
 String summary,
 String expire,
 boolean unlimMulli,
 boolean balTowers,
 int min,
 int target,
 int max)

enrollUserToGame

void enrollUserToGame(String gameId,
 String username)

unenrollUserFromGame

void unenrollUserFromGame(String gameId,
 String username)

cancelGame

void cancelGame(String gameId,
 String byUser)

startGameOnPlayerHost

void startGameOnPlayerHost(String gameId,
 String hostingPlayer,
 String playerHost,
 int port)

A game was started by a WebClient user locally on his computer and is ready to accept the other players as remote client; so we notify them and tell them host and port to where to connect.

startGame

void startGame(String gameId,
 User user)

informStartedByPlayer

void informStartedByPlayer(String gameId)

informLocallyGameOver

void informLocallyGameOver(String gameId)

chatSubmit

void chatSubmit(String chatId,
 String sender,
 String message)

requestUserAttention

void requestUserAttention(long when,
 String sender,
 boolean isAdmin,
 String recipient,
 String message,
 int beepCount,
 long beepInterval,
 boolean windows)

watchGame

void watchGame(String gameId,
 String username)

rereadLoginMessage

void rereadLoginMessage()

shutdownServer

void shutdownServer()

dumpInfo

void dumpInfo()

changeProperties

String changeProperties(String username,
 String oldPW,
 String newPW,
 String email,
 Boolean isAdminObj)

logout

void logout()