The ConfigData class stores the client configuration data loaded from an external XML file or passed directly to the deputy connect method. More...

#include <ConfigData.h>

Public Member Functions
string	Host ()
	Get the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection). More...

void	Host (string value)
	Specifies the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection). More...

unsigned short int	Port ()
	Get the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection). More...

void	Port (unsigned short int value)
	Specifies the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection). More...

string	UdpHost ()
	Get the IP address of the SmartFoxServer 2X instance to connect to (UDP connection). More...

void	UdpHost (string value)
	Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection). More...

unsigned short int	UdpPort ()
	Get the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection). More...

void	UdpPort (unsigned short int value)
	Specifies the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection). More...

string	Zone ()
	Get the Zone of the SmartFoxServer 2X instance to join. More...

void	Zone (string value)
	Specifies the Zone of the SmartFoxServer 2X instance to join. More...

bool	Debug ()
	Get the state for the client-server messages debug. More...

void	Debug (bool value)
	Indicates whether the client-server messages debug should be enabled or not. More...

unsigned short int	HttpPort ()
	Get the port for generic HTTP communication. More...

void	HttpPort (unsigned short int value)
	Specifies the port for generic HTTP communication. More...

unsigned short int	HttpsPort ()
	Get the port for HTTPS communication. More...

void	HttpsPort (unsigned short int value)
	Specifies the port for HTTPS communication. More...

bool	UseBlueBox ()
	Get the state for the SmartFoxServer's BlueBox. More...

void	UseBlueBox (bool value)
	Indicates whether the SmartFoxServer's BlueBox should be enabled or not. More...

long int	BlueBoxPollingRate ()
	Get the BlueBox polling speed. More...

void	BlueBoxPollingRate (long int value)
	Specifies the BlueBox polling speed. More...

bool	ForceIPv6 ()
	Gets selected IPv4 or IPv6 mode to connect to the SmartFoxServer 2X instance (TCP and UDP connections). More...

void	ForceIPv6 (bool value)
	Selects the usage of IPv4 or IPv6 to connect to the SmartFoxServer 2X instance (TCP and UDP connections). More...

Detailed Description

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 SmartFox->LoadConfig() method is called. Otherwise it can be passed directly to one of the SmartFox->Connect(ConfigData) method overloads of the SmartFox class.

Member Function Documentation

◆ BlueBoxPollingRate() [1/2]

long int Sfs2X::Util::ConfigData::BlueBoxPollingRate ( )

Get the BlueBox polling speed.

The default value is 750.

◆ BlueBoxPollingRate() [2/2]

void Sfs2X::Util::ConfigData::BlueBoxPollingRate ( long int value )

Specifies the BlueBox polling speed.

The default value is 750.

◆ Debug() [1/2]

bool Sfs2X::Util::ConfigData::Debug ( )

Get the state for the client-server messages debug.

The default value is false.

◆ Debug() [2/2]

void Sfs2X::Util::ConfigData::Debug ( bool value )

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

The default value is false.

◆ ForceIPv6() [1/2]

bool Sfs2X::Util::ConfigData::ForceIPv6 ( )

Gets selected IPv4 or IPv6 mode to connect to the SmartFoxServer 2X instance (TCP and UDP connections).

The default value is false.

◆ ForceIPv6() [2/2]

void Sfs2X::Util::ConfigData::ForceIPv6 ( bool value )

Selects the usage of IPv4 or IPv6 to connect to the SmartFoxServer 2X instance (TCP and UDP connections).

Set false to select IPv4; true for IPv6 The default value is false.

◆ Host() [1/2]

string Sfs2X::Util::ConfigData::Host ( )

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

The default value is 127.0.0.1.

◆ Host() [2/2]

void Sfs2X::Util::ConfigData::Host ( string value )

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.

◆ HttpPort() [1/2]

unsigned short int Sfs2X::Util::ConfigData::HttpPort ( )

Get the port for generic HTTP communication.

The default value is 8080.

◆ HttpPort() [2/2]

void Sfs2X::Util::ConfigData::HttpPort ( unsigned short int value )

Specifies the port for generic HTTP communication.

The default value is 8080.

◆ HttpsPort() [1/2]

unsigned short int Sfs2X::Util::ConfigData::HttpsPort ( )

Get the port for HTTPS communication.

For example this parameter is required during the initialization of an encrypted connection. The default value is 8443.

◆ HttpsPort() [2/2]

void Sfs2X::Util::ConfigData::HttpsPort ( unsigned short int value )

Specifies the port for HTTPS communication.

For example this parameter is required during the initialization of an encrypted connection. The default value is 8443.

◆ Port() [1/2]

unsigned short int Sfs2X::Util::ConfigData::Port ( )

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

The default value is 9933.

◆ Port() [2/2]

void Sfs2X::Util::ConfigData::Port ( unsigned short int value )

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

The default value is 9933.

◆ UdpHost() [1/2]

string Sfs2X::Util::ConfigData::UdpHost ( )

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

The default value is 127.0.0.1.

◆ UdpHost() [2/2]

void Sfs2X::Util::ConfigData::UdpHost ( string value )

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

The default value is 127.0.0.1.

◆ UdpPort() [1/2]

unsigned short int Sfs2X::Util::ConfigData::UdpPort ( )

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

The default value is 9933.

◆ UdpPort() [2/2]

void Sfs2X::Util::ConfigData::UdpPort ( unsigned short int value )

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

The default value is 9933.

◆ UseBlueBox() [1/2]

bool Sfs2X::Util::ConfigData::UseBlueBox ( )

Get the state for the SmartFoxServer's BlueBox.

The default value is true.

◆ UseBlueBox() [2/2]

void Sfs2X::Util::ConfigData::UseBlueBox ( bool value )

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

The default value is true.

◆ Zone() [1/2]

string Sfs2X::Util::ConfigData::Zone ( )

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

The default value is null.

◆ Zone() [2/2]

void Sfs2X::Util::ConfigData::Zone ( string value )

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

The default value is null.

Public Member Functions

Detailed Description

Member Function Documentation

◆ BlueBoxPollingRate() [1/2]

◆ BlueBoxPollingRate() [2/2]

◆ Debug() [1/2]

◆ Debug() [2/2]

◆ ForceIPv6() [1/2]

◆ ForceIPv6() [2/2]

◆ Host() [1/2]

◆ Host() [2/2]

◆ HttpPort() [1/2]

◆ HttpPort() [2/2]

◆ HttpsPort() [1/2]

◆ HttpsPort() [2/2]

◆ Port() [1/2]

◆ Port() [2/2]

◆ UdpHost() [1/2]

◆ UdpHost() [2/2]

◆ UdpPort() [1/2]

◆ UdpPort() [2/2]

◆ UseBlueBox() [1/2]

◆ UseBlueBox() [2/2]

◆ Zone() [1/2]

◆ Zone() [2/2]