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::SPTSimultaneousClass Class Reference

#include <SPTSimultaneousClass.h>

Inheritance diagram for SecurePlayLibrary::SPTSimultaneousClass:

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

Public Member Functions

 SPTSimultaneousClass ()
 SPTSimultaneousClass (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID, string AGE, vector< string > configarr)
void pruniqueinit ()
bool APIsendHiddenSecret (string sender, bool manflag, string newsecret)
bool APIrevealSecret (string sender)
bool APIverifySimultaneous ()
string APIgetSecret (string sender)
bool pronincomingTransaction (SPMessageClass *incoming)
int getPrpadlength ()
SPMap< string, string > getSecret ()
SPMap< string, string > getSecretpadded ()
SPMap< string, string > getSecrettransform ()
SPAbstractTransactionInterface * APIcreateTransaction (SPGameInterface *gameapiobj, SPMessageClass *message)
string APIgetTransactionType ()

Static Public Member Functions

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

Static Protected Attributes

const string status_allsent = "allsent"
const string status_allreceived = "allreceived"
const string status_secretsent = "secretsent"
const string status_secretrevealed = "secretrevealed"
const string status_secretrevealedlist = "secretrevealedlist"

Detailed Description

The simultaneous transaction allows its participants to send "Simultaneous Secrets" to each other and reveal them at the same time.
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPTSimultaneousClass::SPTSimultaneousClass (   ) 
 

Default Constructor

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

Overloaded Constructor

Parameters:
gameobj SPGameInterface - the game object with which the transaction is associated
master String - the master of the transaction
playerIDList String[] - player id list of players who are associated with the transaction
privateflag boolean - private flag
transactionID String - the transaction id

Member Function Documentation

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

Creates a new instance of an SPTSimultaneousClass class.

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

string SPTSimultaneousClass::APIgetSecret (  string  sender  ) 
 

This method returns the actual secret for the specified player that this transaction is protecting, if available.

Parameters:
sender String - sender of the secret
Returns:
secret - String - the secret

string SPTSimultaneousClass::APIgetTransactionType (   )  [virtual]
 

This method returns a String of the transactiontype.

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTSimultaneousClass::APIrevealSecret (  string  sender  ) 
 

This method sends the secretpadded value to the specified remote players.

Parameters:
sender String - the sender of the secret
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

bool SPTSimultaneousClass::APIsendHiddenSecret (  string  sender,
bool  manflag,
string  newsecret
) 
 

This method allows the specified transaction participant to send the transform of a secret to the other participants in the Simultaneous transaction.

Parameters:
sender String - sender of the secret
manflag - boolean - manual reveal of secret
newsecret String - the secret
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

bool SPTSimultaneousClass::APIverifySimultaneous (   ) 
 

This method verifies whether a Simultaneous transaction was carried out successfully and responds with a simple Boolean.

Returns:
result - Boolean: TRUE, if transaction verified, FALSE, if not.

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

This method creates a SPTSimultaneousClass transaction.

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

int SPTSimultaneousClass::getPrpadlength (   ) 
 

Getter function that returns the property: prpadlength

Returns:
prpadlength - int

SPMap< string, string > SPTSimultaneousClass::getSecret (   ) 
 

Getter function that returns the property: secret

Returns:
secret - SPHashtable

SPMap< string, string > SPTSimultaneousClass::getSecretpadded (   ) 
 

Getter function that returns the property: secretpadded

Returns:
secretpadded - SPHashtable

SPMap< string, string > SPTSimultaneousClass::getSecrettransform (   ) 
 

Getter function that returns the property: secrettransform

Returns:
secrettransform - SPHashtable

string SPTSimultaneousClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTSimultaneousClass::pronincomingTransaction (  SPMessageClass *  incoming  ) 
 

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

Parameters:
incoming SPMessageClass - incoming message
Returns:
Boolean - TRUE if successful, FALSE, if unsuccessful

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

void SPTSimultaneousClass::pruniqueinit (   ) 
 

Unique initialization ( an addition to the constructor )

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTSimultaneousClass::registerTransaction (   )  [static]
 

Registers this transaction.

Returns:
boolean

Member Data Documentation

const string SPTSimultaneousClass::status_allreceived = "allreceived" [static, protected]
 

transaction status ready variable

const string SPTSimultaneousClass::status_allsent = "allsent" [static, protected]
 

transaction status ready variable

const string SPTSimultaneousClass::status_secretrevealed = "secretrevealed" [static, protected]
 

transaction status complete variable

const string SPTSimultaneousClass::status_secretrevealedlist = "secretrevealedlist" [static, protected]
 

transaction status error variable

const string SPTSimultaneousClass::status_secretsent = "secretsent" [static, protected]
 

transaction status ready variable

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.