Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

SecurePlayLibrary::SPAbstractCommsInterface Class Reference

#include <SPAbstractCommsInterface.h>

Inheritance diagram for SecurePlayLibrary::SPAbstractCommsInterface:

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

Detailed Description

This is the interface for all comms services classes.
Author:
IT GlobalSecure
See also:
SecurePlay License Information


Public Member Functions

virtual ~SPAbstractCommsInterface ()
virtual bool setcommsID (string cid)=0
virtual string getCommsServiceType ()=0
virtual bool addGame (string gid, SPCommsManagerCommsInterface *gamcomobj)=0
virtual bool removeGame (string gid)=0
virtual bool addPlayer (string pid, string gid)=0
virtual bool removePlayer (string pid, string gid)=0
virtual int sendMessage (SPMessageClass *clearmessage, SPMessageClass *alternatemessage)=0
virtual int sendMessage (vector< string > receivers, SPMessageClass *clearmessage, SPMessageClass *alternatemessage)=0
virtual string getCommsID ()=0
virtual bool isGameInternal (string gid)=0
virtual map< string, vector<
string > * > 		getGameplayerList ()=0
virtual vector< string > getInternalGameIDList ()=0
virtual map< string, SPCommsManagerCommsInterface * > getPrinternalGameList ()=0

Constructor & Destructor Documentation

virtual SecurePlayLibrary::SPAbstractCommsInterface::~SPAbstractCommsInterface (   )  [inline, virtual]
 

Virtual Destructor.

Member Function Documentation

virtual bool SecurePlayLibrary::SPAbstractCommsInterface::addGame (  string  gid,
SPCommsManagerCommsInterface *  gamcomobj
)  [pure 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 SPCommsManagerClass* - the comms object to be added to a game
Returns:
bool: TRUE, if successful, FALSE, if not

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual bool SecurePlayLibrary::SPAbstractCommsInterface::addPlayer (  string  pid,
string  gid
)  [pure 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:
result - bool: TRUE, if successful, FALSE, if not

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual string SecurePlayLibrary::SPAbstractCommsInterface::getCommsID (   )  [pure virtual]
 

Gets the comms id.

Returns:
string - comms id.

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual string SecurePlayLibrary::SPAbstractCommsInterface::getCommsServiceType (   )  [pure virtual]
 

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

Returns:
string - unique identifier for type of comms service

Implemented in SecurePlayLibrary::SPAbstractCommsClass, and SecurePlayLibrary::SPCLocalCommsFileClass.

virtual map<string, vector<string>*> SecurePlayLibrary::SPAbstractCommsInterface::getGameplayerList (   )  [pure virtual]
 

Getter function that returns the property: gameplayerList

Returns:
map<string, vector<string>*> - game player list.

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual vector<string> SecurePlayLibrary::SPAbstractCommsInterface::getInternalGameIDList (   )  [pure virtual]
 

Getter function that returns the property: internalGameIDList

Returns:
vector<string>

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual map<string, SPCommsManagerCommsInterface*> SecurePlayLibrary::SPAbstractCommsInterface::getPrinternalGameList (   )  [pure virtual]
 

Getter function that returns the property: printernalGameList

Returns:
map<string, SPCommsManagerCommsInterface*>

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual bool SecurePlayLibrary::SPAbstractCommsInterface::isGameInternal (  string  gid  )  [pure virtual]
 

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

Parameters:
gid string - game id
Returns:
bool - True if game is internal and supported by Comms Service

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual bool SecurePlayLibrary::SPAbstractCommsInterface::removeGame (  string  gid  )  [pure 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:
bool - TRUE, if successful, FALSE, if not

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual bool SecurePlayLibrary::SPAbstractCommsInterface::removePlayer (  string  pid,
string  gid
)  [pure 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:
bool: TRUE, if successful, FALSE, if not

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual int SecurePlayLibrary::SPAbstractCommsInterface::sendMessage (  vector< string >  receivers,
SPMessageClass *  clearmessage,
SPMessageClass *  alternatemessage
)  [pure 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 is depreceated and will be removed in a future version of the software (This method takes the message and sends it over the network, if they are served by this comms service.)

Parameters:
receivers vector<string> - array of playerIDs
clearmessage SPMessageClass* - message for receivers
alternatemessage SPMessageClass* - message or other game players
Returns:
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.)

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

virtual int SecurePlayLibrary::SPAbstractCommsInterface::sendMessage (  SPMessageClass *  clearmessage,
SPMessageClass *  alternatemessage
)  [pure 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:
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.)

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

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

Implemented in SecurePlayLibrary::SPAbstractCommsClass.

The documentation for this class was generated from the following file: 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.