SecurePlayLibrary::SPTStrobeAPIClass Class Reference

#include <SPTStrobeAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTStrobeAPIClass:

List of all members.

---

Detailed Description

The Strobe Class is used to provide securely synchronized game play. This is essentially a combination of the Multipart transaction and the Simultaneous transaction. Each participant sends a simultaneous message to the others. Once all sent, then a “tick” or event has occurred. Then another message can be sent and the first message read.

Author:

IT GlobalSecure

See also:

SecurePlay License Information

Public Member Functions
	SPTStrobeAPIClass ()
	~SPTStrobeAPIClass ()
	SPTStrobeAPIClass (SPTStrobeClass *simultinstance)
vector< string >	APIgetSecret (string sender)
bool	APIrequestsendHiddenSecret (string pid, string sender, vector< string > newsecret)
bool	APIsendHiddenSecret (string sender, vector< string > newsecret)
bool	APIverifyStrobeStep ()
bool	rulesStrobesendHiddenSecret (string pid, string sender, vector< string > body, SPTStrobeClass *transobj)
Private Attributes
SPTStrobeClass *	traninst
bool	librarytestmode

---

Constructor & Destructor Documentation

SPTStrobeAPIClass::SPTStrobeAPIClass (   )

Default Constrcutor

SPTStrobeAPIClass::~SPTStrobeAPIClass (   )

Default Destrcutor

SPTStrobeAPIClass::SPTStrobeAPIClass (  SPTStrobeClass *  simultinstance  )

Overloaded Constructor Parameters: simultinstance  - SPStrobeClass - the abstract version of the class with which this API will be associated with

---

Member Function Documentation

vector< string > SPTStrobeAPIClass::APIgetSecret (  string  sender  )

This method returns the actual secret for the specified player that this STROBE step is protecting, if available. Parameters: sender  string - sender of the secret Returns: secret - string - the secret

bool SPTStrobeAPIClass::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 SPTStrobeAPIClass::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 SPTStrobeAPIClass::APIverifyStrobeStep (   )

This method verifies whether the just completed STROBE step is valid. Returns: result - bool: TRUE, if transaction verified, FALSE, if not.

bool SPTStrobeAPIClass::rulesStrobesendHiddenSecret (  string  pid, string  sender, vector< string >  body, SPTStrobeClass *  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 bool - true, if successful, false, if not.

---

Member Data Documentation

bool SecurePlayLibrary::SPTStrobeAPIClass::librarytestmode [private]

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

SPTStrobeClass* SecurePlayLibrary::SPTStrobeAPIClass::traninst [private]

the transaction instance

---

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

• SPTStrobeAPIClass.h
• SPTStrobeAPIClass.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.