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

#include <SPCommsManagerClass.h>

Inheritance diagram for SecurePlayLibrary::SPCommsManagerClass:

SecurePlayLibrary::SPCommsManagerCommsInterface List of all members.

Public Member Functions

 SPCommsManagerClass (SPGameInterface *gameobj, SPLogInterface *log, SPSecurityManagerInterface *security)
void startCommsManager ()
bool setSecurityPolicy (bool sign, bool encrypt)
SPAbstractCommsInterface * getComms (string commsID)
bool addComms (string commsID)
bool removeComms (string cid)
bool getEncryptPolicy ()
bool getSignaturePolicy ()
bool endGameComms ()
bool setPlayerComms (string pid, string cid)
void removePlayer (string playerID)
string UpdateCommsStatus ()
void sendMessage (string gid, string tid, string sender, vector< string > receivers, bool encryptflag, bool aprivateflag, string messagetype, string messID, vector< string > messagebody, vector< string > altmessage)
void receiveMessage (SPMessageClass *incoming)
string getCommsStatus ()
bool isPlayerInternal (string pid)
SPGameInterface * getGameinstance ()
vector< string > getInternalplayerIDList ()
SPLogInterface * getMessagelog ()
SPMap< string, string > getPlayerCommsList ()
vector< string > getPrcommsIDList ()
SPMap< string, SPAbstractCommsInterface * > getPrcommsServList ()
SPSecurityManagerInterface * getSecurityManager ()
bool APIActivate ()
bool APIDeactivate ()
virtual DWORD Run (LPVOID)

Detailed Description

This class manages the communications and various communications services. It is essentially the "router" for the game data.
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPCommsManagerClass::SPCommsManagerClass (  SPGameInterface *  gameobj,
SPLogInterface *  log,
SPSecurityManagerInterface *  security
) 
 

Overloaded Constructor.

Parameters:
gameobj - SPGameInterface - game instance object
log SPLogInterface - log class associated with this comms manager.
security SPSecurityManagerInterface - security manager associated with this comms manager.

Member Function Documentation

bool SPCommsManagerClass::addComms (  string  commsID  ) 
 

This method safely adds an available comms service to the game instance.

Parameters:
commsID String - comms service identifier string
Returns:
result - Boolean: TRUE, if successful, FALSE, if not.

bool SPCommsManagerClass::APIActivate (   ) 
 

This method activates the thread

Returns:
boolean

bool SPCommsManagerClass::APIDeactivate (   ) 
 

This method deactivates the thread

Returns:
boolean

bool SPCommsManagerClass::endGameComms (   ) 
 

This method safely ends the game comms session. NOTE: it will not stop incoming messages, only outgoing or relayed messages.

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

SPAbstractCommsInterface * SPCommsManagerClass::getComms (  string  commsID  ) 
 

This method safely returns one of the comms services objects associated with this game instance.

Parameters:
commsID String - id of the comms to be retrieved
Returns:
Object - SPAbstractCommsInterface - comms service object handler

string SPCommsManagerClass::getCommsStatus (   ) 
 

Gets the comms status.

Returns:
prcommsstatus - String - comms status

bool SPCommsManagerClass::getEncryptPolicy (   ) 
 

This method returns the encryption policy flag.

Returns:
result - Boolean: TRUE, if flag set, FALSE, if not.

SPGameInterface * SPCommsManagerClass::getGameinstance (   ) 
 

Getter function that returns the property:

Returns:
gameinstance - SPGameInterface

vector< string > SPCommsManagerClass::getInternalplayerIDList (   ) 
 

Getter function that returns the property: internalplayerIDList

Returns:
internalplayerIDList - String[]

SPLogInterface * SPCommsManagerClass::getMessagelog (   ) 
 

Getter function that returns the property: messagelog

Returns:
messagelog - SPLogInterface

SPMap< string, string > SPCommsManagerClass::getPlayerCommsList (   ) 
 

Getter function that returns the property: playerCommsList

Returns:
playerCommsList - SPMap

vector< string > SPCommsManagerClass::getPrcommsIDList (   ) 
 

Getter function that returns the property: prcommsIDList

Returns:
prcommsIDList - String[]

SPMap< string, SPAbstractCommsInterface * > SPCommsManagerClass::getPrcommsServList (   ) 
 

Getter function that returns the property: prcommsServList

Returns:
prcommsServList - SPHashtable

SPSecurityManagerInterface * SPCommsManagerClass::getSecurityManager (   ) 
 

bool SPCommsManagerClass::getSignaturePolicy (   ) 
 

This method returns the Signature Policy flag for the game instance.

Returns:
result - Boolean, TRUE, if flag set, FALSE, if not.

bool SPCommsManagerClass::isPlayerInternal (  string  pid  ) 
 

Checks to see if the player is internal to the game.

Parameters:
pid String - the player id
Returns:
result - boolean:

void SPCommsManagerClass::receiveMessage (  SPMessageClass *  incoming  )  [virtual]
 

This method safely receives and routes incoming messages. Only proper, valid messages will be sent on to transactions for processing.

Parameters:
incoming SPMessageClass - incoming message
Returns:
Boolean - TRUE, if successful, FALSE, if not.

Implements SecurePlayLibrary::SPCommsManagerCommsInterface.

bool SPCommsManagerClass::removeComms (  string  cid  ) 
 

This method safely removes comms service from the game instance.

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

void SPCommsManagerClass::removePlayer (  string  playerID  ) 
 

This method safely removes a player from the game instance's comms.

Parameters:
playerID String - id of the player to be removed

virtual DWORD SecurePlayLibrary::SPCommsManagerClass::Run (  LPVOID   )  [inline, virtual]
 

This method activates the thread

void SPCommsManagerClass::sendMessage (  string  gid,
string  tid,
string  sender,
vector< string >  receivers,
bool  encryptflag,
bool  aprivateflag,
string  messagetype,
string  messID,
vector< string >  messagebody,
vector< string >  altmessage
) 
 

This method manages actually sending messages to other game instances via communication services objects. Also, for private messages, it sends an alternate message to the parties not recieving the main message.

Parameters:
gid 
tid 
sender 
receivers 
encryptflag 
aprivateflag 
messagetype 
messID 
messagebody 
altmessage 
Returns:
result - Boolean: TRUE, if successful, FALSE, if not.

bool SPCommsManagerClass::setPlayerComms (  string  pid,
string  cid
) 
 

This method safely associates a Player with a comms service and enables relay support for that player via that comms service.

Parameters:
pid String - player id to be set
cid String - comms id to be set
Returns:
result - Boolean: TRUE, if successful, FALSE, if not.

bool SPCommsManagerClass::setSecurityPolicy (  bool  sign,
bool  encrypt
) 
 

This method safely sets the security policy (encryption and signatures, for the game instance).

Parameters:
sign boolean - Signature policy
encrypt boolean - encryption policy
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

void SPCommsManagerClass::startCommsManager (   ) 
 

initialize the message log with licensing information

string SPCommsManagerClass::UpdateCommsStatus (   ) 
 

This method reviews and updates the status of the comms instance.

Returns:
prcommsstatus - String - the updated prcommsstatus property

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.