Document configuration class about netty-socketio

[pablojr]

I would like to work on this if you mind

[mrniko]

Ok, it would be nice!

[pablojr]

Netty-socketio Configuration details

Netty-socketio can be configured by means of a Configuration object provided during server creation. Such configuration is cloned, so further changes to the Configuration object will not affect server.

Details

• setHostname If not set then bind address will be 0.0.0.0 or ::0
• setPort The port the socket.io server will listen to
• setJsonTypeFieldName defaults to "@Class"
• setJsonSupport Allows to setup custom implementation of JSON serialization/deserialization. See JsonSupport
• setBossExecutor Sets the BossExecutor of underlying NioServer, defaults to Executors.newCachedThreadPool()
• setWorkerExecutor Sets the WorkerExecutor of underlying NioServer, defaults to Executors.newCachedThreadPool()
• setHeartbeatInterval Heartbeat interval (in seconds), defaults to 25
• setHeartbeatTimeout Heartbeat timeout (in seconds), defaults to 60. Use 0 to disable it
• setHeartbeatThreadPoolSize Heartbeat thread pool size, defaults to 2 times the "available processors" at runtime
• setCloseTimeout Channel close timeout (in seconds) due to inactivity, defaults to 60
• setContext Namespace, defaults to "/socket.io"
• setAllowCustomRequests Allow to service custom requests that differ from socket.io protocol, defaults to false.
  • If true, add own handler which handle custom requests in order to avoid hang connections.
• setPollingDuration Polling interval for XHR transport (in seconds), defaults to 20
• setKeyStorePassword SSL key store password (for secure connections)
• setKeyStore SSL key store stream, maybe appointed to any source
• setMaxHttpContentLength Set maximum HTTP content length limit, defaults to 64KB.
  • If the length of the aggregated content exceeds this value, a TooLongFrameException will be raised.
• setTransports Transports supported by server, defaults to [Transport.WEBSOCKET, Transport.FLASHSOCKET, Transport.XHRPOLLING]. Cannot be empty list

Usage example

    Configuration config = new Configuration();
    config.setHostname("localhost");
    config.setPort(1337);
    config.setCloseTimeout(30);

    SocketIOServer server = new SocketIOServer(config);
    ...

[pablojr]

Not sure if this was what you expected? Or do you mean documenting the class by javadoc? Please let me know

[mrniko]

Thanks a lot, for description! I created wiki page for it.

[pablojr]

Will you call this item closed now?

[pramodbms]

In the latest 1.7.9, I cannot find a method to set the XHR polling interval as mentioned in this configuration wiki.

I would like to control the XHR polling interval in cases, where the websocket upgrade fails. How can this be configured?