SecurePlayLibrary::SPTSimultaneousAPIClass Class Reference

#include <SPTSimultaneousAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTSimultaneousAPIClass:

List of all members.

---

Detailed Description

API version of SPSimultaneusClass

Author:

IT GlobalSecure

See also:

SecurePlay License Information

Public Member Functions
	~SPTSimultaneousAPIClass ()
	SPTSimultaneousAPIClass ()
	SPTSimultaneousAPIClass (SPTSimultaneousClass *simultinstance)
string	APIgetSecret (string sender)
bool	APIrequestsendHiddenSecret (string pid, string sender, string newsecret)
bool	APIsendHiddenSecret (string sender, string newsecret)
bool	APIverifySimultaneous ()
bool	rulesSimultaneoussendHiddenSecret (string pid, string sender, string body, SPTSimultaneousClass *transobj)
Private Attributes
SPTSimultaneousClass *	traninst
const bool	librarytestmode

---

Constructor & Destructor Documentation

SPTSimultaneousAPIClass::~SPTSimultaneousAPIClass (   )

Default Destrcutor

SPTSimultaneousAPIClass::SPTSimultaneousAPIClass (   )

Default Constrcutor

SPTSimultaneousAPIClass::SPTSimultaneousAPIClass (  SPTSimultaneousClass *  simultinstance  )

Overloaded Constructor Parameters: simultinstance  SPSimultaneousClass - the transaction from which the API will build from

---

Member Function Documentation

string SPTSimultaneousAPIClass::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 SPTSimultaneousAPIClass::APIrequestsendHiddenSecret (  string  pid, string  sender, 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 - Boolean: TRUE, if request successfully sent, FALSE, if not

bool SPTSimultaneousAPIClass::APIsendHiddenSecret (  string  sender, 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 - Boolean: TRUE, if successful, FALSE, if not

bool SPTSimultaneousAPIClass::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.

bool SPTSimultaneousAPIClass::rulesSimultaneoussendHiddenSecret (  string  pid, string  sender, string  body, SPTSimultaneousClass *  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 of the master of the transaction sender  String - player id of the sender body  String - body of the transaction transobj  SPSimultaneousClass - the transaction object Returns: result boolean - true, if successful, false, if not.

---

Member Data Documentation

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

This should be set to FALSE for production systems or all "rulesXXXX methods should be edited Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

SPTSimultaneousClass* SecurePlayLibrary::SPTSimultaneousAPIClass::traninst [private]

the transaction instance

---

The documentation for this class was generated from the following files:

• SPTSimultaneousAPIClass.h
• SPTSimultaneousAPIClass.cpp

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.