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

#include <SPAbstractTransactionInterface.h>

Inheritance diagram for SecurePlayLibrary::SPAbstractTransactionInterface:

SecurePlayLibrary::SPAbstractTransactionClass SecurePlayLibrary::SPTBlastClass SecurePlayLibrary::SPTBurstClass SecurePlayLibrary::SPTMultiPartSecretClass SecurePlayLibrary::SPTMultiPartSimultaneousClass SecurePlayLibrary::SPTMultistepTurnClass SecurePlayLibrary::SPTRandomClass SecurePlayLibrary::SPTSecretClass SecurePlayLibrary::SPTShipClass SecurePlayLibrary::SPTSimultaneousClass SecurePlayLibrary::SPTStrobeClass List of all members.

Public Member Functions

virtual void onincomingTransaction (SPMessageClass *incoming)=0
virtual string APIgetMaster ()=0
virtual string APIgetTransactionID ()=0
virtual string APIgetGameID ()=0
virtual vector< string > APIgetPlayerIDList ()=0
virtual bool APIgetPrivacyFlag ()=0
virtual void APIsetTransactionID (string tid)=0
virtual void sendMessage (string sender, vector< string > receivers, bool encryptflag, bool privateflag, string messagetype, vector< string > messagebody, vector< string > altmessage)=0
virtual string APIgetTransactionstatus ()=0
virtual vector< string > APIgetConfiguration ()=0
virtual string APIgetAGE ()=0
virtual string APIgetTransactionType ()=0
virtual SPAbstractTransactionInterface * APIcreateTransaction (SPGameInterface *gameapiobj, SPMessageClass *message)=0
virtual bool APIcompleteTransaction (string pid)=0

Detailed Description

The Abstract Transaction Interface is the required interface that all transactions that work with the SecurePlay library must support. This provides an alternate construction method for new transactions that does not require inheritance from the Abstract Transaction Class.
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Member Function Documentation

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::APIcompleteTransaction (  string  pid  )  [pure virtual]
 

This method allows the Transaction Master ONLY to complete the transaction. Transactions that are in an error state cannot be cleared by completion.

Parameters:
pid String - id of the player who is completing the transaction, must be the master and internal.
Returns:
result - Boolean: TRUE, if successful, FALSE, if not.

Implemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPTRandomClass.

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

Creates a new instance of an Abstract Transaction class.

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

Implemented in SecurePlayLibrary::SPAbstractTransactionClass, SecurePlayLibrary::SPTActClass, SecurePlayLibrary::SPTBeginGame, SecurePlayLibrary::SPTBlastClass, SecurePlayLibrary::SPTBurstClass, SecurePlayLibrary::SPTEndGame, SecurePlayLibrary::SPTMultiPartSecretClass, SecurePlayLibrary::SPTMultiPartSimultaneousClass, SecurePlayLibrary::SPTMultistepTurnClass, SecurePlayLibrary::SPTnewAGEClass, SecurePlayLibrary::SPTnewGameClass, SecurePlayLibrary::SPTPlayerJoinClass, SecurePlayLibrary::SPTRandomClass, SecurePlayLibrary::SPTSecretClass, SecurePlayLibrary::SPTShipClass, SecurePlayLibrary::SPTSimultaneousClass, and SecurePlayLibrary::SPTStrobeClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetAGE (   )  [pure virtual]
 

Gets the abstract game engine of this transaction.

Returns:
gameblock - String

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual vector<string> SecurePlayLibrary::SPAbstractTransactionInterface::APIgetConfiguration (   )  [pure virtual]
 

Getter function that returns the property: configuration

Returns:
configuration - String[]

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetGameID (   )  [pure virtual]
 

Gets the game id associated with the transaction.

Returns:
gid - String - game id

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetMaster (   )  [pure virtual]
 

Gets the id of the master of the transaction.

Returns:
master - String - master of the transaction.

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual vector<string> SecurePlayLibrary::SPAbstractTransactionInterface::APIgetPlayerIDList (   )  [pure virtual]
 

Gets the player ids associated with the transaction.

Returns:
players - String[] - players associated with the transaction in a String array.

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::APIgetPrivacyFlag (   )  [pure virtual]
 

Gets the privacy flag of this class.

Returns:
privateflag - boolean

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetTransactionID (   )  [pure virtual]
 

Gets the transaction id.

Returns:
tid - String - the transaction id

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetTransactionstatus (   )  [pure virtual]
 

Getter function that returns the property: transactionstatus

Returns:
transactionstatus - String

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetTransactionType (   )  [pure virtual]
 

This method returns a String of the transactiontype.

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

Implemented in SecurePlayLibrary::SPAbstractTransactionClass, SecurePlayLibrary::SPTActClass, SecurePlayLibrary::SPTBeginGame, SecurePlayLibrary::SPTBlastClass, SecurePlayLibrary::SPTBurstClass, SecurePlayLibrary::SPTEndGame, SecurePlayLibrary::SPTMultiPartSecretClass, SecurePlayLibrary::SPTMultiPartSimultaneousClass, SecurePlayLibrary::SPTMultistepTurnClass, SecurePlayLibrary::SPTnewAGEClass, SecurePlayLibrary::SPTnewGameClass, SecurePlayLibrary::SPTPlayerJoinClass, SecurePlayLibrary::SPTSecretClass, SecurePlayLibrary::SPTShipClass, SecurePlayLibrary::SPTSimultaneousClass, SecurePlayLibrary::SPTStrobeClass, and SecurePlayLibrary::SPTSynchronizedRandomClass.

virtual void SecurePlayLibrary::SPAbstractTransactionInterface::APIsetTransactionID (  string  tid  )  [pure virtual]
 

Sets the transaction id to a specified id.

Parameters:
tid String - the id of the transaction.

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual void SecurePlayLibrary::SPAbstractTransactionInterface::onincomingTransaction (  SPMessageClass *  incoming  )  [pure virtual]
 

This method handles the various incoming messages and passes them to the appropriate message type handler.

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

Implemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPTBlastClass.

virtual void SecurePlayLibrary::SPAbstractTransactionInterface::sendMessage (  string  sender,
vector< string >  receivers,
bool  encryptflag,
bool  privateflag,
string  messagetype,
vector< string >  messagebody,
vector< string >  altmessage
)  [pure virtual]
 

This method sends a message. It hands the configured message off to the appropriate comms service. Also, for private messages, it sends an alternate message to the parties not recieving the main message.

Parameters:
sender String - player id of the sender.
receivers String[] - player ids of recievers.
encryptflag boolean - enrypted flag
privateflag boolean - private flag
messagetype String - message type
messagebody String[] - the message body as a string
altmessage String[] - alternative message.
Returns:
void

Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

The documentation for this class was generated from the following file: 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.