SecurePlayLibrary::SPTMultistepTurnAPIClass Class Reference

#include <SPTMultistepTurnAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultistepTurnAPIClass:

List of all members.

---

Detailed Description

API version of SPMultistepturnClass

Author:

IT GlobalSecure

See also:

SecurePlay License Information

Public Member Functions
	SPTMultistepTurnAPIClass ()
	~SPTMultistepTurnAPIClass ()
	SPTMultistepTurnAPIClass (SPTMultistepTurnClass *multi)
vector< string >	APIgetStepData (int step)
string	APIgetStepSource (int step)
bool	APIrequestsendStep (string pid, string sender, vector< string > dataentry)
bool	APIsendStep (string sender, vector< string > dataentry)
int	APIgetStepCount ()
bool	rulessendStep (string pid, string sender, vector< string > body, SPTMultistepTurnClass *transobj)
Private Attributes
SPTMultistepTurnClass *	traninst
bool	librarytestmode

---

Constructor & Destructor Documentation

SPTMultistepTurnAPIClass::SPTMultistepTurnAPIClass (   )

Default Constrcutor

SPTMultistepTurnAPIClass::~SPTMultistepTurnAPIClass (   )

Default Destrcutor

SPTMultistepTurnAPIClass::SPTMultistepTurnAPIClass (  SPTMultistepTurnClass *  multi  )

Overloaded Constructor Parameters: multi  SPMultistepTurnClass - multistep turn class

---

Member Function Documentation

int SPTMultistepTurnAPIClass::APIgetStepCount (   )

This method returns the current number of steps that have been sent Returns: stepcount - int - number of steps

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

bool SPTMultistepTurnAPIClass::rulessendStep (  string  pid, string  sender, vector< string >  body, SPTMultistepTurnClass *  transobj )

This shell method handles remote requests to send a transaction step for the Multistep transaction. It is principally used for remote debugging purposes. Parameters: pid  string - player id, master sender  string - player id, sender body  vector<string> - body of the step as a string array transobj  SPMultistepTurnClass - the multustep transaction Returns: result - bool: TRUE if allowed or FALSE, if not permitted

---

Member Data Documentation

bool SecurePlayLibrary::SPTMultistepTurnAPIClass::librarytestmode [private]

This should be set to FALSE for production systems or all "rulesXXXX methods should be edited Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

SPTMultistepTurnClass* SecurePlayLibrary::SPTMultistepTurnAPIClass::traninst [private]

instance of SPMultistepTurnClass

---

The documentation for this class was generated from the following files:

• SPTMultistepTurnAPIClass.h
• SPTMultistepTurnAPIClass.cpp

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.