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

#include <SPCGenericCommsDriverClass.h>

Inheritance diagram for SecurePlayLibrary::SPCGenericCommsDriverClass:

SecurePlayLibrary::SPCcommsTCP SecurePlayLibrary::SPCcommsHTTP SecurePlayLibrary::SPCcommsTCPclient SecurePlayLibrary::SPCcommsTCPserver SecurePlayLibrary::SPCcommsHTTPclient SecurePlayLibrary::SPCcommsHTTPserver List of all members.

Public Member Functions

 SPCGenericCommsDriverClass (bool push, bool relay)
bool isPush ()
bool isRelay ()
bool isConfigured ()
bool isReady ()
bool addAddress (string address, bool relayIN)
bool removeAddress (string address)
bool clearAddresses ()
vector< string > getAddressList ()
string getCommsDriverType ()
bool prsend (string address, vector< SPbyte > messages)
bool sendMessage (vector< string > addresses, vector< SPbyte > messages)
bool sendFromQMessages (string address)
bool prpoll (string address)
SPCGenericCommsServerClass getServer ()
bool containsAddress (string address)
void SPincoming (vector< SPbyte > message)
SPMessageClass[] MessArrAddMessArr (SPMessageClass[] m1, SPMessageClass[] m2)
void SPdeserializeProcessByteArr (vector< SPbyte > mess)
bool addressSupportsRelay (string address)

Protected Member Functions

vector< SPbyte > SPserialize (SPMessageClass[] message)
vector< SPbyte > SPserialize (SPMessageClass message)

Protected Attributes

SPCGenericCommsServerClass commsServer

Detailed Description

Generic Comms Driver class. This class is used as a generic driver that can be configured to support specific comms driver. It support basic comms functionalities.
Author:
IT GlobalSecure
See also:
SecurePlay License Information

Constructor & Destructor Documentation

SPCGenericCommsDriverClass::SPCGenericCommsDriverClass (  bool  push,
bool  relay
) 
 

This is the constructor for the generic Comms Driver

Parameters:
push - boolean - whether the comms is configured for push commications
relay - boolean - whether the comms supports relay

Member Function Documentation

bool SPCGenericCommsDriverClass::addAddress (  string  address,
bool  relayIN
) 
 

This method adds and address to this driver.

Parameters:
address String - address to be added
Returns:
boolean

bool SPCGenericCommsDriverClass::addressSupportsRelay (  string  address  ) 
 

This method checks if the address is in the relaySupportAddresses in other words does the address support relay.

Parameters:
address 
Returns:
boolean

bool SPCGenericCommsDriverClass::clearAddresses (   ) 
 

Cleanrs all addresses.

Returns:
boolean

bool SPCGenericCommsDriverClass::containsAddress (  string  address  ) 
 

Checks to see if the specified address exists in the address list.

Parameters:
address String - address to be checked.
Returns:
boolean

vector< string > SPCGenericCommsDriverClass::getAddressList (   ) 
 

This method returns the address list.

Returns:
String[]

string SPCGenericCommsDriverClass::getCommsDriverType (   ) 
 

This method returns the driver type. It will be overridden with specific driver type.

Returns:
String

Reimplemented in SecurePlayLibrary::SPCcommsHTTP, SecurePlayLibrary::SPCcommsHTTPclient, SecurePlayLibrary::SPCcommsHTTPserver, SecurePlayLibrary::SPCcommsTCP, SecurePlayLibrary::SPCcommsTCPclient, and SecurePlayLibrary::SPCcommsTCPserver.

SPCGenericCommsServerClass SPCGenericCommsDriverClass::getServer (   ) 
 

Returns the comms server.

Returns:
SPCGenericCommsServer

bool SPCGenericCommsDriverClass::isConfigured (   ) 
 

Returns the configured flag.

Returns:
boolean

bool SPCGenericCommsDriverClass::isPush (   ) 
 

Returns push flag. True: push False: poll

Returns:
boolean

bool SPCGenericCommsDriverClass::isReady (   ) 
 

Checks to see if every address has a unique address set.

Returns:
boolean

Reimplemented in SecurePlayLibrary::SPCcommsTCP.

bool SPCGenericCommsDriverClass::isRelay (   ) 
 

Returns relay flag.

Returns:
boolean

SPMessageClass[] SPCGenericCommsDriverClass::MessArrAddMessArr (  SPMessageClass[]  m1,
SPMessageClass[]  m2
) 
 

Utility function used to add message arrays to message arrays.

Parameters:
m1 SPMessageClass[] - message array to be added
m2 SPMessageClass[] - message array to be added
Returns:
SPMessageClass[]

bool SPCGenericCommsDriverClass::prpoll (  string  address  ) 
 

Sends a poll request message to the reciever.

Parameters:
address String - address the poll request message will be sent to.
Returns:
boolean

Reimplemented in SecurePlayLibrary::SPCcommsHTTPclient, and SecurePlayLibrary::SPCcommsTCPclient.

bool SPCGenericCommsDriverClass::prsend (  string  address,
vector< SPbyte >  messages
) 
 

This method sends the messages to others. It will be overriden by specific comms drivers.

Parameters:
address String - address to which these messages will be sent.
messages byte[] - messages to be sent. void

Reimplemented in SecurePlayLibrary::SPCcommsHTTPclient, SecurePlayLibrary::SPCcommsHTTPserver, and SecurePlayLibrary::SPCcommsTCP.

bool SPCGenericCommsDriverClass::removeAddress (  string  address  ) 
 

This method removes this address form this driver.

Parameters:
address String - address to be removed.
Returns:
boolean

bool SPCGenericCommsDriverClass::sendFromQMessages (  string  address  ) 
 

Sends the messages from the que to the address. The que for that address is cleared.

Parameters:
address String - address where the messages are going.
Returns:
boolean

bool SPCGenericCommsDriverClass::sendMessage (  vector< string >  addresses,
vector< SPbyte >  messages
) 
 

This method sends messages to the recievers.

Parameters:
addresses String[] - list of addresses or recievers.
messages SPMessageClass[] - messages to be sent
Returns:
boolean

void SPCGenericCommsDriverClass::SPdeserializeProcessByteArr (  vector< SPbyte >  mess  ) 
 

Deserializes a byte array of byte array messages. Passes the deserialized byte array messages to appropriate methods. Ex: If the message is double passes it to method that handles double.

Parameters:
mess 

void SPCGenericCommsDriverClass::SPincoming (  vector< SPbyte >  message  ) 
 

Incoming method that recieves a byte[] and deserializes it and processes it.

Parameters:
message byte[] - byte array that is incoming. void

Reimplemented in SecurePlayLibrary::SPCcommsTCPserver.

vector< SPbyte > SPCGenericCommsDriverClass::SPserialize (  SPMessageClass  message  )  [protected]
 

Serializes one message.

Parameters:
message SPMessageClass - message to be serialized.
Returns:
byte[]

vector< SPbyte > SPCGenericCommsDriverClass::SPserialize (  SPMessageClass[]  message  )  [protected]
 

Serializes these messages to byte[].

Parameters:
message SPMessageClass[] - messages to be serialized.
Returns:
byte[]

Member Data Documentation

SPCGenericCommsServerClass SPCGenericCommsDriverClass::commsServer [protected]
 

Generic comms server associated with this driver.

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.