Packagecom.smartfoxserver.v2.util
Classpublic class ConfigData
InheritanceConfigData Inheritance Object

The ConfigData class stores the client configuration data loaded from an external XML file or passed directly to the deputy connect method. The external configuration file is loaded by the SmartFox class when its loadConfig() method is called. Otherwise it can be passed directly to the connectWithConfig() method of the SmartFox class.

See also

SmartFox.loadConfig()
SmartFox.connectWithConfig()


Public Properties
 PropertyDefined By
  blueBoxPollingRate : int = 750
Specifies the BlueBox polling speed.
ConfigData
  debug : Boolean = false
Indicates whether the client-server messages debug should be enabled or not.
ConfigData
  forceBlueBoxOverHttps : Boolean = false
Forces the BlueBox connection to use an HTTPS tunnel instead of standard HTTP.
ConfigData
  host : String = 127.0.0.1
Specifies the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection).
ConfigData
  httpPort : int = 8080
Specifies the port for generic HTTP communication.
ConfigData
  httpsPort : int = 8443
Specifies the port for HTTPS communication.
ConfigData
  port : int = 9933
Specifies the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection).
ConfigData
  udpHost : String = 127.0.0.1
Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection).
ConfigData
  udpPort : int = 9933
Specifies the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection).
ConfigData
  useBlueBox : Boolean = true
Indicates whether the SmartFoxServer's BlueBox should be enabled or not.
ConfigData
  zone : String
Specifies the Zone of the SmartFoxServer 2X instance to join.
ConfigData
Public Methods
 MethodDefined By
  
Creates a new ConfigData instance.
ConfigData
Property Detail
blueBoxPollingRateproperty
public var blueBoxPollingRate:int = 750

Specifies the BlueBox polling speed.

The default value is 750.

debugproperty 
public var debug:Boolean = false

Indicates whether the client-server messages debug should be enabled or not.

The default value is false.

forceBlueBoxOverHttpsproperty 
public var forceBlueBoxOverHttps:Boolean = false

Forces the BlueBox connection to use an HTTPS tunnel instead of standard HTTP.

IMPORTANT NOTE: this mode should be used exclusively if you're deploying your app to iOS devices, since Apple doesn't accept HTTP connections. All other platforms should always use standard HTTP because the protocol is already encrypted when cryptography is activated. In other words the BlueBox transmits an encrypted protocol over a standard HTTP tunnel, which is perfectly secure.

hostproperty 
public var host:String = 127.0.0.1

Specifies the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection).

The default value is 127.0.0.1.

httpPortproperty 
public var httpPort:int = 8080

Specifies the port for generic HTTP communication.

The default value is 8080.

httpsPortproperty 
public var httpsPort:int = 8443

Specifies the port for HTTPS communication. For example this parameter is used during the initialization of an encrypted connection.

The default value is 8443.

portproperty 
public var port:int = 9933

Specifies the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection).

The default value is 9933.

udpHostproperty 
public var udpHost:String = 127.0.0.1

Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection).

The default value is 127.0.0.1.

udpPortproperty 
public var udpPort:int = 9933

Specifies the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection).

The default value is 9933.

useBlueBoxproperty 
public var useBlueBox:Boolean = true

Indicates whether the SmartFoxServer's BlueBox should be enabled or not.

The default value is true.

zoneproperty 
public var zone:String

Specifies the Zone of the SmartFoxServer 2X instance to join.

The default value is null.

Constructor Detail
ConfigData()Constructor
public function ConfigData()

Creates a new ConfigData instance.