ASC_PBEM Class Reference

#include <pbem-server-interaction.h>

Inheritance diagram for ASC_PBEM:


Public Member Functions
	ASC_PBEM (ASCString serverBase)
	default constructor:
	~ASC_PBEM ()
bool	isUsable ()
	important: check this first after instantiation this class will be false after any
bool	login (ASCString user, ASCString passwd)
	Returns: true if login to pbem server procceded ok, false if anything went wrong (most likely wrong user/password, but could also be wrong server base or inactive account
bool	createAccount (ASCString user, ASCString passwd, ASCString email)
	Returns: true if the account could be created false if anything went wrong, which is most likely due to one of these reasons: wrong server username already taken invalid characters for either username or password
bool	activateAccount (ASCString user, ASCString code)
	Returns: true if the account could be activated false if anything went wrong, which is most likely due to one of these reasons: wrong server wrong code
bool	uploadFile (ASCString fileName, const char *data, const int size, const int gameID)
	Returns: true if upload went ok, false on failure
std::vector< TUserData >	getUserList (bool activeOnly=true)
	Returns: a vector of TUserData structs containing the ascpbem server accounts
bool	createGame (ASCString fileName, const char data, const int size, ASCString gameName, ASCString fileNamePattern, char roles, int *players, int projectID=-1, int turn=1, int currentSlot=1)
	Returns: true if game creation went ok, false on failure
std::vector< TGameInfo >	getCurrentGamesInfo (bool myTurnOnly)
	Returns: a vector of TGameInfo structs containing the current games of the logged in player
TFileData *	downloadGame (TGameInfo game)
	Returns: the file data of a ascpbm game, or NULL if not logged in or an error occured
bool	logout ()
	Returns: true if logout went ok, false on failure failure most likely means one of two things: wrong server url not logged in (session timeout?)
bool	isLoggedIn ()
ASCString	getHeader ()
ASCString	getBody ()
int	getStatusCode ()
std::vector< ASCString >	listPlayers ()
Static Public Attributes
static const char	ROLE_SUPERVISOR = 's'
static const char	ROLE_PLAYER = 'p'
static const char	ROLE_HIDDEN = 'h'

Detailed Description

Definition at line 104 of file pbem-server-interaction.h.

Constructor & Destructor Documentation

ASC_PBEM::ASC_PBEM ( ASCString serverBase )

default constructor:

Parameters:

serverBase,:

default url syntax, example: http://localhost:8080/ascServer/ note: currently, the trailing slash is _required_ ??? todo: fix that ;)

Definition at line 150 of file pbem-server-interaction.cpp.

ASC_PBEM::~ASC_PBEM ( )

Definition at line 180 of file pbem-server-interaction.cpp.

Member Function Documentation

bool ASC_PBEM::isUsable ( )

important: check this first after instantiation this class will be false after any

See also:: request where anything went wrong if false, no request will be send out again, and this instance is basically done for

Definition at line 185 of file pbem-server-interaction.cpp.

Referenced by nmain().

bool ASC_PBEM::login	(	ASCString	user,
		ASCString	passwd
	)

Returns:: true if login to pbem server procceded ok, false if anything went wrong (most likely wrong user/password, but could also be wrong server base or inactive account

Definition at line 381 of file pbem-server-interaction.cpp.

Referenced by PBEMServer::getSession(), and nmain().

bool ASC_PBEM::createAccount	(	ASCString	user,
		ASCString	passwd,
		ASCString	email
	)

Returns:

true if the account could be created false if anything went wrong, which is most likely due to one of these reasons:

wrong server
username already taken
invalid characters for either username or password

Definition at line 398 of file pbem-server-interaction.cpp.

bool ASC_PBEM::activateAccount	(	ASCString	user,
		ASCString	code
	)

Returns:

true if the account could be activated false if anything went wrong, which is most likely due to one of these reasons:

wrong server
wrong code

Definition at line 417 of file pbem-server-interaction.cpp.

bool ASC_PBEM::uploadFile	(	ASCString	fileName,
		const char *	data,
		const int	size,
		const int	gameID
	)

Returns:: true if upload went ok, false on failure

Definition at line 432 of file pbem-server-interaction.cpp.

References ASC_PBEM_FileUploadControl::boundary, ASC_PBEM_FileUploadControl::fileName, ASC_PBEM_FileUploadControl::parameters, ASC_PBEM_FileUploadControl::sent_step, and ASC_PBEM_FileUploadControl::step.

std::vector< TUserData > ASC_PBEM::getUserList ( bool activeOnly = true )

Returns:: a vector of TUserData structs containing the ascpbem server accounts

Parameters:

activeOnly

if true, only return data about active (activated) players

Definition at line 555 of file pbem-server-interaction.cpp.

References getBody(), and line().

Referenced by listPlayers().

bool ASC_PBEM::createGame	(	ASCString	fileName,
		const char *	data,
		const int	size,
		ASCString	gameName,
		ASCString	fileNamePattern,
		char *	roles,
		int *	players,
		int	projectID = `-1`,
		int	turn = `1`,
		int	currentSlot = `1`
	)