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

#include <SPGameClass.h>

Inheritance diagram for SecurePlayLibrary::SPGameClass:

SecurePlayLibrary::SPRootTransactionClass SecurePlayLibrary::SPGameInterface List of all members.

Public Member Functions

 SPGameClass (string gameID, string master, bool signaturepolicy, bool encryptionpolicy, SecurePlayClass *SPlibobj, SPLogInterface *log, SPSecurityManagerInterface *security)
 SPGameClass (string master, bool signaturepolicy, bool encryptionpolicy, SPLogInterface *log, SPSecurityManagerInterface *security)
bool addPlayer (string pid)
bool removePlayer (string pid)
bool setPlayerComms (string playerID, string commsID)
bool addComms (string commsID)
bool removeComms (string commsID)
bool addTransaction (SPAbstractTransactionInterface *transObj)
bool closeTransaction (string transID)
SPAbstractTransactionInterface * APIgetGameTransaction (string tid)
bool transactionincluded (string tid)
void onIncomingTransaction (SPMessageClass *messObj)
bool isPlayerInternal (string pid)
SPCommsManagerClass * getCommsManager ()
SecurePlayClass * getSecurePlay ()
string APIgetGamestatus ()
vector< string > APIgetOpentransactionIDList ()
vector< SPAbstractTransactionInterface * > getTransactions ()
string APIgetLicenseSummary ()
SPLogInterface * APIgetGameLog ()
int APIgetBasicTransactionCount ()
bool setGameID (string gid, SecurePlayClass *spc)
string APIgetMaster ()
string APIgetTransactionID ()
string APIgetGameID ()
vector< string > APIgetPlayerIDList ()
void SPnotify (string eventdescription, vector< string > args, string sourceMethod, string sourceClass, string errorType)

Static Public Attributes

const string mt_newTransaction = "newTransaction"

Detailed Description

This is the general class that holds a game instance. It is also the transaction class for the basic game transaction.
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPGameClass::SPGameClass (  string  gameID,
string  master,
bool  signaturepolicy,
bool  encryptionpolicy,
SecurePlayClass *  SPlibobj,
SPLogInterface *  log,
SPSecurityManagerInterface *  security
) 
 

Constructs an overloaded SPGameClass()

Parameters:
gameID String - id of the game
master String - id of the player who will be the master of this game
signaturepolicy boolean - signature policy
encryptionpolicy boolean - encryption policy
SPlibobj SecurePlayClass - secure play library in which the game will be created.

SPGameClass::SPGameClass (  string  master,
bool  signaturepolicy,
bool  encryptionpolicy,
SPLogInterface *  log,
SPSecurityManagerInterface *  security
) 
 

Constructs an overloaded SPGameClass()

Parameters:
master String - id of the player who will be the master of this game
signaturepolicy boolean - signature policy
encryptionpolicy boolean - encryption policy
log - SPLogInterface - game log object
security - SPSecurityManagerInterface - security manager object

Member Function Documentation

bool SPGameClass::addComms (  string  commsID  )  [virtual]
 

This method associates a comms service specified by the commsID string to a game instance.

Parameters:
commsID String - id of the comms to be added
Returns:
result - Boolean: TRUE, if gamestatus is "complete", FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::addPlayer (  string  pid  )  [virtual]
 

This method safely adds an existing Player, specified by the playerID to the game instance.

Parameters:
pid String - the id of the player to be added
Returns:
result - Boolean: TRUE, if successful, FALSE, if no

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::addTransaction (  SPAbstractTransactionInterface *  transObj  )  [virtual]
 

This safely adds a transaction to a game instance and appropriately updates the game state.

Parameters:
transObj SPAbstractTransactionInterface - the transaction Object handler
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

int SPGameClass::APIgetBasicTransactionCount (   ) 
 

This method returns the basic transaction count - the total number of transactions that have been generated.

Returns:
- int - the basic transaction count

string SPGameClass::APIgetGameID (   )  [virtual]
 

Gets the game id

Returns:
str - String - the game id

Implements SecurePlayLibrary::SPGameInterface.

SPLogInterface * SPGameClass::APIgetGameLog (   )  [virtual]
 

Gets the messagelog object from the gameinstance

Returns:
messlog - SPLogInterface - this object contains the message logs of the game instance.

Implements SecurePlayLibrary::SPGameInterface.

string SPGameClass::APIgetGamestatus (   )  [virtual]
 

Getter function that returns the property: gamestatus

Returns:
gamestatus - String

Implements SecurePlayLibrary::SPGameInterface.

SPAbstractTransactionInterface * SPGameClass::APIgetGameTransaction (  string  tid  )  [virtual]
 

This method returns a specific transaction associated with a given game instance.

Parameters:
tid String - identifier for transaction object
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

string SPGameClass::APIgetLicenseSummary (   )  [virtual]
 

This method returns a summary of the licensee information for the current game instance. This information needs to be publicly available from any game instance, see SecurePlay license for details.

Returns:
fulllicensetext - String - this string contains full license information.

Implements SecurePlayLibrary::SPGameInterface.

string SPGameClass::APIgetMaster (   )  [virtual]
 

Gets the master

Returns:
master String - the master

Implements SecurePlayLibrary::SPGameInterface.

vector< string > SPGameClass::APIgetOpentransactionIDList (   )  [virtual]
 

Getter function that returns the open transaction IDs

Returns:
opentransactionIDList - String

Implements SecurePlayLibrary::SPGameInterface.

vector< string > SPGameClass::APIgetPlayerIDList (   )  [virtual]
 

Gets the player id list

Returns:
pidlist - String[] - the player id list

Implements SecurePlayLibrary::SPGameInterface.

string SPGameClass::APIgetTransactionID (   )  [virtual]
 

Gets the transaction id

Returns:
tranid - String - the transaction id

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::closeTransaction (  string  transID  )  [virtual]
 

Safely removes a transaction from a game instance.

Parameters:
transID String - the id of the transaction to be closed
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

SPCommsManagerClass * SPGameClass::getCommsManager (   )  [virtual]
 

Gets the comms manager object

Returns:
comms - SPCommsManagerClass - the comms manager object

Implements SecurePlayLibrary::SPGameInterface.

SecurePlayClass * SPGameClass::getSecurePlay (   )  [virtual]
 

This method returns the unique SecurePlay library object associated with the game instance object.

Returns:
spc - SecurePlayLibrary - the secure play library

Implements SecurePlayLibrary::SPGameInterface.

vector< SPAbstractTransactionInterface * > SPGameClass::getTransactions (   ) 
 

Getter function that returns the transactions from propentransactionlist

Returns:
prplayerList - SPHashtable

bool SPGameClass::isPlayerInternal (  string  pid  )  [virtual]
 

Checks to see if the player is internal

Parameters:
pid String - id of the player to be checked
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

void SPGameClass::onIncomingTransaction (  SPMessageClass *  messObj  )  [virtual]
 

This method is the generic handler for incoming Game transaction methods.

Parameters:
messObj SPMessageClass - incoming Message Object

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::removeComms (  string  commsID  )  [virtual]
 

This method removes the association of a communications service with a game instance.

Parameters:
commsID String - id of the comms to be removed
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::removePlayer (  string  pid  )  [virtual]
 

This method safely removes a Player instance from an existing Game Instance.

Parameters:
pid String - id of the player to be removed
Returns:
result - Boolean: TRUE, if successful, FALSE, if not.

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::setGameID (  string  gid,
SecurePlayClass *  spc
)  [virtual]
 

This method sets the internal ID for a comms service if it has not been set. NOTE, this ID is not the public, network, or other ID for the communications service, but simply an internal handler.

Parameters:
gid String - game id
spc - SecurePlayClass
Returns:
boolean: TRUE, if succesful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::setPlayerComms (  string  playerID,
string  commsID
)  [virtual]
 

This method associates a specific player instance, specified by the playerID, with a specific communications service, specified by the commsID. For certain remote players, a relay service is supported to allow messages to be forwarded. NOTE: there is a reserved comms service "internal" for player instances that are included in the local application session.

Parameters:
playerID String - id of the player to be added
commsID String - id of the comms object to be added
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

void SPGameClass::SPnotify (  string  eventdescription,
vector< string >  args,
string  sourceMethod,
string  sourceClass,
string  errorType
)  [virtual]
 

This method notifies the Listeners of events

Parameters:
eventdescription 
args - String[] - arguments

Implements SecurePlayLibrary::SPGameInterface.

bool SPGameClass::transactionincluded (  string  tid  )  [virtual]
 

This method checks the specified transaction ID against the currently included transaction IDs in the game instance.

Parameters:
tid String - the id of the transaction in question
Returns:
result Boolean: TRUE, if included, FALSE, if not

Implements SecurePlayLibrary::SPGameInterface.

Member Data Documentation

const string SPGameClass::mt_newTransaction = "newTransaction" [static]
 

This property is the message type for new transactions.

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.