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

#include <SPTMultiPartSimultaneousClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultiPartSimultaneousClass:

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

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

void pruniqueinit ()

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

This method is an extension of the SPSimultaneous Class to handle multi-part (String Array) simultaneous events
Author:
IT GlobalSecure Inc.
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPTMultiPartSimultaneousClass::SPTMultiPartSimultaneousClass (   ) 
 

Default Constructor

SPTMultiPartSimultaneousClass::SPTMultiPartSimultaneousClass (  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 * SPTMultiPartSimultaneousClass::APIcreateTransaction (  SPGameInterface *  gameapiobj,
SPMessageClass *  message
)  [virtual]
 

Creates a new instance of an SPTSimultaneousClass class.

Parameters:
gameapiobj SPGameInterface - game associated with this transaction.
message SPMessageClass - incoming message

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

vector< string > SPTMultiPartSimultaneousClass::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 SPTMultiPartSimultaneousClass::APIgetTransactionType (   )  [virtual]
 

This method returns a String of the transactiontype.

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

Reimplemented in SecurePlayLibrary::SPTSynchronizedRandomClass.

bool SPTMultiPartSimultaneousClass::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 SPTMultiPartSimultaneousClass::APIsendHiddenSecret (  string  sender,
bool  manflag,
vector< 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

Reimplemented in SecurePlayLibrary::SPTSynchronizedRandomClass.

bool SPTMultiPartSimultaneousClass::APIverifySimultaneous (   ) 
 

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

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

SPAbstractTransactionInterface * SPTMultiPartSimultaneousClass::createMultiPartSimultaneous (  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 MultiPartSimultaneous class created

int SPTMultiPartSimultaneousClass::getPrpadlength (   ) 
 

Getter function that returns the property: prpadlength

Returns:
prpadlength - int

SPMap< string, vector< string > * > SPTMultiPartSimultaneousClass::getSecret (   ) 
 

Getter function that returns the property: secret

Returns:
secret - SPHashtable

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

Getter function that returns the property: secrettransform

Returns:
secrettransform - SPHashtable

string SPTMultiPartSimultaneousClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

Reimplemented in SecurePlayLibrary::SPTSynchronizedRandomClass.

bool SPTMultiPartSimultaneousClass::onrevealSecret (  SPMessageClass *  incoming  ) 
 

This method handles the incoming message to reveal a secret. The message can come from any participant in the transaction and should include the secretpadded as its sole content. Once all of the secrettransforms have been received, this method will trigger the sending of all local secrets via the prsendInternalSecrets method.

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

bool SPTMultiPartSimultaneousClass::onsendHiddenSecret (  SPMessageClass *  incoming  ) 
 

This method handles incoming sendHiddenSecret messages. These messages include the secrettransform and can sent by any transaction participant.

Parameters:
incoming SPMessageClass - the message to be sent.
Returns:
result - Boolean: TRUE, if successfully handled, FALSE, if not

bool SPTMultiPartSimultaneousClass::pronincomingTransaction (  SPMessageClass *  incoming  ) 
 

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

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

void SPTMultiPartSimultaneousClass::pruniqueinit (   )  [protected]
 

Unique initialization

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultiPartSimultaneousClass::registerTransaction (   )  [static]
 

Registers this transaction.

Returns:
boolean

Reimplemented in SecurePlayLibrary::SPTSynchronizedRandomClass.

Member Data Documentation

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

transaction status ready variable

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

transaction status ready variable

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

transaction status complete variable

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

transaction status error variable

const string SPTMultiPartSimultaneousClass::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.