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

SecurePlayLibrary::SPAbstractTransactionAPIClass Class Reference

#include <SPAbstractTransactionAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPAbstractTransactionAPIClass:

SecurePlayLibrary::SPAbstractTransactionAPIInterface SecurePlayLibrary::SPTBlastAPIClass SecurePlayLibrary::SPTMultiPartSecretAPIClass SecurePlayLibrary::SPTMultiPartSimultaneousAPIClass SecurePlayLibrary::SPTMultistepTurnAPIClass SecurePlayLibrary::SPTRandomAPIClass SecurePlayLibrary::SPTSecretAPIClass SecurePlayLibrary::SPTSimultaneousAPIClass SecurePlayLibrary::SPTStrobeAPIClass List of all members.

Detailed Description

API version of the SPAbstractTransactionClass
Author:
IT GlobalSecure
See also:
com.SecurePlay.core.SPAbstractTransactionClass

SecurePlay License Information


Public Member Functions

 SPAbstractTransactionAPIClass ()
 ~SPAbstractTransactionAPIClass ()
 SPAbstractTransactionAPIClass (SPAbstractTransactionClass *abstractTransInstance)
bool APIbeginTransaction (string pid)
bool APIcompleteTransaction (string pid)
bool APIconfigureTransaction (string pid, vector< string > args)
bool APIrequestbeginTransaction (string pid)
bool APIrequestCompleteTransaction (string pid)
bool APIrequestconfigureTransaction (string pid, vector< string > args)
bool rulesbeginTransaction (string pid, SPAbstractTransactionInterface *transobj)
bool rulescompleteTransaction (string pid, SPAbstractTransactionInterface *transobj)
bool rulesconfigureTransaction (string pid, vector< string > configarr, SPAbstractTransactionInterface *transobj)
bool APIAddListener (SPEventInterface *gameobj)
bool APIRemoveListener (SPEventInterface *gameobj)
vector< SPEventInterface * > APIGetListeners ()
bool APIClearListeners ()
int APIGetListenerCount ()
string APISPawn (string pid)
SPAbstractTransactionInterface * getTransactioninstance ()
string SPAbstractTransactionAPIClass::APIgetGameBlock ()
bool SPAbstractTransactionAPIClass::APIsetGameBlock (string pid, string newgameblock)

Public Attributes

const string extendedversion
const string releaseversion

Protected Attributes

SPAbstractTransactionClass * transactioninstance
const bool librarytestmode

Private Member Functions

 SPAbstractTransactionAPIClass (const SPAbstractTransactionAPIClass &p)
 operator= (const SPAbstractTransactionAPIClass &p)

Constructor & Destructor Documentation

SecurePlayLibrary::SPAbstractTransactionAPIClass::SPAbstractTransactionAPIClass (  const SPAbstractTransactionAPIClass &  p  )  [inline, private]
 

Private Copy Constructor that protects this class from being copied.

SPAbstractTransactionAPIClass::SPAbstractTransactionAPIClass (   ) 
 

Default Constructor

SPAbstractTransactionAPIClass::~SPAbstractTransactionAPIClass (   ) 
 

Default Destructor

SPAbstractTransactionAPIClass::SPAbstractTransactionAPIClass (  SPAbstractTransactionClass *  abstractTransInstance  ) 
 

Overloaded Constructor

Parameters:
abstractTransInstance SPAbstractTransactionClass* - the abstract transaction instance

Member Function Documentation

bool SPAbstractTransactionAPIClass::APIAddListener (  SPEventInterface *  gameobj  )  [virtual]
 

This method adds a listener object for Game API events

Parameters:
gameobj SPEventInterface* - the object to be added, that inplement the listener interface
Returns:
bool - TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

bool SPAbstractTransactionAPIClass::APIbeginTransaction (  string  pid  )  [virtual]
 

This action can only be initiated by the Transaction master. It sends a "beginTransaction" message to all of the transaction participants. A Transaction can only be begun if it has been successfully configured.

Parameters:
pid string - id of the transaction beginner, must be the master and internal.
Returns:
bool: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass.

bool SPAbstractTransactionAPIClass::APIClearListeners (   )  [virtual]
 

This method clears the listener objects for Game API events

Returns:
bool - TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

bool SPAbstractTransactionAPIClass::APIcompleteTransaction (  string  pid  )  [virtual]
 

This method allows the Transaction Master ONLY to complete the transaction. Transactions that are in an error state cannot be cleared by completion.

Parameters:
pid string - id of the player who is completing the transaction, must be the master and internal.
Returns:
bool: TRUE, if successful, FALSE, if not.

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass, and SecurePlayLibrary::SPTRandomAPIClass.

bool SPAbstractTransactionAPIClass::APIconfigureTransaction (  string  pid,
vector< string >  args
)  [virtual]
 

This method allows the Transaction Master ONLY to configure the transactions unique parameters. NOTE, this method will be overridden for individual transaction types.

Parameters:
pid string - id of the configurer, must be internal.
args vector<string> - the configuration array, with configuration details inside.
Returns:
bool: TRUE if successful, FALSE, if unsuccessful

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass, and SecurePlayLibrary::SPTRandomAPIClass.

int SPAbstractTransactionAPIClass::APIGetListenerCount (   )  [virtual]
 

This method returns the number of listener objects for Game API events

Returns:
int - the number of listeners

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

vector< SPEventInterface * > SPAbstractTransactionAPIClass::APIGetListeners (   )  [virtual]
 

This method returns a list of listener objects for Game API events

Returns:
vector<SPEventInterface*> - array of listener objects

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

bool SPAbstractTransactionAPIClass::APIRemoveListener (  SPEventInterface *  gameobj  )  [virtual]
 

This method removes a listener object for Game API events

Parameters:
gameobj SPEventInterface* - the object to be removed, that inplement the listener interface

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

bool SPAbstractTransactionAPIClass::APIrequestbeginTransaction (  string  pid  )  [virtual]
 

This method allows any transaction participant excluding the Transaction master to request that the transaction be begun. This can only be done after the transaction has been configured.

Parameters:
pid string - the id of the requestor, can not be master, must be internal
Returns:
bool: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass.

bool SPAbstractTransactionAPIClass::APIrequestCompleteTransaction (  string  pid  )  [virtual]
 

This method allows any player, excluding the Transaction master to request that the transactoin be completed.

Parameters:
pid string - id of the requestor, can not be the master, must be internal.
Returns:
bool: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass.

bool SPAbstractTransactionAPIClass::APIrequestconfigureTransaction (  string  pid,
vector< string >  args
)  [virtual]
 

This method allows any player, excluding the Transaction master, to request that the transaction be configured as described in the configuration array.

Parameters:
pid string - the configure requestor, can not be the master, must be internal.
args vector<string> - the configuration array, with configuration details.
Returns:
bool: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass.

string SPAbstractTransactionAPIClass::APISPawn (  string  pid  )  [virtual]
 

This method creates a new transaction with the identical participants and configuration as the spawning transaction.

Parameters:
pid string - player id must be master of the transaction
Returns:
string - transaction id of the new spawned transaction.

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

SPAbstractTransactionInterface * SPAbstractTransactionAPIClass::getTransactioninstance (   )  [virtual]
 

Getter function that gets the transaction instance

Returns:
SPAbstractTransactionInterface* - transaction instance

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

SecurePlayLibrary::SPAbstractTransactionAPIClass::operator= (  const SPAbstractTransactionAPIClass &  p  )  [inline, private]
 

Private = operator that protects this class from being copied.

bool SPAbstractTransactionAPIClass::rulesbeginTransaction (  string  pid,
SPAbstractTransactionInterface *  transobj
)  [virtual]
 

This shell method determines if an existing transaction object can be "begun" from a remote request.

Parameters:
pid string - player id of the transaction beginner
transobj SPAbstractTransactionInterface* - the transaction object to be begun
Returns:
bool: TRUE, if allowed, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

bool SPAbstractTransactionAPIClass::rulescompleteTransaction (  string  pid,
SPAbstractTransactionInterface *  transobj
)  [virtual]
 

This shell method handles remote requests to complete an existing transaction. Only the transaction master can actually complete the transaction.

Parameters:
pid string - player id of the completer of the transaction
transobj SPAbstractTransactionInterface - the transaction object to be completed
Returns:
result - bool: TRUE, if allowed, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

bool SPAbstractTransactionAPIClass::rulesconfigureTransaction (  string  pid,
vector< string >  configarr,
SPAbstractTransactionInterface *  transobj
)  [virtual]
 

This shell method supports remote requests to configure an existing transaction. Only the transaction master can actually configure the transaction.

Parameters:
pid string - player id of the configurer, must be the master
configarr vector<string> - the configuration array with the configuration details.
transobj SPAbstractTransactionInterface* - the transaction to be configured
Returns:
bool: TRUE, if allowed, FALSE, if not

Implements SecurePlayLibrary::SPAbstractTransactionAPIInterface.

Reimplemented in SecurePlayLibrary::SPTRandomAPIClass.

string SecurePlayLibrary::SPAbstractTransactionAPIClass::SPAbstractTransactionAPIClass::APIgetGameBlock (   ) 
 

Getter function that gets the gameblock

Returns:
string - gameblock

bool SecurePlayLibrary::SPAbstractTransactionAPIClass::SPAbstractTransactionAPIClass::APIsetGameBlock (  string  pid,
string  newgameblock
) 
 

This method allows the Transaction Master ONLY to set the game block.

Parameters:
pid string - id of the player attempting to set the game block, must be internal.
newgameblock string - the game block for this transaction.
Returns:
bool: TRUE if successful, FALSE, if unsuccessful

Member Data Documentation

const string SecurePlayLibrary::SPAbstractTransactionAPIClass::extendedversion
 

Developer extended version.

const bool SecurePlayLibrary::SPAbstractTransactionAPIClass::librarytestmode [protected]
 

This should be set to FALSE for production systems or all "rulesXXXX methods should be edited

Reimplemented in SecurePlayLibrary::SPTBlastAPIClass, SecurePlayLibrary::SPTMultiPartSecretAPIClass, SecurePlayLibrary::SPTMultiPartSimultaneousAPIClass, SecurePlayLibrary::SPTMultistepTurnAPIClass, SecurePlayLibrary::SPTRandomAPIClass, SecurePlayLibrary::SPTSecretAPIClass, SecurePlayLibrary::SPTSimultaneousAPIClass, and SecurePlayLibrary::SPTStrobeAPIClass.

const string SecurePlayLibrary::SPAbstractTransactionAPIClass::releaseversion
 

IT GlobalSecure release version.

SPAbstractTransactionClass* SecurePlayLibrary::SPAbstractTransactionAPIClass::transactioninstance [protected]
 

Instance of void

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.