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

#include <SPAbstractCommsClass.h>

Inheritance diagram for SecurePlayLibrary::SPAbstractCommsClass:

SecurePlayLibrary::SPAbstractCommsInterface SecurePlayLibrary::SPCLocalCommsClass SecurePlayLibrary::SPCLocalCommsFileClass List of all members.

Public Member Functions

 SPAbstractCommsClass ()
bool setcommsID (string cid)
string getCommsServiceType ()
bool addGame (string gid, SPCommsManagerCommsInterface *gamcomobj)
bool removeGame (string gid)
bool APIconfigureCommService ()
bool addPlayer (string pid, string gid)
bool removePlayer (string pid, string gid)
int sendMessage (SPMessageClass *clearmessage, SPMessageClass *alternatemessage)
bool APIactivate ()
bool APIdeactivate ()
void logError ()
string getCommsID ()
SPMap< string, vector< string > * > getGameplayerList ()
vector< string > getInternalGameIDList ()
SPMap< string, SPCommsManagerCommsInterface * > getPrinternalGameList ()
bool isGameInternal (string gid)
void processincoming (SPMessageClass *inmess)

Public Attributes

const string commstype

Protected Member Functions

bool prsend (vector< SPbyte > message)
void incoming ()
bool prreceive (vector< SPbyte > message)
int includedPlayerCount (vector< string > playerarray, string gid)

Detailed Description

This is the SuperClass for comms services classes.
Author:
IT GlobaLSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPAbstractCommsClass::SPAbstractCommsClass (   ) 
 

Default Construtor

Member Function Documentation

bool SPAbstractCommsClass::addGame (  string  gid,
SPCommsManagerCommsInterface *  gamcomobj
)  [virtual]
 

This method adds an internal game to a specific comms service. The connection is to the SPComms class associated with the game to allow incoming messages to be serviced.

Parameters:
gid String - game id
gamcomobj SPCommsManagerCommsInterface - the comms object to be added to a game
Returns:
boolean - TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractCommsInterface.

bool SPAbstractCommsClass::addPlayer (  string  pid,
string  gid
)  [virtual]
 

This method adds a player ID of a remote player serviced by this comm service.

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

Implements SecurePlayLibrary::SPAbstractCommsInterface.

bool SPAbstractCommsClass::APIactivate (   ) 
 

OPTIONAL - This is a shell method to trigger the activation of a comms service, if necessary.

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

Reimplemented in SecurePlayLibrary::SPCLocalCommsClass, and SecurePlayLibrary::SPCLocalCommsFileClass.

bool SPAbstractCommsClass::APIconfigureCommService (   ) 
 

This method configures a comm service instance. The parameters are variable depending on the specific service. (this is a shell method It returns true if successful, false, if not.)

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

bool SPAbstractCommsClass::APIdeactivate (   ) 
 

OPTIONAL - This shell method is used to deactivate a comms service once it is no longer needed. Depending on the comms service, this method may not be necessary

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

Reimplemented in SecurePlayLibrary::SPCLocalCommsClass, and SecurePlayLibrary::SPCLocalCommsFileClass.

string SPAbstractCommsClass::getCommsID (   )  [virtual]
 

Getter function that returns the property: commsID

Returns:
commsid - String - the comms id.

Implements SecurePlayLibrary::SPAbstractCommsInterface.

string SPAbstractCommsClass::getCommsServiceType (   )  [virtual]
 

This method returns a unique identifier for the type of comms service instance.

Returns:
"abstract" - String - unique identifier for type of comms service

Implements SecurePlayLibrary::SPAbstractCommsInterface.

Reimplemented in SecurePlayLibrary::SPCLocalCommsFileClass.

SPMap< string, vector< string > * > SPAbstractCommsClass::getGameplayerList (   )  [virtual]
 

Getter function that returns the property: gameplayerList

Returns:
gameplayerList - SPMap

Implements SecurePlayLibrary::SPAbstractCommsInterface.

vector< string > SPAbstractCommsClass::getInternalGameIDList (   )  [virtual]
 

Getter function that returns the property: internalGameIDList

Returns:
internalGameIDList - String[]

Implements SecurePlayLibrary::SPAbstractCommsInterface.

SPMap< string, SPCommsManagerCommsInterface * > SPAbstractCommsClass::getPrinternalGameList (   )  [virtual]
 

Getter function that returns the property: printernalGameList

Returns:
printernalGameList - SPMap

Implements SecurePlayLibrary::SPAbstractCommsInterface.

int SPAbstractCommsClass::includedPlayerCount (  vector< string >  playerarray,
string  gid
)  [protected]
 

This method returns a number based on the input array to indicate how many of the input array's player IDs are included in the comms service playerIDList

Parameters:
playerarray String[] - player id list
gid String - the game id
Returns:
int - the number of players supported by the Comms Service in the input playerID array.

void SPAbstractCommsClass::incoming (   )  [protected]
 

This is a shell method placeholder for the actual processing of incoming data/datastreams/messages from a network.

bool SPAbstractCommsClass::isGameInternal (  string  gid  )  [virtual]
 

This method returns whether a game is handled internally by a comms service

Parameters:
gid - String
Returns:
boolean - True if game is internal and supported by Comms Service

Implements SecurePlayLibrary::SPAbstractCommsInterface.

void SPAbstractCommsClass::logError (   ) 
 

This is a shell for future error log.

void SPAbstractCommsClass::processincoming (  SPMessageClass *  inmess  ) 
 

This method processes the incoming message.

Parameters:
inmess SPMessageClass - the incoming message

bool SPAbstractCommsClass::prreceive (  vector< SPbyte >  message  )  [protected]
 

This standard method handles incoming serialized messages that have been separated out of incoming data streams by the incoming method. It parses them into Message Objects and passes them on to the Game Instance.

Parameters:
message String - the incoming message
Returns:
result - Boolean: TRUE, if successfully handled, FALSE, if not.

bool SPAbstractCommsClass::prsend (  vector< SPbyte >  message  )  [protected]
 

This is a shell method for the actual transmission of a serialized message over a network using a specific communications transport.

Parameters:
message String - the message to be sent
Returns:
true - Boolean: TRUE, if successful, FALSE, if not.

Reimplemented in SecurePlayLibrary::SPCLocalCommsClass, and SecurePlayLibrary::SPCLocalCommsFileClass.

bool SPAbstractCommsClass::removeGame (  string  gid  )  [virtual]
 

This method removes the association of a game with the comms service. NOTE: actually the association that is removed is with the game instance's SPComms class instance.

Parameters:
gid String - game id
Returns:
boolean - TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractCommsInterface.

bool SPAbstractCommsClass::removePlayer (  string  pid,
string  gid
)  [virtual]
 

This method removes a player from the list of remote players served by this comm service.

Parameters:
pid String - player id to ber removed.
gid String - game id from which the player is to be removed.
Returns:
result - Boolean: TRUE, if successful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractCommsInterface.

int SPAbstractCommsClass::sendMessage (  SPMessageClass *  clearmessage,
SPMessageClass *  alternatemessage
)  [virtual]
 

This method returns a number based on the input array to indicate how many of the input array's player IDs are included in the comms service playerIDList (This method takes the message and sends it over the network, if they are served by this comms service.)

Parameters:
clearmessage SPMessageClass - message for receivers
alternatemessage SPMessageClass - message or other game players
Returns:
integer - int - Number of remote players that were handled by this comm service for the message (or the number of players supported by the Comms Service in the input playerID array.)

Implements SecurePlayLibrary::SPAbstractCommsInterface.

bool SPAbstractCommsClass::setcommsID (  string  cid  )  [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:
cid String - comms id
Returns:
boolean: TRUE, if succesful, FALSE, if not

Implements SecurePlayLibrary::SPAbstractCommsInterface.

Member Data Documentation

const string SecurePlayLibrary::SPAbstractCommsClass::commstype
 

Type of Comms Service

Reimplemented in SecurePlayLibrary::SPCLocalCommsClass.

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.