io.scalecube.socketio

Class ServerConfiguration

java.lang.Object

io.scalecube.socketio.ServerConfiguration

public class ServerConfiguration
extends Object

Class represents different options of socket.io server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ServerConfiguration	DEFAULT
static boolean	DEFAULT_ALWAYS_SECURE_WEB_SOCKET_LOCATION
static int	DEFAULT_CLOSE_TIMEOUT
static boolean	DEFAULT_EVENT_EXECUTOR_ENABLED
static int	DEFAULT_EVENT_EXECUTOR_THREAD_NUMBER
static int	DEFAULT_HEARTBEAT_INTERVAL
static int	DEFAULT_HEARTBEAT_TIMEOUT
static int	DEFAULT_MAX_WEB_SOCKET_FRAME_SIZE
static int	DEFAULT_PORT
static String	DEFAULT_REMOTE_ADDRESS_HEADER
static SSLContext	DEFAULT_SSL_CONTEXT
static String	DEFAULT_TRANSPORTS

Method Summary

Modifier and Type	Method and Description
static ServerConfiguration.Builder	builder()
int	getCloseTimeout() The timeout in seconds for the client, when it closes the connection it still X amounts of seconds to do re open of the connection.
int	getEventExecutorThreadNumber()
int	getHeartbeatInterval() The timeout in seconds for the server, we should receive a heartbeat from the client within this interval.
int	getHeartbeatTimeout() The timeout in seconds for the client when it should send a new heart beat to the server.
int	getMaxWebSocketFrameSize() Maximum allowable web socket frame payload length.
int	getPort() Port on which Socket.IO server will be started.
String	getRemoteAddressHeader() The HTTP header name which is used as a session remote address.
SSLContext	getSslContext() SSL context which is used to run secure socket.
String	getTransports() A string with list of allowed transport methods separated by comma.
boolean	isAlwaysSecureWebSocketLocation() Flag which if set to true will always return secure web socket location protocol ("wss://") even when connection is established over plain socket.
boolean	isEventExecutorEnabled() Flag which defines if listener will be executed, true - different thread, false - io-thread.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ServerConfiguration DEFAULT

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_TIMEOUT

public static final int DEFAULT_HEARTBEAT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_INTERVAL

public static final int DEFAULT_HEARTBEAT_INTERVAL

See Also:

Constant Field Values

DEFAULT_CLOSE_TIMEOUT

public static final int DEFAULT_CLOSE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_TRANSPORTS

public static final String DEFAULT_TRANSPORTS

See Also:

Constant Field Values

DEFAULT_ALWAYS_SECURE_WEB_SOCKET_LOCATION

public static final boolean DEFAULT_ALWAYS_SECURE_WEB_SOCKET_LOCATION

See Also:

Constant Field Values

DEFAULT_REMOTE_ADDRESS_HEADER

public static final String DEFAULT_REMOTE_ADDRESS_HEADER

DEFAULT_EVENT_EXECUTOR_ENABLED

public static final boolean DEFAULT_EVENT_EXECUTOR_ENABLED

See Also:

Constant Field Values

DEFAULT_EVENT_EXECUTOR_THREAD_NUMBER

public static final int DEFAULT_EVENT_EXECUTOR_THREAD_NUMBER

DEFAULT_MAX_WEB_SOCKET_FRAME_SIZE

public static final int DEFAULT_MAX_WEB_SOCKET_FRAME_SIZE

See Also:

Constant Field Values

DEFAULT_SSL_CONTEXT

public static final SSLContext DEFAULT_SSL_CONTEXT

Method Detail

builder

public static ServerConfiguration.Builder builder()

getPort

public int getPort()

Port on which Socket.IO server will be started. Default value is 8080.

getSslContext

public SSLContext getSslContext()

SSL context which is used to run secure socket. If it's set to null server runs without SSL. Default value is null.

getHeartbeatTimeout

public int getHeartbeatTimeout()

The timeout in seconds for the client when it should send a new heart beat to the server. This value is sent to the client after a successful handshake. The default value is 60.

getCloseTimeout

public int getCloseTimeout()

The timeout in seconds for the client, when it closes the connection it still X amounts of seconds to do re open of the connection. This value is sent to the client after a successful handshake. Default value is 60.

getTransports

public String getTransports()

A string with list of allowed transport methods separated by comma. Default value is "websocket,flashsocket,xhr-polling,jsonp-polling".

getHeartbeatInterval

public int getHeartbeatInterval()

The timeout in seconds for the server, we should receive a heartbeat from the client within this interval. This should be less than the heartbeat timeout. Default value is 25.

isAlwaysSecureWebSocketLocation

public boolean isAlwaysSecureWebSocketLocation()

Flag which if set to true will always return secure web socket location protocol ("wss://") even when connection is established over plain socket. It is used as a workaround related to case when SSL is offloaded to Load Balancer, but it doesn't modify web socket location. By default it is false.

getRemoteAddressHeader

public String getRemoteAddressHeader()

The HTTP header name which is used as a session remote address. It is a workaround related to case when Load Balancer modify client address with its address. This header is supposed to be set by Load Balancer. If it is set to null then this header is not used. Default value is null.

isEventExecutorEnabled

public boolean isEventExecutorEnabled()

Flag which defines if listener will be executed, true - different thread, false - io-thread. Default is true.

getEventExecutorThreadNumber

public int getEventExecutorThreadNumber()

getMaxWebSocketFrameSize

public int getMaxWebSocketFrameSize()

Maximum allowable web socket frame payload length. Setting this value to your application's requirement may reduce denial of service attacks using long data frames. Default is 65536.

toString

public String toString()

Overrides:

toString in class Object