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

#include <SPTMultiPartSecretClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultiPartSecretClass:

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

Public Member Functions

 SPTMultiPartSecretClass (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID, string AGE, string transform)
bool APIrevealSecret (string sender, vector< string > recievers, bool listflag)
bool APIverifySecret ()
vector< string > APIgetSecret ()
bool onrevealSecret (SPMessageClass *incoming)
int getPrpadlength ()
string getSecretpadding ()
string getSecrettransform ()
SPAbstractTransactionInterface * APIcreateTransaction (SPGameInterface *gameapiobj, SPMessageClass *message)
string APIgetTransactionType ()
string setSecretTransform ()

Static Public Member Functions

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

Protected Member Functions

bool pronincomingTransaction (SPMessageClass *incoming)

Static Protected Attributes

const string status_secretsent = "secretsent"
const string status_secretrevealed = "secretrevealed"
const string status_secretrevealedlist = "secretrevealedlist"

Detailed Description

This method is an extension of the SPSecret Class to handle multi-part (String Array) secrets
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

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

Overloaded Constructor

Parameters:
gameobj SPGameInterface - the game object to which this transaction will be associated with
master String - the master of this transaction
playerIDList String[] - players who will be associated with this transaction
privateflag boolean - private flag of this transaction
transactionID String - the id of this transaction

Member Function Documentation

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

Creates a new instance of an SPMutliPartSecretClass class.

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

vector< string > SPTMultiPartSecretClass::APIgetSecret (   ) 
 

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

Returns:
result - String - the secret

string SPTMultiPartSecretClass::APIgetTransactionType (   )  [virtual]
 

This method returns a String of the transactiontype.

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultiPartSecretClass::APIrevealSecret (  string  sender,
vector< string >  recievers,
bool  listflag
) 
 

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

Parameters:
sender String - the sender of the secret
recievers String[] - player ids of recievers
listflag boolean - if using list parameter TRUE, if all transaction members, FALSE
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

bool SPTMultiPartSecretClass::APIverifySecret (   ) 
 

This method verifies the paddedsecret that was sent. It computes the transform of the paddedsecret that has been sent and compares it with the previously sent secrettransform. It returns a Boolean flag to indicate success or failure.

Returns:
result - Boolean: TRUE, if able to verify secret, FALSE, if not

SPAbstractTransactionInterface * SPTMultiPartSecretClass::createMultiPartSecret (  SPGameInterface *  gameobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  AGE,
vector< string >  newsecret
)  [static]
 

This method creates a SPMutliPartSecretClass transaction.

Parameters:
gameobj 
master 
playerIDList 
privateflag 
AGE 
newsecret 
Returns:
SPAbstractTransactionInterface - returns MultiPartSecret transaction created.

int SPTMultiPartSecretClass::getPrpadlength (   ) 
 

Getter function that returns the property: prpadlength

Returns:
prpadlength - int

string SPTMultiPartSecretClass::getSecretpadding (   ) 
 

Getter function that returns the property: secretpadding

Returns:
secretpadding - String

string SPTMultiPartSecretClass::getSecrettransform (   ) 
 

Getter function that returns the property: secrettransform

Returns:
secrettransform - String

string SPTMultiPartSecretClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultiPartSecretClass::onrevealSecret (  SPMessageClass *  incoming  ) 
 

This method handles the incoming message to reveal a secret. The message should only come from the Transaction master and should include the secretpadded as its sole content.

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

bool SPTMultiPartSecretClass::pronincomingTransaction (  SPMessageClass *  incoming  )  [protected]
 

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

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTMultiPartSecretClass::registerTransaction (   )  [static]
 

Registers this transaction.

Returns:
boolean

string SPTMultiPartSecretClass::setSecretTransform (   ) 
 

Member Data Documentation

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

transaction status complete variable

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

transaction status error variable

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