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

SecurePlayLibrary::SPTMultiPartSimultaneousAPIClass Class Reference

#include <SPTMultiPartSimultaneousAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultiPartSimultaneousAPIClass:

SecurePlayLibrary::SPAbstractTransactionAPIClass SecurePlayLibrary::SPAbstractTransactionAPIInterface List of all members.

Detailed Description

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


Public Member Functions

 SPTMultiPartSimultaneousAPIClass ()
 ~SPTMultiPartSimultaneousAPIClass ()
 SPTMultiPartSimultaneousAPIClass (SPTMultiPartSimultaneousClass *simultinstance)
vector< string > APIgetSecret (string sender)
bool APIrequestsendHiddenSecret (string pid, string sender, vector< string > newsecret)
bool APIsendHiddenSecret (string sender, vector< string > newsecret)
bool APIverifySimultaneous ()
bool rulesSimultaneoussendHiddenSecret (string pid, string sender, vector< string > body, SPTMultiPartSimultaneousClass *transobj)

Private Attributes

SPTMultiPartSimultaneousClasstraninst
const bool librarytestmode


Constructor & Destructor Documentation

SPTMultiPartSimultaneousAPIClass::SPTMultiPartSimultaneousAPIClass  ) 
 

Default Constrcutor

SPTMultiPartSimultaneousAPIClass::~SPTMultiPartSimultaneousAPIClass  ) 
 

Default Destrcutor

SPTMultiPartSimultaneousAPIClass::SPTMultiPartSimultaneousAPIClass SPTMultiPartSimultaneousClass simultinstance  ) 
 

Overloaded Constructor

Parameters:
simultinstance SPMultiPartSimultaneousClass - the class to be associated with this this API


Member Function Documentation

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

bool SPTMultiPartSimultaneousAPIClass::APIrequestsendHiddenSecret string  pid,
string  sender,
vector< string >  newsecret
 

This method allows any party to request the specified transaction participant send a Secret to support the simultaneous transaction. It is mainly used for remote debugging purposes.

Parameters:
pid String - player id, or the master of the transaction
sender String - sender, or the requestor, can not be master
newsecret String - the secret
Returns:
result - bool: TRUE, if request successfully sent, FALSE, if not

bool SPTMultiPartSimultaneousAPIClass::APIsendHiddenSecret string  sender,
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
newsecret String - the secret
Returns:
result - bool: TRUE, if successful, FALSE, if not

bool SPTMultiPartSimultaneousAPIClass::APIverifySimultaneous  ) 
 

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

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

bool SPTMultiPartSimultaneousAPIClass::rulesSimultaneoussendHiddenSecret string  pid,
string  sender,
vector< string >  body,
SPTMultiPartSimultaneousClass transobj
 

This shell method handles requests to create sendHiddenSecret messages for simultaneous transactions. It is mainly used for remote debugging purposes.

Parameters:
pid String - player id, or the master of the transaction
sender String - sender, or the requestor, can not be master
body Strin[] - body of the secret
transobj SPMultiPartSimultaneousClass - transaction object
Returns:
result - bool: TRUE, if request successfully sent, FALSE, if not


Member Data Documentation

const bool SecurePlayLibrary::SPTMultiPartSimultaneousAPIClass::librarytestmode [private]
 

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

SPTMultiPartSimultaneousClass* SecurePlayLibrary::SPTMultiPartSimultaneousAPIClass::traninst [private]
 

the transaction instance


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.