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

#include <SPCLocalCommsFileClass.h>

Inheritance diagram for SecurePlayLibrary::SPCLocalCommsFileClass:

SecurePlayLibrary::SPAbstractCommsClass SecurePlayLibrary::SPAbstractCommsInterface List of all members.

Public Member Functions

 SPCLocalCommsFileClass ()
string getCommsServiceType ()
bool prsend (vector< SPbyte > message)
bool APIactivate ()
bool APIdeactivate ()
void incoming (vector< SPbyte > message)
void run ()
bool isCommsIncluded (string cid)
bool APIsetDirPath (string str)
bool APIconfigureCommService (int pollp)
bool initializetest ()

Detailed Description

This class handles communications between multiple instances of the SecurePlay library on a single computer. This is an easy way to test or implement multiplayer games with a single design. This version uses files to exchange data rather than simply instances so that it can be used with different sessions or different languages, if message encodings are uniform.
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPCLocalCommsFileClass::SPCLocalCommsFileClass (   ) 
 

Default Constructor

Member Function Documentation

bool SPCLocalCommsFileClass::APIactivate (   ) 
 

This method adds the Local Comms instance to the set of active Local Comms objects so it will receive incoming messages

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

Reimplemented from SecurePlayLibrary::SPAbstractCommsClass.

bool SPCLocalCommsFileClass::APIconfigureCommService (  int  pollp  ) 
 

Configures the comms service.

Parameters:
pollp int - the polling period to be scheduled to.
Returns:
boolean Boolean: TRUE, if successful, FALSE, if not successful

bool SPCLocalCommsFileClass::APIdeactivate (   ) 
 

This method removes the Local Comms instance from the set of active local Comms objects so it can no longer send or receive messages NOTE: Deactivate for threads does not actually delete the thread.

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

Reimplemented from SecurePlayLibrary::SPAbstractCommsClass.

bool SPCLocalCommsFileClass::APIsetDirPath (  string  str  ) 
 

This method sets the directory path for the various local comms classes that communicate via shared files

Parameters:
str - proposed directory path
Returns:
boolean - true, if successful

string SPCLocalCommsFileClass::getCommsServiceType (   )  [virtual]
 

This method gets the comms service type

Returns:
"local" - String - local

Reimplemented from SecurePlayLibrary::SPAbstractCommsClass.

void SPCLocalCommsFileClass::incoming (  vector< SPbyte >  message  ) 
 

This method handles incoming messages and passes them on for processing by the various games associated with the Local Comms instance.

Parameters:
message - String - message

bool SPCLocalCommsFileClass::initializetest (   ) 
 

Tests to see if everything is set for intialization

Returns:
boolean Boolean: TRUE, if successful, FALSE, if not successful

bool SPCLocalCommsFileClass::isCommsIncluded (  string  cid  ) 
 

Checks to see if the Comms id specified is already included.

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

bool SPCLocalCommsFileClass::prsend (  vector< SPbyte >  message  ) 
 

This method sends messages to each of the registered Local Comms instances

Parameters:
message String - the message to be sent.
Returns:
boolean - true, if successful

Reimplemented from SecurePlayLibrary::SPAbstractCommsClass.

void SPCLocalCommsFileClass::run (   ) 
 

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.