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

SecurePlayLibrary::SPTShipClass Class Reference

#include <SPTShipClass.h>

Inheritance diagram for SecurePlayLibrary::SPTShipClass:

SecurePlayLibrary::SPAbstractTransactionClass SecurePlayLibrary::SPRootTransactionClass SecurePlayLibrary::SPAbstractTransactionInterface List of all members.

Detailed Description

This transaction supports the distribution of Serializable Objects (Classes, Files, Etc.) as well as the slow, incremental distribution.
Author:
IT GlobalSecure
See also:
SecurePlay License Information


Public Member Functions

 SPTShipClass ()
 ~SPTShipClass ()
 SPTShipClass::SPTShipClass (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID)
bool APIconfigureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname)
bool APIconfigureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname, vector< byte > entireshipment)
bool APIrequestConfigureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname)
bool APIrequestConfigureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname, vector< byte > entireshipment)
bool configureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname)
bool SPTShipClass::APIsendShipment (string sender, vector< byte > manualShip)
bool SPTShipClass::onsendShipment (SPMessageClass *mess)

Static Public Member Functions

string gettranstype ()

Protected Member Functions

bool onconfigureTransaction (SPMessageClass *incoming)
void SPTShipClass::onrequestconfigureTransaction (SPMessageClass *incoming)

Private Attributes

bool entireShipmentFLAG
bool acknowledgeFLAG
bool manualSendFLAG
int buffersize
vector< byte > shipment
long totalSize
string ShippedObjectClass
string ShippedObjectDistinguishedName
vector< string > AckList
bool CompleteFlag
bool SendOKFlag
int maxReceiveSendStore
map< int, vector< byte > * > lastReceivedSent
int shipcount
int lastRecSent
long totalRecSent

Constructor & Destructor Documentation

SPTShipClass::SPTShipClass (   ) 
 

Default Constructor.

SPTShipClass::~SPTShipClass (   ) 
 

Default Destructor

Member Function Documentation

bool SPTShipClass::APIconfigureTransaction (  string  sender,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname,
vector< byte >  entireshipment
) 
 

Configure transaction method. This method configures with the entire shipment set. Because entire shipment is set the manual flag can be either true or false.

Parameters:
sender string - player id who is configuring this transaction.
AckFlag bool - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.
ManFlag bool - manual flag, flag for manual or automatic shipment sending.
bsize int - buffer size.
tsize long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)
classname string - class name.
instname string - instance name.
entireshipment byte[] - the entire shipment.
Returns:
bool

bool SPTShipClass::APIconfigureTransaction (  string  sender,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname
) 
 

Configure transaction method. This method configures without the entire shipment set. Because entire shipment is not set manual flag is set to true.

Parameters:
sender String - player id who is configuring this transaction.
AckFlag boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.
bsize int - buffer size.
tsize long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)
classname String - class name.
instname String - instance name.
Returns:
boolean

bool SPTShipClass::APIrequestConfigureTransaction (  string  sender,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname,
vector< byte >  entireshipment
) 
 

Configure transaction method. This method requests to configures with the entire shipment set. Because entire shipment is set the manual flag can be either true or false.

Parameters:
sender string - player id who is configuring this transaction.
AckFlag bool - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.
ManFlag bool - manual flag, flag for manual or automatic shipment sending.
bsize int - buffer size.
tsize long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)
classname string - class name.
instname string - instance name.
entireshipment byte[] - the entire shipment.
Returns:
bool

bool SPTShipClass::APIrequestConfigureTransaction (  string  sender,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname
) 
 

Configure transaction method. This method requests to configures without the entire shipment set. Because entire shipment is not set manual flag is set to true.

Parameters:
sender String - player id who is configuring this transaction.
AckFlag boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.
bsize int - buffer size.
tsize long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)
classname String - class name.
instname String - instance name.
Returns:
boolean

bool SPTShipClass::configureTransaction (  string  sender,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname
) 
 

This method just sets the configure parameter of this class much like a setter function. It is used by the configure methods.

Parameters:
sender string - player id of the player who authorized this configure.
AckFlag bool - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.
ManFlag bool - manual flag, flag for manual or automatic shipment sending.
bsize int - buffer size.
tsize long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)
classname string - class name.
instname string - instance name.
Returns:
bool

string SPTShipClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTShipClass::onconfigureTransaction (  SPMessageClass *  incoming  )  [protected]
 

This method configures this transaction when a configure transaction message is recieved.

Parameters:
incoming SPMessageClass - the incoming configure transaction message.
Returns:
bool

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SecurePlayLibrary::SPTShipClass::SPTShipClass::APIsendShipment (  string  sender,
vector< byte >  manualShip
) 
 

This method sends a shipment manually.

Parameters:
sender String - sender of this shipment (master of the transaction)
manualShip byte[] - the shipment to be sent.
Returns:
boolean

void SecurePlayLibrary::SPTShipClass::SPTShipClass::onrequestconfigureTransaction (  SPMessageClass *  incoming  )  [protected]
 

This method safely handles a request from a player who is not the Transaction master to configure the transaction.

Parameters:
incoming SPMessageClass - incomng message

bool SecurePlayLibrary::SPTShipClass::SPTShipClass::onsendShipment (  SPMessageClass *  mess  ) 
 

This method recieves shipmetns. It sends acknowledgements to the sender.

Parameters:
mess SPMessageClass - the message that contains the shipment.
Returns:
boolean

SecurePlayLibrary::SPTShipClass::SPTShipClass::SPTShipClass (  SPGameInterface *  gameobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  transactionID
) 
 

Construcotr.

Parameters:
gameobj SPGameInterface - game associated with this transaction.
master string - the master of this transaction.
playerIDList string[] - player id list of player who are included in this transaction.
privateflag bool - private flag.
transactionID string - transactino id.

Member Data Documentation

vector<string> SecurePlayLibrary::SPTShipClass::AckList [private]
 

This holds the list of SUCCESSFUL acknowledge messages for the current shipment

bool SecurePlayLibrary::SPTShipClass::acknowledgeFLAG [private]
 

This flag determines whether sent packages need to be acknowledged.

int SecurePlayLibrary::SPTShipClass::buffersize [private]
 

This property determines the maximum size of the shipment that is sent at one time. If it is set to equal 0, then nothing is stored and all is sent. NOTE: does not make sense to set it to if you are in manual mode, works only with automatic mode.

bool SecurePlayLibrary::SPTShipClass::CompleteFlag [private]
 

Flag to indicate shipment complete

bool SecurePlayLibrary::SPTShipClass::entireShipmentFLAG [private]
 

This flag indicates whether or not entire shipment is stored.

map<int, vector<byte>*> SecurePlayLibrary::SPTShipClass::lastReceivedSent [private]
 

This stores the last recieved acknowledgement. This can be stored in Array of byte arrays.

int SecurePlayLibrary::SPTShipClass::lastRecSent [private]
 

This value holds the last shipment part number sent.

bool SecurePlayLibrary::SPTShipClass::manualSendFLAG [private]
 

This flag determines whether MANUAL send is in use. (TRUE: Manual; FALSE: Automatic)

int SecurePlayLibrary::SPTShipClass::maxReceiveSendStore [private]
 

Maximum acknowledged messages receivecount.

bool SecurePlayLibrary::SPTShipClass::SendOKFlag [private]
 

Flag, ready to send

int SecurePlayLibrary::SPTShipClass::shipcount [private]
 

This value holds the number of shipments SUCCESSFULLY SENT!

vector<byte> SecurePlayLibrary::SPTShipClass::shipment [private]
 

This holds the currently active/sent shipment - it is held until all Acks are received

string SecurePlayLibrary::SPTShipClass::ShippedObjectClass [private]
 

This is the name of the Class that Shipped Object is from.

string SecurePlayLibrary::SPTShipClass::ShippedObjectDistinguishedName [private]
 

This is the senders unique name for the class (optional)

long SecurePlayLibrary::SPTShipClass::totalRecSent [private]
 

This value holds the total number of bytes recieved or sent. NOTE: the total size is limited by the size of the int, because array types can only support ints as index.

long SecurePlayLibrary::SPTShipClass::totalSize [private]
 

This value holds the total size of shipment. NOTE: the total size is limited by the size of the int, because array types can only support ints as index.

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.