Package sfs3.client

Class ConfigData

java.lang.Object
sfs3.client.ConfigData
public final class ConfigData extends Object
ConfigData contains all the settings for the connection. It must be passed to the SmartFox class to initiate a connection to the Server.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ConfigData.BlueBoxCfg
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    boolean
    allowUnsafeSSL
    Allows to test locally with the default, self-signed SSL/TLS certificate, skipping the validation of the certificate.
    ConfigData.BlueBoxCfg
    blueBox
    Settings to configure the HTTP tunnel, used when a TCP connection cannot be established
    String
    host
    The host to connect to
    int
    httpPort
    The HTTP port to be used for HTTP calls
    int
    httpsPort
    The HTTPS port to be used for HTTP calls
    sfs3.client.util.NetDebugLevel
    netDebugLevel
    Debug settings to show more information about the data exchange between client and server OFF: no extra info logged PACKET: additional packet hex dump is logged PROTOCOL: as above, plus each request/response structure is also dumped
    int
    port
    The TCP port used for the connection
    int
    tcpConnectionTimeout
    The amount of time (in milliseconds) after which the client should give up if there's no response from the server side
    int
    udpPort
    The UDP port used for a UDP connection
    boolean
    useSSL
    Enables protocol encryption.
    boolean
    useTcpFallback
    When sending data via UDP, if the UDP connection failed, it will use TCP instead
    boolean
    useTcpNoDelay
    Toggles the Nagle algorithm for the TCP connection More on this here: https://en.wikipedia.org/wiki/Nagle's_algorithm
    String
    zone
    The name of the Zone to connect to

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigData()
     

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • host

      public String host
      The host to connect to

    • port

      public int port
      The TCP port used for the connection

    • udpPort

      public int udpPort
      The UDP port used for a UDP connection

    • httpPort

      public int httpPort
      The HTTP port to be used for HTTP calls

    • httpsPort

      public int httpsPort
      The HTTPS port to be used for HTTP calls

    • tcpConnectionTimeout

      public int tcpConnectionTimeout
      The amount of time (in milliseconds) after which the client should give up if there's no response from the server side

    • zone

      public String zone
      The name of the Zone to connect to

    • blueBox

      public ConfigData.BlueBoxCfg blueBox
      Settings to configure the HTTP tunnel, used when a TCP connection cannot be established

    • netDebugLevel

      public sfs3.client.util.NetDebugLevel netDebugLevel
      Debug settings to show more information about the data exchange between client and server
      • OFF: no extra info logged
      • PACKET: additional packet hex dump is logged
      • PROTOCOL: as above, plus each request/response structure is also dumped

    • useSSL

      public boolean useSSL
      Enables protocol encryption. This requires that the server is configured accordingly and a valid SSL/TLS certificate is installed For more details check the online documentation, under Getting Started > Configuring TLS/SSL

    • allowUnsafeSSL

      public boolean allowUnsafeSSL
      Allows to test locally with the default, self-signed SSL/TLS certificate, skipping the validation of the certificate.

    • useTcpFallback

      public boolean useTcpFallback
      When sending data via UDP, if the UDP connection failed, it will use TCP instead

    • useTcpNoDelay

      public boolean useTcpNoDelay
      Toggles the Nagle algorithm for the TCP connection More on this here: https://en.wikipedia.org/wiki/Nagle's_algorithm

  • Constructor Details

    • ConfigData

      public ConfigData()