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

#include <SPTShipClass.h>

Inheritance diagram for SecurePlayLibrary::SPTShipClass:

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

Public Member Functions

 SPTShipClass ()
 SPTShipClass (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID, string AGE, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname, vector< SPbyte > entireshipment)
bool APIsendShipment (string sender, vector< SPbyte > manualShip)
bool APIsendShipment (string sender)
bool APIrequestsendShipment (string sender)
bool APIresendShipment (string sender, int shipcount, vector< string > recieverIdList)
bool pronincomingTransaction (SPMessageClass *incoming)
vector< string > getAckList ()
bool isAcknowledgeFLAG ()
int getBuffersize ()
bool isCompleteFlag ()
bool isEntireShipmentFLAG ()
SPMap< int, vector< SPbyte > * > APIgetLastReceivedSent ()
bool APIsetMaxRecieve (int i)
int getLastRecSent ()
bool isManualSendFLAG ()
int getMaxReceiveSendStore ()
bool isSendOKFlag ()
int APIgetShipcount ()
vector< SPbyte > APIgetLastShipment ()
vector< SPbyte > APIgetEntireShipment ()
vector< SPbyte > APIgetShipment (int i)
string getShippedObjectClass ()
string getShippedObjectDistinguishedName ()
long getTotalSize ()
long getTotalRecSent ()
SPAbstractTransactionInterface * APIcreateTransaction (SPGameInterface *gameapiobj, SPMessageClass *message)
string APIgetTransactionType ()

Static Public Member Functions

string gettranstype ()
bool registerTransaction ()
SPAbstractTransactionInterface * createShip (SPGameInterface *gameobj, string master, vector< string > playerIDList, bool privateflag, string AGE, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname, vector< SPbyte > entireshipment)

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

Constructor & Destructor Documentation

SPTShipClass::SPTShipClass (   ) 
 

Default Constructor

SPTShipClass::SPTShipClass (  SPGameInterface *  gameobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  transactionID,
string  AGE,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname,
vector< SPbyte >  entireshipment
) 
 

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 boolean - private flag.
transactionID String - transactino id.

Member Function Documentation

SPAbstractTransactionInterface * SPTShipClass::APIcreateTransaction (  SPGameInterface *  gameapiobj,
SPMessageClass *  message
)  [virtual]
 

Creates a new instance of an SPSecretClass class.

Parameters:
gameapiobj SPGameInterface - game associated with this transaction.
message SPMessageClass - message that has all the transaction configure info
Returns:
SPAbstractTransactionInterface

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

vector< SPbyte > SPTShipClass::APIgetEntireShipment (   ) 
 

This method returns the entire shipment, if possible.

Returns:
byte[]

SPMap< int, vector< SPbyte > * > SPTShipClass::APIgetLastReceivedSent (   ) 
 

Returns:
Returns the lastreceived series of shipments.

vector< SPbyte > SPTShipClass::APIgetLastShipment (   ) 
 

Returns:
Returns the latest shipment.

int SPTShipClass::APIgetShipcount (   ) 
 

Returns:
Returns the shipcount.

vector< SPbyte > SPTShipClass::APIgetShipment (  int  i  ) 
 

Return specified recent shipment

Parameters:
i - count of requested shipment
Returns:
byte[] - resulting shipment or NULL, if not successful

string SPTShipClass::APIgetTransactionType (   )  [virtual]
 

This method returns a String of the transactiontype.

Returns:
this.transtype - String - name of transaction type

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTShipClass::APIrequestsendShipment (  string  sender  ) 
 

This method requests send shipments automatically.

Parameters:
sender String - sender of this shipment.
Returns:
boolean

bool SPTShipClass::APIresendShipment (  string  sender,
int  shipcount,
vector< string >  recieverIdList
) 
 

This shipment sends the specified shipment, grabbed from the last sent list using the shipment number, to the specified players. This is done by the transaction master. NOTE: This method is most likely to be used to send last sent shipments to players who sent nacks for the shipment.

Parameters:
sender 
shipcount 
recieverIdList 
Returns:
boolean

bool SPTShipClass::APIsendShipment (  string  sender  ) 
 

This method send shipments automatically.

Parameters:
sender String - sender of this shipment.
Returns:
boolean

bool SPTShipClass::APIsendShipment (  string  sender,
vector< SPbyte >  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

bool SPTShipClass::APIsetMaxRecieve (  int  i  ) 
 

Allows the maximum size of the byte[] MAP to be increased (growing the size of the buffer).

Parameters:
i - int - new size for the array of byte[]s
Returns:
boolean - TRUE, if successful, False, if i < previous value.

SPAbstractTransactionInterface * SPTShipClass::createShip (  SPGameInterface *  gameobj,
string  master,
vector< string >  playerIDList,
bool  privateflag,
string  AGE,
bool  AckFlag,
bool  ManFlag,
int  bsize,
long  tsize,
string  classname,
string  instname,
vector< SPbyte >  entireshipment
)  [static]
 

This method creates the Ship class

Parameters:
gameobj 
master 
playerIDList 
privateflag 
AGE 
AckFlag 
ManFlag 
bsize 
tsize 
classname 
instname 
entireshipment 
Returns:
SPAbstractTransactionInterface - returns ship class created

vector< string > SPTShipClass::getAckList (   ) 
 

Returns:
Returns the ackList.

int SPTShipClass::getBuffersize (   ) 
 

Returns:
Returns the buffersize.

int SPTShipClass::getLastRecSent (   ) 
 

Returns:
Returns the lastsent.

int SPTShipClass::getMaxReceiveSendStore (   ) 
 

Returns:
Returns the maxreceivestore.

string SPTShipClass::getShippedObjectClass (   ) 
 

Returns:
Returns the shippedObjectClass.

string SPTShipClass::getShippedObjectDistinguishedName (   ) 
 

Returns:
Returns the shippedObjectDistinguishedName.

long SPTShipClass::getTotalRecSent (   ) 
 

Returns:
Returns the totalRecSent.

long SPTShipClass::getTotalSize (   ) 
 

Returns:
Returns the totalSize.

string SPTShipClass::gettranstype (   )  [static]
 

This method gets the transaction type.

Returns:
String

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTShipClass::isAcknowledgeFLAG (   ) 
 

Returns:
Returns the acknowledgeFLAG.

bool SPTShipClass::isCompleteFlag (   ) 
 

Returns:
Returns the completeFlag.

bool SPTShipClass::isEntireShipmentFLAG (   ) 
 

Returns:
Returns the entireShipmentFLAG.

bool SPTShipClass::isManualSendFLAG (   ) 
 

Returns:
Returns the manualSendFLAG.

bool SPTShipClass::isSendOKFlag (   ) 
 

Returns:
Returns the sendOKFlag.

bool SPTShipClass::pronincomingTransaction (  SPMessageClass *  incoming  ) 
 

this is a shell for unique incoming transactions

Parameters:
incoming SPMessageClass - incoming message
Returns:
Boolean - TRUE if successful, FALSE, if unsuccessful

Reimplemented from SecurePlayLibrary::SPAbstractTransactionClass.

bool SPTShipClass::registerTransaction (   )  [static]
 

Registers this transaction.

Returns:
boolean

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.