Package sfs2x.client.util

Class ConfigData

  • public class ConfigData
extends java.lang.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 connect(ConfigData) method of the SmartFox class.
    See Also:
    SmartFox.loadConfig(), SmartFox.connect(ConfigData)

    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigData()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getBboxHost()
      Specifies the IP address or host name of the BlueBox.
      int getBboxPollingRate()
      Specifies the BlueBox polling speed.
      java.lang.String getHost()
      Specifies the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection).
      int getHttpPort()
      Specifies the port for generic HTTP communication.
      int getHttpsPort()
      Specifies the port for HTTPS communication.
      int getPort()
      Specifies the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection).
      java.lang.String getUdpHost()
      Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection).
      int getUdpPort()
      Specifies the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection).
      java.lang.String getZone()
      Specifies the Zone of the SmartFoxServer 2X instance to join.
      boolean isDebug()
      Indicates whether the client-server messages debug should be enabled or not.
      boolean isUseBBox()
      Indicates whether the SmartFoxServer's BlueBox should be enabled or not.
      void setBboxHost​(java.lang.String bboxHost)  
      void setBboxPollingRate​(int bboxPollingRate)  
      void setDebug​(boolean debug)  
      void setHost​(java.lang.String host)  
      void setHttpPort​(int httpPort)  
      void setHttpsPort​(int httpsPort)  
      void setPort​(int port)  
      void setUdpHost​(java.lang.String udpHost)  
      void setUdpPort​(int udpPort)  
      void setUseBBox​(boolean useBBox)  
      void setZone​(java.lang.String zone)  

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ConfigData

        public ConfigData()

    • Method Detail

      • isDebug

        public boolean isDebug()
        Indicates whether the client-server messages debug should be enabled or not.

        The default value is false.

        See Also:
        setDebug(boolean)

      • setDebug

        public void setDebug​(boolean debug)
        See Also:
        isDebug()

      • getHost

        public java.lang.String getHost()
        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.

        See Also:
        setHost(String)

      • setHost

        public void setHost​(java.lang.String host)
        See Also:
        getHost()

      • getPort

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

        The default value is 9933.

        See Also:
        setPort(int)

      • setPort

        public void setPort​(int port)
        See Also:
        getPort()

      • getUdpHost

        public java.lang.String getUdpHost()
        Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection).

        The default value is 127.0.0.1.

        See Also:
        setUdpHost(String)

      • setUdpHost

        public void setUdpHost​(java.lang.String udpHost)
        See Also:
        getUdpHost()

      • getUdpPort

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

        The default value is 9933.

        See Also:
        setUdpPort(int)

      • setUdpPort

        public void setUdpPort​(int udpPort)
        See Also:
        getUdpPort()

      • isUseBBox

        public boolean isUseBBox()
        Indicates whether the SmartFoxServer's BlueBox should be enabled or not.

        The default value is true.

        See Also:
        setUseBBox(boolean)

      • setUseBBox

        public void setUseBBox​(boolean useBBox)
        See Also:
        isUseBBox()

      • getBboxHost

        public java.lang.String getBboxHost()
        Specifies the IP address or host name of the BlueBox.

        The default value is null.

        See Also:
        setBboxHost(String)

      • setBboxHost

        public void setBboxHost​(java.lang.String bboxHost)
        See Also:
        getBboxHost()

      • getBboxPollingRate

        public int getBboxPollingRate()
        Specifies the BlueBox polling speed.

        The default value is 750.

        See Also:
        setBboxPollingRate(int)

      • setBboxPollingRate

        public void setBboxPollingRate​(int bboxPollingRate)
        See Also:
        getBboxPollingRate()

      • getHttpPort

        public int getHttpPort()
        Specifies the port for generic HTTP communication.

        The default value is 8080.

        See Also:
        setHttpPort(int)

      • setHttpPort

        public void setHttpPort​(int httpPort)
        See Also:
        getHttpPort()

      • getZone

        public java.lang.String getZone()
        Specifies the Zone of the SmartFoxServer 2X instance to join.

        The default value is null.

        See Also:
        setZone(String)

      • setZone

        public void setZone​(java.lang.String zone)
        See Also:
        getZone()

      • getHttpsPort

        public int getHttpsPort()
        Specifies the port for HTTPS communication. E.g. the initialization of an encrypted connection

        The default value is 8443.

        See Also:
        setHttpPort(int)

      • setHttpsPort

        public void setHttpsPort​(int httpsPort)
        See Also:
        getHttpsPort()