Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

SecurePlayLibrary::SPTMultistepTurnClass Class Reference

#include <SPTMultistepTurnClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultistepTurnClass:

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

Detailed Description

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


Public Member Functions

 SPTMultistepTurnClass ()
 ~SPTMultistepTurnClass ()
 SPTMultistepTurnClass (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID)
vector< string > APIgetStepData (int step)
string APIgetStepSource (int step)
bool APIsendStep (string sender, vector< string > dataentry)
bool onsendStep (SPMessageClass *incoming)
bool pronincomingTransaction (SPMessageClass *incoming)
bool APIrequestsendStep (string pid, string sender, vector< string > dataentry)
void onrequestsendStep (SPMessageClass *incoming)
int APIgetStepCount ()
SPTMultistepTurnAPIClass * SPgetAPI ()
vector< vector< string > * > getPrdataList ()
vector< string > getPrdatasourceList ()
SPTMultistepTurnAPIClass * APITAOcreateTransaction (SPGameAPIClass *gapi, string transmaster, vector< string > playerIDList, bool privateflag)
SPAbstractTransactionInterface * createTransaction (SPGameAPIInterface *gameapiobj, string master, vector< string > playerIDList, bool privateflag, string transactionID)

Static Public Member Functions

SPTMultistepTurnClass * APIcreateTransaction (SPGameAPIClass *gapi, string transmaster, vector< string > playerIDList, bool privateflag)
bool APIBcreateTransaction (SPGameAPIClass *gapi, string transmaster, vector< string > playerIDList, bool privateflag)
string gettranstype ()
bool registerTransaction ()

Protected Member Functions

SPAbstractTransactionInterface * buildSPawn ()
bool spawnConfigure (SPAbstractTransactionInterface *a)

Private Attributes

vector< vector< string > * > prdataList
vector< string > prdatasourceList

Constructor & Destructor Documentation

SPTMultistepTurnClass::SPTMultistepTurnClass (   ) 
 

Default Constructor.

SPTMultistepTurnClass::~SPTMultistepTurnClass (   ) 
 

Default Destructor.

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

Overloaded Constructor

Parameters:
gameobj 
master 
playerIDList 
privateflag 
transactionID 

Member Function Documentation

bool SPTMultistepTurnClass::APIBcreateTransaction (  SPGameAPIClass *  gapi,
string  transmaster,
vector< string >  playerIDList,
bool  privateflag
)  [static]
 

This method allows the creation of a new MultiPartSimultaneous type, internally controlled transaction. It also sends a message to the other transaction and game participants about this new transaction.

Parameters:
gapi SPGameAPIInterface - the game that will be associated with this transaction.
transmaster String - player id of the master of the transaction
playerIDList String[] - This is an array that holds the Player IDs of the players within the game that are participating in this transaction.
privateflag boolean - This is a flag to describe whether the specific transaction is a private transaction to the non-participating Players.
Returns:
result - Boolean: TRUE, if successful, FALSE, if not.

SPTMultistepTurnClass * SPTMultistepTurnClass::APIcreateTransaction (  SPGameAPIClass *  gapi,
string  transmaster,
vector< string >  playerIDList,
bool  privateflag
)  [static]
 

This method allows the creation of a new MultiPartSimultaneous type, internally controlled transaction. It also sends a message to the other transaction and game participants about this new transaction.

Parameters:
gapi SPGameAPIInterface - the game that will be associated with this transaction.
transmaster String - player id of the master of the transaction
playerIDList String[] - This is an array that holds the Player IDs of the players within the game that are participating in this transaction.
privateflag boolean - This is a flag to describe whether the specific transaction is a private transaction to the non-participating Players.
Returns:
tran - SPMultiPartSimultaneousClass(but returns the actual object) - if successful, null if not

int SPTMultistepTurnClass::APIgetStepCount (   ) 
 

This method returns the current number of steps that have been sent

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 - vector<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

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

This shell request method remotely requests another player to send a transaction step

Parameters:
pid string - player id, the master
sender Stirng - sender id
dataentry vector<string> - the data of the step
Returns:
result - bool: TRUE, if request successfully sent, FALSE, if not

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 vector<string> - data of the step in a string array
Returns:
result - bool: TRUE, if request successfully sent, FALSE, if not

SPTMultistepTurnAPIClass * SPTMultistepTurnClass::APITAOcreateTransaction (  SPGameAPIClass *  gapi,
string  transmaster,
vector< string >  playerIDList,
bool  privateflag
) 
 

This method allows the creation of a new MultiPartSimultaneous type, internally controlled transaction. It also sends a message to the other transaction and game participants about this new transaction.

Parameters:
gapi SPGameAPIInterface - the game that will be associated with this transaction.
transmaster String - player id of the master of the transaction
playerIDList String[] - This is an array that holds the Player IDs of the players within the game that are participating in this transaction.
privateflag boolean - This is a flag to describe whether the specific transaction is a private transaction to the non-participating Players.
Returns:
tran - SPMultiPartSimultaneousAPIClass - if successful, null if not

SPAbstractTransactionInterface * SPTMultistepTurnClass::buildSPawn (   )  [protected, virtual]
 

This method provides the unique transaction creation services for spawned Multistep transactions

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

SPAbstractTransactionInterface * SPTMultistepTurnClass::createTransaction (  SPGameAPIInterface *  gameapiobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  transactionID
)  [virtual]
 

This method creates a SPMultiPartSimultaneousClass transaction.

Parameters:
gameapiobj SPGameAPIInterface - the game that will be associated with this transaction.
master String - player id of the master of the transaction
playerIDList String[] - This is an array that holds the Player IDs of the players within the game that are participating in this transaction.
privateflag boolean - This is a flag to describe whether the specific transaction is a private transaction to the non-participating Players.
transactionID String - transaction id.

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

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 - vector<string>

string SPTMultistepTurnClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

void SPTMultistepTurnClass::onrequestsendStep (  SPMessageClass *  incoming  ) 
 

This method handles incoming requests for generation of sendStep transactions. Only the specified player will handle the request, subject to the invoked api rules method.

Parameters:
incoming SPMessageClass - incoming message

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 - bool: TRUE, if successfully handled, FALSE, if not

bool SPTMultistepTurnClass::pronincomingTransaction (  SPMessageClass *  incoming  )  [virtual]
 

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

Parameters:
incoming SPMessageClass - incoming message
Returns:
result - bool: TRUE, if successfully handled, FALSE, if not
See also:
SPAbstractTransactionClass#pronincomingTransaction(SPMessageClass incoming)

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultistepTurnClass::registerTransaction (   )  [static]
 

Registers this transaction.

Returns:

bool SPTMultistepTurnClass::spawnConfigure (  SPAbstractTransactionInterface *  a  )  [protected]
 

This method provides the unique transaction configuration services for spawned Multistep transactions

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

SPTMultistepTurnAPIClass * SPTMultistepTurnClass::SPgetAPI (   ) 
 

Gets this class's API

Returns:
classAPI - SPMultistepTurnAPIClass

Member Data Documentation

vector<vector<string>*> SecurePlayLibrary::SPTMultistepTurnClass::prdataList [private]
 

This property holds an array of multistep turns stored in the order that they are received. Each step does count as a Basic Game Transaction Step. Ordering, control, and other features are countrolled by the game rules. This is essentially a sample generic transaction. Creation of new transactions will require coordination with IT GlobalSecure/SecurePlay as specified in the SecurePlay license.

vector<string> SecurePlayLibrary::SPTMultistepTurnClass::prdatasourceList [private]
 

This array holds the sender/source of the multistep turns. Please see the prdataList description for additional details.

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.