Main   GitHub

Methods | List of all members
TCPObject Class Reference

Inherits SimObject, and SimObject.

Inherited by HTTPObject, and HTTPObject.

Methods

void connect (addr)
 
void connect (addr)
 
void disconnect ()
 
void disconnect ()
 
void listen (port)
 
void listen (port)
 
void openAndConnect (string addr)
 
void openAndConnect (string addr)
 
void send (...)
 
void send (...)
 
string URLEncodeString (string data)
 
string URLEncodeString (string data)
 
- Methods inherited from SimObject
void addFieldFilter (fieldName)
 
void addFieldFilter (fieldName)
 
string call (%args)
 
string call (%args)
 
int clone ([bool copyDynamicFields?=false])
 
int clone ([bool copyDynamicFields?=false])
 
void delete ()
 
void delete ()
 
void dump ()
 
void dump ()
 
void dumpClassHierarchy ()
 
void dumpClassHierarchy ()
 
string getClassName ()
 
string getClassName ()
 
string getClassNamespace ()
 
string getClassNamespace ()
 
string getDynamicField (index)
 
string getDynamicField (index)
 
int getDynamicFieldCount ()
 
int getDynamicFieldCount ()
 
string getField (int index)
 
string getField (int index)
 
int getFieldCount ()
 
int getFieldCount ()
 
string getFieldType (fieldName)
 
string getFieldType (fieldName)
 
string getFieldValue (fieldName)
 
string getFieldValue (fieldName)
 
int getGroup ()
 
int getGroup ()
 
int getId ()
 
int getId ()
 
string getInternalName ()
 
string getInternalName ()
 
string getName ()
 
string getName ()
 
string getProgenitorFile ()
 
string getProgenitorFile ()
 
string getSuperClassNamespace ()
 
string getSuperClassNamespace ()
 
int getType ()
 
int getType ()
 
bool isChildOfGroup ()
 
bool isChildOfGroup ()
 
bool isMemberOfClass (string classname)
 
bool isMemberOfClass (string classname)
 
bool isMethod (string method name)
 
bool isMethod (string method name)
 
bool isTimerActive ()
 
bool isTimerActive ()
 
void removeFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 
bool save (fileName,[selectedOnly])
 
bool save (fileName,[selectedOnly])
 
int schedule (time, command,< arg1...argN >)
 
int schedule (time, command,< arg1...argN >)
 
void setClassNamespace ()
 
void setClassNamespace ()
 
bool setFieldValue (fieldName, value)
 
bool setFieldValue (fieldName, value)
 
void setInternalName ()
 
void setInternalName ()
 
void setName (newName)
 
void setName (newName)
 
void setProgenitorFile (file)
 
void setProgenitorFile (file)
 
void setSuperClassNamespace ()
 
void setSuperClassNamespace ()
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
void stopTimer ()
 
void stopTimer ()
 

Fields

SimBase
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
Namespace Linking
string superclass
 
string class
 
- Fields inherited from SimObject
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 

Methods

void TCPObject::connect ( addr  )

Use the connect method to request a connection to a remote agent at the address addr.

Parameters
addrA string containing an address of the form: ìA.B.C.D:Portî, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536.
Returns
No return value.
See Also
disconnect
void TCPObject::connect ( addr  )

Use the connect method to request a connection to a remote agent at the address addr.

Parameters
addrA string containing an address of the form: ìA.B.C.D:Portî, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536.
Returns
No return value.
See Also
disconnect
void TCPObject::disconnect ( )

Use the disconnect method to close a previously opened connection without destroying the requesting TCPOpbject. This will close any open connection, but not destroy this object. Thus, the object can be used to open a new connection.

Returns
No return value.
See Also
connect
void TCPObject::disconnect ( )

Use the disconnect method to close a previously opened connection without destroying the requesting TCPOpbject. This will close any open connection, but not destroy this object. Thus, the object can be used to open a new connection.

Returns
No return value.
See Also
connect
void TCPObject::listen ( port  )

Use the listen method to allow this TCPObject to accept connections on the specified port.

Parameters
portA value between 1000 and 65536.
Returns
No return value
void TCPObject::listen ( port  )

Use the listen method to allow this TCPObject to accept connections on the specified port.

Parameters
portA value between 1000 and 65536.
Returns
No return value
void TCPObject::openAndConnect ( string  addr)

Connect to the given address, making sure that the connection is open first.

void TCPObject::openAndConnect ( string  addr)

Connect to the given address, making sure that the connection is open first.

void TCPObject::send (   ...)

Use the send method to send any number of parameters, as strings, one at a time to the agent at the other end of the connection.

Parameters
...Any number of arguments, as strings. Each string is sent separately. i.e. The arguments are not concatenated.
Returns
No return value
void TCPObject::send (   ...)

Use the send method to send any number of parameters, as strings, one at a time to the agent at the other end of the connection.

Parameters
...Any number of arguments, as strings. Each string is sent separately. i.e. The arguments are not concatenated.
Returns
No return value
string TCPObject::URLEncodeString ( string  data)

Performs URLEncoding on a single string.

string TCPObject::URLEncodeString ( string  data)

Performs URLEncoding on a single string.

Member Data Documentation

bool TCPObject::canSaveDynamicFields
string TCPObject::class

Script SuperClass of object.

string TCPObject::internalName
SimObjectPtr TCPObject::parentGroup

Group hierarchy parent of the object.

string TCPObject::superclass

Script Class of object.



Copyright © 2013 GarageGames, LLC. All Rights Reserved.