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

#include <SPRootTransactionClass.h>

Inheritance diagram for SecurePlayLibrary::SPRootTransactionClass:

SecurePlayLibrary::SPAbstractTransactionClass SecurePlayLibrary::SPGameClass 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

 SPRootTransactionClass ()
string APIgetGameID ()
bool APIsetSecurePlayClass (SecurePlayClass *sp)
string APIgetTransactionID ()
string APIgetMaster ()
vector< string > APIgetPlayerIDList ()
bool APIaddListener (SPEventInterface *listener)
bool APIremoveListener (SPEventInterface *listener)
vector< SPEventInterface * > APIgetListeners ()
bool APIclearListeners ()
int APIgetListenerCount ()
void SPnotify (string eventdescription, vector< string > args, string sourceMethod, string sourceClass, string errorType)
bool APIisPlayerIncluded (string pid)
bool detectReplay (SPMessageClass *incoming)
void sendMessage (string sender, vector< string > receivers, bool encryptflag, bool privateflag, string messagetype, vector< string > messagebody, vector< string > altmessage)
void APIresendLastMessage ()
bool APIReplayRemoveOldSender (string sender)
SPMap< string, long > APIgetGetReplayList ()
void APIsetReplayList (SPMap< string, long > m)

Protected Attributes

string gameID
vector< string > playerIDList
string transactionID
string master
vector< SPEventInterface * > EventListenerList
SPMap< string, long > insend
SecurePlayClass * secureplay
SPCommsManagerClass * comms
string ReSend_sender
vector< string > ReSend_receivers
bool ReSend_encryptflag
bool ReSend_privateflag
string ReSend_messagetype
vector< string > ReSend_messagebody
vector< string > ReSend_altmessage
string ReSend_messageID
const string releaseversion

Detailed Description

This abstract class provides the common services for all game and transaction types.
Author:
IT GlobalSecure Inc.
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPRootTransactionClass::SPRootTransactionClass (   ) 
 

Default Constructor

Member Function Documentation

bool SPRootTransactionClass::APIaddListener (  SPEventInterface *  listener  ) 
 

This method adds a listener object for events

Parameters:
listener SPEventInterface - listener to be added
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

bool SPRootTransactionClass::APIclearListeners (   ) 
 

This method clears the listener objects for events

Returns:
result - Boolean: TRUE, if successful, FALSE, if not

string SPRootTransactionClass::APIgetGameID (   ) 
 

Gets the game id associated with the transaction or game.

Returns:
gid - String - game id

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

SPMap< string, long > SPRootTransactionClass::APIgetGetReplayList (   ) 
 

This method returns the relay data list.

Returns:
SPMap - clones replay list

int SPRootTransactionClass::APIgetListenerCount (   ) 
 

This method returns the number of listener objects for events

Returns:
i - int - returns the number of listeners

vector< SPEventInterface * > SPRootTransactionClass::APIgetListeners (   ) 
 

This method returns a list of listener objects for events

Returns:
a[] - Object[] - gets the array of listener objects

string SPRootTransactionClass::APIgetMaster (   ) 
 

Gets the master of the transaction or game

Returns:
master - String - returns the id of the master

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

vector< string > SPRootTransactionClass::APIgetPlayerIDList (   ) 
 

Gets the player id list of the players associated with the transaction or the game.

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

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

string SPRootTransactionClass::APIgetTransactionID (   ) 
 

Gets the transaction id.

Returns:
tid - String - the transaction id

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

bool SPRootTransactionClass::APIisPlayerIncluded (  string  pid  ) 
 

This method tests to determine if a specified player is a transaction participant.

Parameters:
pid String - the player id in question
Returns:
Boolean - TRUE, if player is a transaction participant, FALSE, if not.

bool SPRootTransactionClass::APIremoveListener (  SPEventInterface *  listener  ) 
 

This method removes a listener object for events

Parameters:
listener SPEventInterface - listener to be removed
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

bool SPRootTransactionClass::APIReplayRemoveOldSender (  string  sender  ) 
 

This method removes an older sender from the replay list.

Parameters:
sender 
Returns:
boolean

void SPRootTransactionClass::APIresendLastMessage (   ) 
 

This method resends the last message sent by retrieveing the data stored of the last message.

void SPRootTransactionClass::APIsetReplayList (  SPMap< string, long >  m  ) 
 

This method sets the relay data list.

Parameters:
m - SPMap - data structure for the relay list.

bool SPRootTransactionClass::APIsetSecurePlayClass (  SecurePlayClass *  sp  ) 
 

This method sets the SecurePlayClass associated with this SPRootTransactionClass

Parameters:
sp SecurePlayClass
Returns:
boolean

bool SPRootTransactionClass::detectReplay (  SPMessageClass *  incoming  ) 
 

This checks to see if there is a replay problem. It returns TRUE if there is a replay problem

Parameters:
incoming - SPMessageClass - message to be testd
Returns:
boolean - TRUE if there is a replay problem

void SPRootTransactionClass::sendMessage (  string  sender,
vector< string >  receivers,
bool  encryptflag,
bool  privateflag,
string  messagetype,
vector< string >  messagebody,
vector< string >  altmessage
) 
 

This method actually constructs messages to be sent by the Game object to other game object instances via the Comms Manager

Parameters:
sender - id of the sender
receivers - ids of the recievers of the message
encryptflag - encryption flag
privateflag - private flag
messagetype - the type of message
messagebody - the message body
altmessage - alternative message
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass.

void SPRootTransactionClass::SPnotify (  string  eventdescription,
vector< string >  args,
string  sourceMethod,
string  sourceClass,
string  errorType
) 
 

This method notifies the Listeners of events

Parameters:
eventdescription 
args - String[] - arguments

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPGameClass.

Member Data Documentation

SPCommsManagerClass* SecurePlayLibrary::SPRootTransactionClass::comms [protected]
 

This is the SPcomms instance associated with the game instance. It is used to access the communications manager services to send and receive and process messages.

vector<SPEventInterface*> SecurePlayLibrary::SPRootTransactionClass::EventListenerList [protected]
 

This holds the list of objects that listen to events from the transaction or game object

string SecurePlayLibrary::SPRootTransactionClass::gameID [protected]
 

If associated with a transaction: This property is the identifier of the game instance with which the transaction is associated.

SPMap<string, long> SecurePlayLibrary::SPRootTransactionClass::insend [protected]
 

This map contains the incoming message senders and the associated most recent message ID.

string SecurePlayLibrary::SPRootTransactionClass::master [protected]
 

If associated with a transaction: This is the PlayerID of the player that is the master of this transaction. The master of the transaction is the only entity that can start, configure, or end the transaction.

vector<string> SecurePlayLibrary::SPRootTransactionClass::playerIDList [protected]
 

If associated with a transaction: This is an array that holds the Player IDs of the players within the game that are participating in this transaction.

const string SecurePlayLibrary::SPRootTransactionClass::releaseversion [protected]
 

IT GlobalSecure release version.

Reimplemented in SecurePlayLibrary::SPAbstractTransactionClass.

vector<string> SecurePlayLibrary::SPRootTransactionClass::ReSend_altmessage [protected]
 

Data from Last message sent, only used by resend message and send message

bool SecurePlayLibrary::SPRootTransactionClass::ReSend_encryptflag [protected]
 

Data from Last message sent, only used by resend message and send message

vector<string> SecurePlayLibrary::SPRootTransactionClass::ReSend_messagebody [protected]
 

Data from Last message sent, only used by resend message and send message

string SecurePlayLibrary::SPRootTransactionClass::ReSend_messageID [protected]
 

Data from Last message sent, is the message ID of the previously sent message

string SecurePlayLibrary::SPRootTransactionClass::ReSend_messagetype [protected]
 

Data from Last message sent, only used by resend message and send message

bool SecurePlayLibrary::SPRootTransactionClass::ReSend_privateflag [protected]
 

Data from Last message sent, only used by resend message and send message

vector<string> SecurePlayLibrary::SPRootTransactionClass::ReSend_receivers [protected]
 

Data from Last message sent, only used by resend message and send message

string SecurePlayLibrary::SPRootTransactionClass::ReSend_sender [protected]
 

Data from Last message sent, only used by resend message and send message

SecurePlayClass* SecurePlayLibrary::SPRootTransactionClass::secureplay [protected]
 

This property holds the SecurePlayClass associted with this transaction.

string SecurePlayLibrary::SPRootTransactionClass::transactionID [protected]
 

If associated with a transaction: This property holds the unique identifier for the transaction instance within a game 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.