SecurePlayLibrary::SPTShipAPIClass Class Reference

#include <SPTShipAPIClass.h>

List of all members.

---

Detailed Description

This is the API Class of SPSHipClass.

Author:

IT GlobalSecure

See also:

SecurePlay License Information

Public Member Functions
	SPTShipAPIClass ()
	~SPTShipAPIClass ()
	SPTShipAPIClass (SPTShipClass *ship)
bool	APIconfigureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname, vector< byte > entireshipment)
bool	APIconfigureTransaction (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	APIrequestConfigureTransaction (string sender, bool AckFlag, bool ManFlag, int bsize, long tsize, string classname, string instname)
bool	APIrequestsendShipment (string sender)
bool	APIrequestsendShipment (string sender, vector< byte > manualShip)
bool	APIresendShipment (string sender, int shipcount, vector< string > recieverIdList)
bool	APIsendShipment (string sender)
bool	APIsendShipment (string sender, vector< byte > manualShip)
bool	rulesrequestSendshipment (string pid, SPAbstractTransactionInterface *transobj)
Private Attributes
const bool	librarytestmode
SPTShipClass *	transactioninstance

---

Constructor & Destructor Documentation

SPTShipAPIClass::SPTShipAPIClass (   )

Default Constructor.

SPTShipAPIClass::~SPTShipAPIClass (   )

Default Destructor

SecurePlayLibrary::SPTShipAPIClass::SPTShipAPIClass (  SPTShipClass *  ship  )

Constructor Parameters: ship  SPSHipClass - the ship class associate with this API.

---

Member Function Documentation

bool SecurePlayLibrary::SPTShipAPIClass::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 SecurePlayLibrary::SPTShipAPIClass::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  boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment. ManFlag  boolean - 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: boolean

bool SecurePlayLibrary::SPTShipAPIClass::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 SecurePlayLibrary::SPTShipAPIClass::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  boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment. ManFlag  boolean - 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: boolean

bool SecurePlayLibrary::SPTShipAPIClass::APIrequestsendShipment (  string  sender, vector< byte >  manualShip )

This method requests 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 SecurePlayLibrary::SPTShipAPIClass::APIrequestsendShipment (  string  sender  )

This method requests send shipments automatically. Parameters: sender  String - sender of this shipment. Returns: boolean

bool SecurePlayLibrary::SPTShipAPIClass::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. 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 SecurePlayLibrary::SPTShipAPIClass::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

bool SecurePlayLibrary::SPTShipAPIClass::APIsendShipment (  string  sender  )

This method send shipments automatically. Parameters: sender  String - sender of this shipment. Returns: boolean

bool SecurePlayLibrary::SPTShipAPIClass::rulesrequestSendshipment (  string  pid, SPAbstractTransactionInterface *  transobj )

This shell method determines if an existing transaction object can be used to send shipments from a remote request. Parameters: pid  String - player id transobj  - SPAbstractTransationInterface - the transaction Returns: boolean

---

Member Data Documentation

const bool SecurePlayLibrary::SPTShipAPIClass::librarytestmode [private]

This should be set to FALSE for production systems or all "rulesXXXX methods should be edited

SPTShipClass* SecurePlayLibrary::SPTShipAPIClass::transactioninstance [private]

Instance of SPAbstractTransactionClass (SPSHipClass)

---

The documentation for this class was generated from the following files:

• SPTShipAPIClass.h
• SPTShipAPIClass.cpp

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.