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

SecurePlayLibrary::SPTRandomAPIClass Class Reference

#include <SPTRandomAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTRandomAPIClass:

SecurePlayLibrary::SPAbstractTransactionAPIClass SecurePlayLibrary::SPAbstractTransactionAPIInterface List of all members.

Detailed Description

API version of SPMultistepturnClass
Author:
IT GlobalSecure
See also:
SecurePlay License Information


Public Member Functions

 SPTRandomAPIClass ()
 ~SPTRandomAPIClass ()
 SPTRandomAPIClass (SPTRandomClass *transactioninstance)
bool APIcompleteTransaction (string pid)
bool APIconfigureTransaction (string sender, vector< string > configarr)
bool APIconfigureTransaction (string sender, int decksize, bool replacement, int expiration)
bool APIgenerateRandomEvent (string sender, vector< string > receivers, bool privacy, int count)
vector< string > APIgetlastRandomEvents ()
int APIgetRandomEvent (int index)
bool rulesgenerateRandomEvent (string source, vector< string > receivers, bool privacy, int count, SPTRandomClass *transobj)
bool rulesconfigureTransaction (string pid, vector< string > configarr, SPAbstractTransactionInterface *transobj)

Private Attributes

const bool librarytestmode
SPTRandomClasstraninst


Constructor & Destructor Documentation

SPTRandomAPIClass::SPTRandomAPIClass  ) 
 

Default Constructor

SPTRandomAPIClass::~SPTRandomAPIClass  ) 
 

Default Destructor

SPTRandomAPIClass::SPTRandomAPIClass SPTRandomClass transactioninstance  ) 
 

Overloaded Constructor

Parameters:
transactioninstance 


Member Function Documentation

bool SPTRandomAPIClass::APIcompleteTransaction string  pid  )  [virtual]
 

This method overrides the SPAbstractTransactionClass method. It supports the distribution of the shoe master player key to allow the shoe to be subsequently verified.

Parameters:
pid string - ID of requesting Player
Returns:
result - bool: TRUE, if successful, FALSE, if not

Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

bool SPTRandomAPIClass::APIconfigureTransaction string  sender,
int  decksize,
bool  replacement,
int  expiration
 

Parameters:
sender 
decksize 
replacement 
expiration 
Returns:
result - bool: TRUE, if successful, FALSE, if not

bool SPTRandomAPIClass::APIconfigureTransaction string  sender,
vector< string >  configarr
[virtual]
 

This method allows the Transaction Master ONLY to configure the transactions unique parameters. NOTE, this method will be overridden for individual transaction types.

Parameters:
sender string - id of the configurer, must be internal.
configarr vector<string> - the configuration array, with configuration details inside.
Returns:
result - bool: TRUE if successful, FALSE, if unsuccessful

Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

bool SPTRandomAPIClass::APIgenerateRandomEvent string  sender,
vector< string >  receivers,
bool  privacy,
int  count
 

This method handles either requests or local generation of random events by the shoe master. Either a request message will be sent to the shoe master or the shoe master will generate the number of random events specified by (count) and send them to the specified receivers. This value is protected based on the privacy flag.

Parameters:
sender string - sender
receivers string - player id list of the recievers
privacy bool - privacy policy
count int - the number of random events to be generated
Returns:
result - bool: TRUE, if successful, FALSE, if not

vector< string > SPTRandomAPIClass::APIgetlastRandomEvents  ) 
 

This method returns an array that includes the last set of random events provided by the shoe master.

Returns:
rmevents - vector<string> - the last batch of random events

int SPTRandomAPIClass::APIgetRandomEvent int  index  ) 
 

This method returns a random event from the dealtEventList property as specified by the index.

Parameters:
index int - the specifier of the random event
Returns:
rmevent - int - the corresponding dealtEventList entry to the index

bool SPTRandomAPIClass::rulesconfigureTransaction string  pid,
vector< string >  configarr,
SPAbstractTransactionInterface transobj
[virtual]
 

This shell method supports remote requests to configure an existing transaction. Only the transaction master can actually configure the transaction.

Parameters:
pid string - player id of the requester
configarr Vector - configuration details in a vactor
transobj SPAbstractTransactionClass - the transaction to be configured
Returns:
result - bool: TRUE, if allowed, FALSE, if not

Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

bool SPTRandomAPIClass::rulesgenerateRandomEvent string  source,
vector< string >  receivers,
bool  privacy,
int  count,
SPTRandomClass transobj
 

This is a shell function to request the remote invocation of a generateRandomEvents method. This is probably the most likely rules function to be overwritten by game specific rules logic

Parameters:
source 
receivers 
privacy 
count 
transobj 
Returns:
bool - TRUE, if request accepted, FALSE, if not.


Member Data Documentation

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

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

Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

SPTRandomClass* SecurePlayLibrary::SPTRandomAPIClass::traninst [private]
 

Instance of SPShoeClass


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.