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

#include <SPGameInterface.h>

Inheritance diagram for SecurePlayLibrary::SPGameInterface:

List of all members.


Public Member Functions
virtual bool	addPlayer (string pid)=0
virtual bool	removePlayer (string pid)=0
virtual bool	setPlayerComms (string playerID, string commsID)=0
virtual bool	addComms (string commsID)=0
virtual bool	removeComms (string commsID)=0
virtual bool	addTransaction (SPAbstractTransactionInterface *transObj)=0
virtual bool	closeTransaction (string transID)=0
virtual SPAbstractTransactionInterface *	APIgetGameTransaction (string tid)=0
virtual void	onIncomingTransaction (SPMessageClass *messObj)=0
virtual bool	isPlayerInternal (string pid)=0
virtual string	APIgetGameID ()=0
virtual vector< string >	APIgetPlayerIDList ()=0
virtual vector< string >	APIgetOpentransactionIDList ()=0
virtual SPCommsManagerClass *	getCommsManager ()=0
virtual string	APIgetMaster ()=0
virtual string	APIgetTransactionID ()=0
virtual SecurePlayClass *	getSecurePlay ()=0
virtual void	SPnotify (string eventdescription, vector< string > args, string sourceMethod, string sourceClass, string errorType)=0
virtual SPLogInterface *	APIgetGameLog ()=0
virtual string	APIgetLicenseSummary ()=0
virtual string	APIgetGamestatus ()=0
virtual bool	setGameID (string gid, SecurePlayClass *spc)=0
virtual bool	transactionincluded (string tid)=0

Detailed Description

This is the interface for all Game classes

Author:: IT GlobalSecure

See also:: SecurePlay License Information

Member Function Documentation

virtual bool SecurePlayLibrary::SPGameInterface::addComms ( string commsID ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::addPlayer ( string pid ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::addTransaction ( SPAbstractTransactionInterface * transObj ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

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

Gets the game id
Returns:
str - String - the game id

Implemented in SecurePlayLibrary::SPGameClass.

virtual SPLogInterface* SecurePlayLibrary::SPGameInterface::APIgetGameLog ( ) [pure virtual]

Gets the messagelog object from the gameinstance
Returns:
messlog - SPLogInterface - this object contains the message logs of the game instance.

Implemented in SecurePlayLibrary::SPGameClass.

virtual string SecurePlayLibrary::SPGameInterface::APIgetGamestatus ( ) [pure virtual]

Getter function that returns the property: gamestatus
Returns:
gamestatus - String

Implemented in SecurePlayLibrary::SPGameClass.

virtual SPAbstractTransactionInterface* SecurePlayLibrary::SPGameInterface::APIgetGameTransaction ( string tid ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual string SecurePlayLibrary::SPGameInterface::APIgetLicenseSummary ( ) [pure 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.

Implemented in SecurePlayLibrary::SPGameClass.

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

Gets the master
Returns:
master String - the master

Implemented in SecurePlayLibrary::SPGameClass.

virtual vector<string> SecurePlayLibrary::SPGameInterface::APIgetOpentransactionIDList ( ) [pure virtual]

Getter function that returns the open transaction IDs
Returns:
opentransactionIDList - String

Implemented in SecurePlayLibrary::SPGameClass.

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

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

Implemented in SecurePlayLibrary::SPGameClass.

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

Gets the transaction id
Returns:
tranid - String - the transaction id

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::closeTransaction ( string transID ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual SPCommsManagerClass* SecurePlayLibrary::SPGameInterface::getCommsManager ( ) [pure virtual]

Gets the comms manager object
Returns:
comms - SPCommsManagerClass - the comms manager object

Implemented in SecurePlayLibrary::SPGameClass.

virtual SecurePlayClass* SecurePlayLibrary::SPGameInterface::getSecurePlay ( ) [pure virtual]

This method returns the unique SecurePlay library object associated with the game instance object.
Returns:
spc - SecurePlayLibrary - the secure play library

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::isPlayerInternal ( string pid ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual void SecurePlayLibrary::SPGameInterface::onIncomingTransaction ( SPMessageClass * messObj ) [pure virtual]

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

messObj SPMessageClass - incoming Message Object

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::removeComms ( string commsID ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::removePlayer ( string pid ) [pure 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.

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::setGameID ( string gid,

SecurePlayClass * spc

) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::setPlayerComms ( string playerID,

string commsID

) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

virtual void SecurePlayLibrary::SPGameInterface::SPnotify ( string eventdescription,

vector< string > args,

string sourceMethod,

string sourceClass,

string errorType

) [pure virtual]

This method notifies the Listeners of events
Parameters:

eventdescription

args - String[] - arguments

Implemented in SecurePlayLibrary::SPGameClass.

virtual bool SecurePlayLibrary::SPGameInterface::transactionincluded ( string tid ) [pure 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

Implemented in SecurePlayLibrary::SPGameClass.

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

D:/SecurePlayLibrary/060216_SecurePlayLibrary_3_1_baseline/CPP/src/SPGameInterface.h

SecurePlayLibrary::SPGameInterface Class Reference

Public Member Functions

Detailed Description

Member Function Documentation