2006 Copyright Filed by IT GlobalSecure, Inc. All Rights Reserved. Not to be used without authorization by Author. SecurePlay, IT GlobalSecure, and IT Armor are registered trademarks by IT GlobalSecure, Inc. Software protected by software license, and one or more the following U.S. and International patent numbers: U.S. Patent 6,030,288, U.S. Patent 6,165,072, European Patent Office EP1016049A1,and World Intellectual Property Organization WO9912135C1 and additional filings worldwide.
Main Page | Class Hierarchy | Class List | Class Members

SecurePlayLibrary::SPTMultistepTurnClass Class Reference

#include <SPTMultistepTurnClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultistepTurnClass:

SecurePlayLibrary::SPAbstractTransactionClass SecurePlayLibrary::SPRootTransactionClass SecurePlayLibrary::SPAbstractTransactionInterface List of all members.

Public Member Functions

 SPTMultistepTurnClass ()
 SPTMultistepTurnClass (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID, string AGE, vector< string > configarr)
vector< string > APIgetStepData (int step)
string APIgetStepSource (int step)
bool APIsendStep (string sender, vector< string > dataentry)
bool onsendStep (SPMessageClass *incoming)
bool pronincomingTransaction (SPMessageClass *incoming)
int APIgetStepCount ()
vector< vector< string > * > getPrdataList ()
vector< string > getPrdatasourceList ()
SPAbstractTransactionInterface * APIcreateTransaction (SPGameInterface *gameapiobj, SPMessageClass *message)
string APIgetTransactionType ()

Static Public Member Functions

string gettranstype ()
bool registerTransaction ()
SPAbstractTransactionInterface * createMultiStep (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string AGE, vector< string > configarr)

Detailed Description

This is implements the multistep transaction. See details under Abstract Transaction Class
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPTMultistepTurnClass::SPTMultistepTurnClass (   ) 
 

Default Constructor

SPTMultistepTurnClass::SPTMultistepTurnClass (  SPGameInterface *  gameobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  transactionID,
string  AGE,
vector< string >  configarr
) 
 

Overloaded Constructor

Parameters:
gameobj 
master 
playerIDList 
privateflag 
transactionID 

Member Function Documentation

SPAbstractTransactionInterface * SPTMultistepTurnClass::APIcreateTransaction (  SPGameInterface *  gameapiobj,
SPMessageClass *  message
)  [virtual]
 

Creates a new instance of an SPTMultiStepTurnClass class.

Parameters:
gameapiobj SPGameInterface - game associated with this transaction.
message SPMessageClass - message that has all the transaction configure info
Returns:
SPAbstractTransactionInterface

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

int SPTMultistepTurnClass::APIgetStepCount (   ) 
 

This method returns the current number of steps that have been sent. If it fails, it will return -1.

Returns:
stepcount - int - number of steps

vector< string > SPTMultistepTurnClass::APIgetStepData (  int  step  ) 
 

This method returns the dataList entry associated with the specified step value

Parameters:
step int - steps
Returns:
result - String[] - step data in a String array of a specified step

string SPTMultistepTurnClass::APIgetStepSource (  int  step  ) 
 

This method returns the PlayerID of the sender of a specific transaction step.

Parameters:
step int - the step
Returns:
result - String - PlayerID of sender of a specified step

string SPTMultistepTurnClass::APIgetTransactionType (   )  [virtual]
 

This method returns a String of the transactiontype.

Returns:
this.transtype - String - name of transaction type

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultistepTurnClass::APIsendStep (  string  sender,
vector< string >  dataentry
) 
 

This method sends a transaction step to the other transaction participants. This is a generic transaction step with no special processing. Any participant in a transaction can send such a step.

Parameters:
sender String - id of the sender
dataentry String[] - data of the step in a String array
Returns:
result - Boolean: TRUE, if request successfully sent, FALSE, if not

SPAbstractTransactionInterface * SPTMultistepTurnClass::createMultiStep (  SPGameInterface *  gameobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  AGE,
vector< string >  configarr
)  [static]
 

This method creates a SPTMultiStepTurnClass transaction.

Parameters:
gameobj 
master 
playerIDList 
privateflag 
AGE 
configarr 
Returns:
SPAbstractTransactionInterface - returns Multistep class created

vector< vector< string > * > SPTMultistepTurnClass::getPrdataList (   ) 
 

Getter function that returns the property: prdataList

Returns:
prdataList - List

vector< string > SPTMultistepTurnClass::getPrdatasourceList (   ) 
 

Getter function that returns the property: prdatasourceList

Returns:
prdatasourceList - String[]

string SPTMultistepTurnClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultistepTurnClass::onsendStep (  SPMessageClass *  incoming  ) 
 

This method handles incoming sendStep requests. It processes them to ensure they are valid and ensures that the information is stored appropriately.

Parameters:
incoming SPMessageClass - incoming message
Returns:
result - Boolean: TRUE, if successfully handled, FALSE, if not

bool SPTMultistepTurnClass::pronincomingTransaction (  SPMessageClass *  incoming  ) 
 

This method provides the unique handlers for incoming Multistep turn message types

Parameters:
incoming SPMessageClass - incoming message
Returns:
result - Boolean: TRUE, if successfully handled, FALSE, if not

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultistepTurnClass::registerTransaction (   )  [static]
 

Registers this transaction.

Returns:
boolean

The documentation for this class was generated from the following files: 2006 Copyright Filed by IT GlobalSecure, Inc. All Rights Reserved. Not to be used without authorization by Author. SecurePlay, IT GlobalSecure, and IT Armor are registered trademarks by IT GlobalSecure, Inc. Software protected by software license, and one or more the following U.S. and International patent numbers: U.S. Patent 6,030,288, U.S. Patent 6,165,072, European Patent Office EP1016049A1,and World Intellectual Property Organization WO9912135C1 and additional filings worldwide.