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

#include <SecurePlayClass.h>

List of all members.

Public Member Functions

 SecurePlayClass ()
bool APIsetLicenseInfo (string pocname, string company, string siteURL, string email, string SPSerialNumber, string SPLicenseKey)
bool APIcreatePlayer (string playerID)
bool APIcreateComms (string commsID, SPAbstractCommsInterface *commsObj)
bool APIsetPlayerGameComms (string gid, string playerID, string commsID)
bool APIaddGamePlayer (string gid, string pid)
bool APIaddGameComms (string gid, string commsID)
SPGameInterface * APIgetGame (string gameID)
SPAbstractCommsInterface * APIgetCommsService (string commsID)
bool APIremoveGame (string gameID)
bool APIremovePlayer (string playerID)
bool APIremoveCommsService (string commsID)
void APIclearGames ()
void APIclearPlayers ()
void APIclearCommsServices ()
vector< string > APIgetOpenCommServiceIDs ()
vector< string > APIgetOpenGameIDs ()
vector< string > APIgetOpenPlayerIDs ()
bool isPlayerIncluded (string pid)
bool isGameIncluded (string gid)
bool isCommsIncluded (string cid)
bool APIcreateGame (SPGameInterface *game, string gameID)
string getCompany ()
string getEmail ()
bool isInitialized ()
string getPocname ()
string APIgetLicenseSummary ()
bool APIaddLibraryListeners (SPEventInterface *Glistener)
bool APIremoveLibraryListeners (SPEventInterface *Glistener)
bool APIclearLibraryListeners ()
vector< SPEventInterface * > APIgetLibraryListeners ()

Static Public Member Functions

string releaseversion ()

Protected Member Functions

bool checkLicense ()
SPMap< string, SPAbstractCommsInterface * > getPrcommsServicesList ()
SPMap< string, SPGameInterface * > getPrgamesList ()
vector< string > getPrplayersList ()

Detailed Description

This is the main Secure Play Library Class.
Author:
IT GlobalSecure
See also:
SecurePlay License Information
Version:
3.1

Constructor & Destructor Documentation

SecurePlayClass::SecurePlayClass (   ) 
 

Default Constructor. This constructor sets all the lisence related parameters to its default. And it sets the default for Log, SecurityManager, and it also registers Blast Transaction as default transaction for this library.

Member Function Documentation

bool SecurePlayClass::APIaddGameComms (  string  gid,
string  commsID
) 
 

This method associates a communications service with a game instance.

Parameters:
gid String - id of the game to which the comms will be added
commsID String - id of the comms to be added
Returns:
boolean - TRUE if successful, FALSE, if unsuccessful

bool SecurePlayClass::APIaddGamePlayer (  string  gid,
string  pid
) 
 

This method associates a Player instance with a Game Instance so the player can participate in the game.

Parameters:
gid String - id of the game to which the player will be added
pid String - id of the player to be added
Returns:
boolean - TRUE, if successful, FALSE, if not successful

bool SecurePlayClass::APIaddLibraryListeners (  SPEventInterface *  Glistener  ) 
 

This method adds a global listener to this SecurePlayClass.

Parameters:
Glistener SPEventInterface - the global listener.
Returns:
boolean

void SecurePlayClass::APIclearCommsServices (   ) 
 

This clears all of the comms services associated with the SecurePlay library. It should be used with great caution.

Returns:
void

void SecurePlayClass::APIclearGames (   ) 
 

This removes all of the Game Instances associated with the SecurePlay library. Use with caution.

Returns:
void

bool SecurePlayClass::APIclearLibraryListeners (   ) 
 

This method removes all the global listeners from this SecurePlayClass.

Returns:
boolean

void SecurePlayClass::APIclearPlayers (   ) 
 

This method removes all of the Player Instances associated with the SecurePlay library.

Returns:
void

bool SecurePlayClass::APIcreateComms (  string  commsID,
SPAbstractCommsInterface *  commsObj
) 
 

This method creates a comms service.

Parameters:
commsID String - id of the comms to be created
commsObj SPAbstractCommsInterface - comms object to be added
Returns:
boolean - TRUE, if succcessful, FALSE, if not.

bool SecurePlayClass::APIcreateGame (  SPGameInterface *  game,
string  gameID
) 
 

Attach an existing Game Instance to the Library.

Parameters:
game SPGameInterface - the game object to be attached
gameID String - game id of the new game.
Returns:
boolean - TRUE, if the game was created successfully, FALSE, otherwise

bool SecurePlayClass::APIcreatePlayer (  string  playerID  ) 
 

Adds a player instance.

Parameters:
playerID String - player id of the player to be created
Returns:
boolean - TRUE, if successful, FALSE, if not

SPAbstractCommsInterface * SecurePlayClass::APIgetCommsService (  string  commsID  ) 
 

This method uses a commsID and returns the appropriate Communications Service Instance.

Parameters:
commsID String - id of the comms to be retrieved
Returns:
SPAbstractCommsInterface - returns the actual object

SPGameInterface * SecurePlayClass::APIgetGame (  string  gameID  ) 
 

This method takes a gameID and returns the associated Game Instance object.

Parameters:
gameID String - id of the game to be retrieved
Returns:
SPGameInterface - returns the actual object

vector< SPEventInterface * > SecurePlayClass::APIgetLibraryListeners (   ) 
 

Gets all the listeners that are listening for any notify in this library.

Returns:
Vector

string SecurePlayClass::APIgetLicenseSummary (   ) 
 

This method returns the summary of the license.

Returns:
String - the summary of the license

vector< string > SecurePlayClass::APIgetOpenCommServiceIDs (   ) 
 

This method return

Returns:
String[] - array of open comms services id list

vector< string > SecurePlayClass::APIgetOpenGameIDs (   ) 
 

Gets the keys of an associative array(SPHashtable) this.prgamesList and returns them as a String array of open games id list.

Returns:
String[] - array of open games id list

vector< string > SecurePlayClass::APIgetOpenPlayerIDs (   ) 
 

Returns a list of player IDs open.

Returns:
String[] - array of open players id list

bool SecurePlayClass::APIremoveCommsService (  string  commsID  ) 
 

This method removes a Comms Service Instance specified by a commsID from the active SecurePlay library.

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

bool SecurePlayClass::APIremoveGame (  string  gameID  ) 
 

This method takes a gameID and removes the Game Instance from the active SecurePlay library.

Parameters:
gameID String - id of the game to be removed
Returns:
boolean - TRUE, if successful, FALSE, if not

bool SecurePlayClass::APIremoveLibraryListeners (  SPEventInterface *  Glistener  ) 
 

This method removes a global listener object from this SecurePlayClass.

Parameters:
Glistener SPEventInterface - the global listener.
Returns:
boolean

bool SecurePlayClass::APIremovePlayer (  string  playerID  ) 
 

This method removes an instance of a Player from the active SecurePlay library.

Parameters:
playerID String - id of the player to be removed
Returns:
boolean - TRUE, if successful, FALSE, if not

bool SecurePlayClass::APIsetLicenseInfo (  string  pocname,
string  company,
string  siteURL,
string  email,
string  SPSerialNumber,
string  SPLicenseKey
) 
 

Loads registered SecurePlay licensee information. Removal, modification, or disablement of this method or any other licensing code is a violation of the SecurePlay library license agreement. This method is used for Commercial Licenses. Simple Open Source licensees use the APIsetSOSLicenseInfo method.

Parameters:
pocname String - individual who represents the company
company String - company name.
siteURL String - company web site.
email String - company email.
SPSerialNumber String - serial number of the SecurePlay licensee
SPLicenseKey String - license key for the registered SecurePlay user.
Returns:
boolean - TRUE, if successful, FALSE, if not

bool SecurePlayClass::APIsetPlayerGameComms (  string  gid,
string  playerID,
string  commsID
) 
 

This method associates a specific comms service with a specific player and a specific game.

Parameters:
gid String - game id to which the players and comms will be set
playerID String - id of the player to be set
commsID String - id of th comms to be set
Returns:
boolean - TRUE, if successful, FALSE, if not

bool SecurePlayClass::checkLicense (   )  [protected]
 

This method is used to verify that the SecurePlay license information is provided completely and properly.

Returns:
boolean - TRUE, if license information is set properly. FALSE, if not

string SecurePlayClass::getCompany (   ) 
 

Getter function that returns the property: company

Returns:
String - company

string SecurePlayClass::getEmail (   ) 
 

Getter function that returns the property: email

Returns:
String - email

string SecurePlayClass::getPocname (   ) 
 

Getter function that returns the property: pocname

Returns:
String - the individual who is the contact for the SecurePlay license for use of the library.

SPMap< string, SPAbstractCommsInterface * > SecurePlayClass::getPrcommsServicesList (   )  [protected]
 

Getter function that returns the property: prcommsServicesList

Returns:
SPMap - prcommsServicesList

SPMap< string, SPGameInterface * > SecurePlayClass::getPrgamesList (   )  [protected]
 

Getter function that returns the property: prgamesList

Returns:
SPMap - prgamesList

vector< string > SecurePlayClass::getPrplayersList (   )  [protected]
 

Getter function that returns the property: prplayersList

Returns:
String[] - prgamesList

bool SecurePlayClass::isCommsIncluded (  string  cid  ) 
 

This method checks to see if the comms object exists in the comms list of this library.

Parameters:
cid String - the comms id to be checked
Returns:
boolean - TRUE, if successful, FALSE, if not successful

bool SecurePlayClass::isGameIncluded (  string  gid  ) 
 

This method checks to see if the game exists in the game list of this library.

Parameters:
gid String - the game id to be checked
Returns:
boolean - TRUE, if successful, FALSE, if not successful

bool SecurePlayClass::isInitialized (   ) 
 

Getter function that returns the property: initialized

Returns:
boolean - initialized?

bool SecurePlayClass::isPlayerIncluded (  string  pid  ) 
 

This method returns a boolean TRUE if there is a player object specified by the indicated Player ID is included in the Library instance.

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

string SecurePlayClass::releaseversion (   )  [static]
 

This method returns the current release verion of this library.

Returns:
String

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.