pdiext::MGrim2 Class Reference

Gran Turismo Server Interface. More...

Inheritance diagram for pdiext::MGrim2:

Public Member Functions
	MGrim2 ()
	constructor taking no param More...
void	initialize (String grim_url, String language, Bool use_db, MBlob fingerprint=nil, String cert_name=nil, String privkey_name=nil)
	Initializes Grim2. More...
void	finalize ()
	Finalizes/deinits Grim2 entirely. More...
void	requestLogin ()
void	requestLogout ()
void	decodeLogin ()
void	startUpdater ()
void	stopUpdater ()
void	pauseUpdater ()
void	requestRegionList ()
void	decodeRegionList ()
MHttpRequest	requestDefaultServerList (FunctionObject< Array< Object > > callback)
	Requests default server list. More...
MHttpRequest	requestDefaultServerList (String base_url, FunctionObject< Array< Object > > callback)
	Requests default server list (specific url) More...
void	requestRegionServerList (String base_url, FunctionObject< Array< Object > > callback)
	Requests region server list. More...
void	requestRegionServerList (String base_url, FunctionObject< Array< Object > > callback)
	Requests region server list (specific url) More...
void	requestServerList2 ()
void	requestSetLanguage ()
void	setRegion ()
Map	getServer (String name)
	Returns a server entity from server options. More...
void	addServerOption (MHttpRequest request)
	Adds server options from a requestServerList() request. More...
void	getServerOption ()
void	getServerOptionToInt ()
String	setBaseUrl ()
	Sets base url from serverlist.xml. More...
Bool	isMaintenance ()
	Checks if server is in maintenance. More...
void	getMaintenanceMessage ()
void	getNextMaintenanceDateTime ()
void	getNextMaintenanceDisplayDateTime ()
void	setInitialize (Bool initialized)
	Sets initialization state. More...
Bool	isInitialize ()
	Whether the grim instance is initialized (use setInitialize()) More...
void	isInitialize2 ()
void	join ()
void	clearCallback ()
String	getLoginUserId ()
	Gets login user id if logged. More...
String	getLoginUserNickname ()
	Gets login user nickname if logged. More...
Int	getLoginUserNumber ()
	Gets login user number (db id) if logged. More...
void	setLoginUserNickname ()
void	clearCacheAll ()
void	clearCacheIf ()
void	requestPutLog (String log)
	Puts logs at "/log/<region>/". More...
void	requestServerTime ()
void	decodeServerTime ()
void	getServerTime ()
void	getClientTime ()
void	isWrongClientTime ()
void	getUrlBase ()
void	requestUrlBase2 ()
void	decodeUrlBase2 ()
void	requestSetBand ()
void	requestExtendSession ()
void	requestLock ()
void	requestUnLock ()
void	requestGetCounter ()
void	decodeCounter ()
void	requestIncrementCounter ()
void	decodeIncrementCounter ()
MHttpRequest	requestLogSend (FunctionObject< Array< Object > > callback)
void	setSpecialRequestHeader ()
void	getRankingAreaId ()
void	requestUniqueId ()
void	decodeUniqueId ()
void	requestSendReport ()
void	setCountry ()
void	getDateTime ()
void	setLanguage ()
Map	getHttpStatistics ()
	Gets http statistics. More...
void	setHttpServerParams ()
void	convertHttpResultToId ()
void	requestCheckEntitlement ()
void	requestEulaAgreement ()
void	isEulaEnable ()
void	requestEula ()
void	decodeEula ()
void	requestAcademy ()
void	decodeAcademy ()
void	requestUploadPersonalInformation ()
void	getFixedBetterTimeSecond ()
void	setFixedBetterTimeSecond ()
Public Member Functions inherited from System::Object
	Object ()
	constructor taking no param More...
Bool	isInstanceOf (Class classType)
	Returns whether an object is of a specific class/type. More...
Object	getDeepCopy ()
	Gets a deep copy of this object. More...
void	setDeepCopy (Object obj)
	Unk. More...
String	dump ()
	Dumps all info about an object. More...
Object	getObjectAttribute (string path)
void	setObjectAttribute (string path, Object value)
Bool	hasPrimitiveInterface ()
	Returns whether this object has a primitive interface. More...
Bool	toBool ()
	Casts this object to Bool. More...
Byte	toByte ()
	Casts this object to Byte. More...
Short	toShort ()
	Casts this object to Short. More...
Int	toInt ()
	Casts this object to Int. More...
Long	toLong ()
	Casts this object to Long. More...
UByte	toUByte ()
	Casts this object to UByte. More...
UShort	toUShort ()
	Casts this object to UShort. More...
UInt	toUInt ()
	Casts this object to UInt. More...
ULong	toULong ()
	Casts this object to ULong. More...
Float	toFloat ()
	Casts this object to Float. More...
Double	toDouble ()
	Casts this object to Double. More...
String	toString ()
	Casts this object to String. More...
Symbol	toSymbol ()
	Casts this object to Symbol. More...
Bool	hasArrayInterface ()
	Returns whether this object has an Array interface. More...
Int	getArrayCount ()
	Gets the Array item count for this object. More...
void	setArrayCount ()
	Sets the Array item count for this object. More...
Object	getArrayElement (Object arg0)
	Gets an Array item for this object. More...
void	setArrayElement (Object arg0, Object arg1)
	Sets the Array item for this object. More...
Bool	hasMapInterface ()
	Returns whether this object has a Map interface. More...
int	getMapCount ()
	Returns the count of items in the map. More...
void	setMapElement (Object arg0, Object arg1)
	Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...
Object	getMapElement (Object arg0)
	Gets a Map element by key. More...
void	hasGeneratorInterface ()
	Returns whether this object has a generator interface. More...
Iterator	generator ()
	Returns generator (?) More...
void	hasIteratorInterface ()
	Returns whether this object has an iterator. More...
Iterator	iterator ()
	Gets the iterator for this object. More...
void	hasVariableInterface ()
	Returns whether this object is a variable. More...
void	hasFunctionInterface ()
	Returns whether this object has a function interface. More...
Object	call ()
	Calls this object as a function. More...
Bool	hasByteDataInterface ()
	Returns whether this object has a byte data interface. More...
Int	getByteDataCount ()
	Returns the ByteData size for this object. More...
void	setByteDataCount (Int count)
	Sets the ByteData size for this object. More...
Int	getByteDataCapacity ()
	Returns the ByteData capacity for this object. More...
void	setByteDataCapacity (Int capacity)
	Sets the ByteData capacity for this object. More...
ByteData	getByteData ()
	Gets the underlaying ByteData. More...
void	setByteData (ByteData bytedata)
	Sets the underlaying ByteData. More...
void	hasObjectSelectorInterface ()
	Returns whether this object has an object selector interface. More...
void	self ()
	Gets the get for this object if it has a get interface. More...
void	getArchiveTree ()
void	setArchiveTree ()
ByteData	serialize ()
	Serializes this object. More...
void	deserialize (ByteData serializedData)
	Deserializes this object. More...
void	defined (Object obj)
	Returns whether a certain object is defined within this object. More...
Array	find_all (FunctionObject func)
	Finds all the elements in this object that matches the predicates. More...
void	each_all (FunctionObject func)
	Applies callback to all elements in this object. More...
Array	map_all (FunctionObject< Object > func)
	Maps all the elements in this object. More...
Bool	operator!= ()
	Returns whether this object is not equal to another. More...
Bool	operator== ()
	Returns whether this object is equal to another. More...

Additional Inherited Members
Public Attributes inherited from System::Object
Int	rc_size
	Getter-only. Reference counter size of this object. More...
Object	rc_class
	Getter-only. Type name of the object. More...
Int	rc_count
	Getter-only. Reference count of this object. More...
Int	weak_count
	Getter-only. Weak reference count of this object. More...
Class	class_id
	Class (type) object for this object. More...

Detailed Description

Gran Turismo Server Interface.

Definition at line 6 of file MGrim2.cpp.

Constructor & Destructor Documentation

MGrim2()

pdiext::MGrim2::MGrim2 ( )

inline

constructor taking no param

Definition at line 10 of file MGrim2.cpp.

Member Function Documentation

addServerOption()

void pdiext::MGrim2::addServerOption

(

MHttpRequest

request

)

Adds server options from a requestServerList() request.

clearCacheAll()

void pdiext::MGrim2::clearCacheAll

(

)

clearCacheIf()

void pdiext::MGrim2::clearCacheIf

(

)

clearCallback()

void pdiext::MGrim2::clearCallback

(

)

convertHttpResultToId()

void pdiext::MGrim2::convertHttpResultToId

(

)

decodeAcademy()

void pdiext::MGrim2::decodeAcademy

(

)

decodeCounter()

void pdiext::MGrim2::decodeCounter

(

)

decodeEula()

void pdiext::MGrim2::decodeEula

(

)

decodeIncrementCounter()

void pdiext::MGrim2::decodeIncrementCounter

(

)

decodeLogin()

void pdiext::MGrim2::decodeLogin

(

)

decodeRegionList()

void pdiext::MGrim2::decodeRegionList

(

)

decodeServerTime()

void pdiext::MGrim2::decodeServerTime

(

)

decodeUniqueId()

void pdiext::MGrim2::decodeUniqueId

(

)

decodeUrlBase2()

void pdiext::MGrim2::decodeUrlBase2

(

)

finalize()

void pdiext::MGrim2::finalize

(

)

Finalizes/deinits Grim2 entirely.

getClientTime()

void pdiext::MGrim2::getClientTime

(

)

getDateTime()

void pdiext::MGrim2::getDateTime

(

)

getFixedBetterTimeSecond()

void pdiext::MGrim2::getFixedBetterTimeSecond

(

)

getHttpStatistics()

Map pdiext::MGrim2::getHttpStatistics

(

)

Gets http statistics.

Returns

Statistics as a Map

• "numEnobufs" : (UInt)
• "numSocketsClosed" : (UInt)
• "numSocketsOpened" : (UInt)
• "numTransactionsCreated" : (UInt)
• "numTransactionsDestroyed" : (UInt)
• "peakNumSockets" : (UInt)
• "peakNumTransactions" : (UInt)

getLoginUserId()

String pdiext::MGrim2::getLoginUserId

(

)

Gets login user id if logged.

getLoginUserNickname()

String pdiext::MGrim2::getLoginUserNickname

(

)

Gets login user nickname if logged.

getLoginUserNumber()

Int pdiext::MGrim2::getLoginUserNumber

(

)

Gets login user number (db id) if logged.

getMaintenanceMessage()

void pdiext::MGrim2::getMaintenanceMessage

(

)

getNextMaintenanceDateTime()

void pdiext::MGrim2::getNextMaintenanceDateTime

(

)

getNextMaintenanceDisplayDateTime()

void pdiext::MGrim2::getNextMaintenanceDisplayDateTime

(

)

getRankingAreaId()

void pdiext::MGrim2::getRankingAreaId

(

)

getServer()

Map pdiext::MGrim2::getServer

(

String

name

)

Returns a server entity from server options.

Fetches a "server" node from serverlist.xml by name

Returns

All the entries in the "server" node

getServerOption()

void pdiext::MGrim2::getServerOption

(

)

getServerOptionToInt()

void pdiext::MGrim2::getServerOptionToInt

(

)

getServerTime()

void pdiext::MGrim2::getServerTime

(

)

getUrlBase()

void pdiext::MGrim2::getUrlBase

(

)

initialize()

void pdiext::MGrim2::initialize	(	String	grim_url,
		String	language,
		Bool	use_db,
		MBlob	fingerprint = nil,
		String	cert_name = nil,
		String	privkey_name = nil
	)

Initializes Grim2.

Parameters

grim_url	Url to the main server for requestServerList
language	Language
use_db	Whether to use caching db
fingerprint	Fingerprint
cert_name	Certificate Name
privkey_name	Private Key Name

isEulaEnable()

void pdiext::MGrim2::isEulaEnable

(

)

isInitialize()

Bool pdiext::MGrim2::isInitialize

(

)

Whether the grim instance is initialized (use setInitialize())

isInitialize2()

void pdiext::MGrim2::isInitialize2

(

)

isMaintenance()

Bool pdiext::MGrim2::isMaintenance

(

)

Checks if server is in maintenance.

From server option grim_http.maintenance = 1 or 0

isWrongClientTime()

void pdiext::MGrim2::isWrongClientTime

(

)

join()

void pdiext::MGrim2::join

(

)

pauseUpdater()

void pdiext::MGrim2::pauseUpdater

(

)

requestAcademy()

void pdiext::MGrim2::requestAcademy

(

)

requestCheckEntitlement()

void pdiext::MGrim2::requestCheckEntitlement

(

)

requestDefaultServerList() [1/2]

MHttpRequest pdiext::MGrim2::requestDefaultServerList

(

FunctionObject< Array< Object > >

callback

)

Requests default server list.

URL based from initialize()

requestDefaultServerList() [2/2]

MHttpRequest pdiext::MGrim2::requestDefaultServerList	(	String	base_url,
		FunctionObject< Array< Object > >	callback
	)

Requests default server list (specific url)

requestEula()

void pdiext::MGrim2::requestEula

(

)

requestEulaAgreement()

void pdiext::MGrim2::requestEulaAgreement

(

)

requestExtendSession()

void pdiext::MGrim2::requestExtendSession

(

)

requestGetCounter()

void pdiext::MGrim2::requestGetCounter

(

)

requestIncrementCounter()

void pdiext::MGrim2::requestIncrementCounter

(

)

requestLock()

void pdiext::MGrim2::requestLock

(

)

requestLogin()

void pdiext::MGrim2::requestLogin

(

)

requestLogout()

void pdiext::MGrim2::requestLogout

(

)

requestLogSend()

MHttpRequest pdiext::MGrim2::requestLogSend

(

FunctionObject< Array< Object > >

callback

)

/ap/misc2 - log.send command

requestPutLog()

void pdiext::MGrim2::requestPutLog

(

String

log

)

Puts logs at "/log/<region>/".

Must be initted and connected past region list requests Log text will be in the X-gt-log header

requestRegionList()

void pdiext::MGrim2::requestRegionList

(

)

requestRegionServerList() [1/2]

void pdiext::MGrim2::requestRegionServerList	(	String	base_url,
		FunctionObject< Array< Object > >	callback
	)

Requests region server list.

setRegion() should be called before-hand

requestRegionServerList() [2/2]

void pdiext::MGrim2::requestRegionServerList	(	String	base_url,
		FunctionObject< Array< Object > >	callback
	)

Requests region server list (specific url)

setRegion() should be called before-hand

requestSendReport()

void pdiext::MGrim2::requestSendReport

(

)

requestServerList2()

void pdiext::MGrim2::requestServerList2

(

)

requestServerTime()

void pdiext::MGrim2::requestServerTime

(

)

requestSetBand()

void pdiext::MGrim2::requestSetBand

(

)

requestSetLanguage()

void pdiext::MGrim2::requestSetLanguage

(

)

requestUniqueId()

void pdiext::MGrim2::requestUniqueId

(

)

requestUnLock()

void pdiext::MGrim2::requestUnLock

(

)

requestUploadPersonalInformation()

void pdiext::MGrim2::requestUploadPersonalInformation

(

)

requestUrlBase2()

void pdiext::MGrim2::requestUrlBase2

(

)

setBaseUrl()

String pdiext::MGrim2::setBaseUrl

(

)

Sets base url from serverlist.xml.

Should be used after requestServerList

Returns

The url set from "grim_http" server option

setCountry()

void pdiext::MGrim2::setCountry

(

)

setFixedBetterTimeSecond()

void pdiext::MGrim2::setFixedBetterTimeSecond

(

)

setHttpServerParams()

void pdiext::MGrim2::setHttpServerParams

(

)

setInitialize()

void pdiext::MGrim2::setInitialize

(

Bool

initialized

)

Sets initialization state.

setLanguage()

void pdiext::MGrim2::setLanguage

(

)

setLoginUserNickname()

void pdiext::MGrim2::setLoginUserNickname

(

)

setRegion()

void pdiext::MGrim2::setRegion

(

)

setSpecialRequestHeader()

void pdiext::MGrim2::setSpecialRequestHeader

(

)

startUpdater()

void pdiext::MGrim2::startUpdater

(

)

stopUpdater()

void pdiext::MGrim2::stopUpdater

(

)

---

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

• headers/pdiext/Online/MGrim2.cpp