com.corundumstudio.socketio

Class Configuration

java.lang.Object

com.corundumstudio.socketio.Configuration

public class Configuration
extends Object

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationListener	getAuthorizationListener()
int	getBossThreads()
int	getCloseTimeout()
String	getContext()
ExceptionListener	getExceptionListener()
int	getHeartbeatInterval()
int	getHeartbeatTimeout()
String	getHostname()
JsonSupport	getJsonSupport()
String	getJsonTypeFieldName()
InputStream	getKeyStore()
String	getKeyStorePassword()
int	getMaxHttpContentLength()
String	getPackagePrefix()
int	getPollingDuration()
int	getPort()
SocketConfig	getSocketConfig()
StoreFactory	getStoreFactory()
String	getTransports()
int	getWorkerThreads()
boolean	isAllowCustomRequests()
boolean	isAutoAck()
boolean	isHeartbeatsEnabled()
boolean	isPreferDirectBuffer()
void	setAllowCustomRequests(boolean allowCustomRequests) Allow to service custom requests differs from socket.io protocol.
void	setAuthorizationListener(AuthorizationListener authorizationListener) Authorization listener invoked on every handshake.
void	setAutoAck(boolean autoAck) Send ack-response automatically on each ack-request Default is true
void	setBossThreads(int bossThreads)
void	setCloseTimeout(int closeTimeout) Channel close timeout due inactivity
void	setContext(String context)
void	setExceptionListener(ExceptionListener exceptionListener) Exception listener invoked on any exception in SocketIO listener
void	setHeartbeatInterval(int heartbeatIntervalSecs) Heartbeat interval
void	setHeartbeatTimeout(int heartbeatTimeoutSecs) Heartbeat timeout Use 0 to disable it
void	setHostname(String hostname) Optional parameter.
void	setJsonSupport(JsonSupport jsonSupport) Allows to setup custom implementation of JSON serialization/deserialization
void	setJsonTypeFieldName(String jsonTypeFieldName)
void	setKeyStore(InputStream keyStore) SSL key store stream, maybe appointed to any source
void	setKeyStorePassword(String keyStorePassword) SSL key store password
void	setMaxHttpContentLength(int value) Set maximum http content length limit
void	setPackagePrefix(String packagePrefix) Package prefix for sending json-object from client without full class name.
void	setPollingDuration(int pollingDuration) Polling interval for XHR transport
void	setPort(int port)
void	setPreferDirectBuffer(boolean preferDirectBuffer) Buffer allocation method used during packet encoding.
void	setSocketConfig(SocketConfig socketConfig) TCP socket configuration
void	setStoreFactory(StoreFactory clientStoreFactory) Data store - used to store session data and implements distributed pubsub.
void	setTransports(Transport... transports) Transports supported by server
void	setWorkerThreads(int workerThreads)

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

getJsonTypeFieldName

public String getJsonTypeFieldName()

setJsonTypeFieldName

public void setJsonTypeFieldName(String jsonTypeFieldName)

getJsonSupport

public JsonSupport getJsonSupport()

setJsonSupport

public void setJsonSupport(JsonSupport jsonSupport)

Allows to setup custom implementation of JSON serialization/deserialization

Parameters:

jsonSupport -

See Also:

JsonSupport

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

Optional parameter. If not set then bind address will be 0.0.0.0 or ::0

Parameters:

hostname -

getPort

public int getPort()

setPort

public void setPort(int port)

getBossThreads

public int getBossThreads()

setBossThreads

public void setBossThreads(int bossThreads)

getWorkerThreads

public int getWorkerThreads()

setWorkerThreads

public void setWorkerThreads(int workerThreads)

setHeartbeatInterval

public void setHeartbeatInterval(int heartbeatIntervalSecs)

Heartbeat interval

Parameters:

value - - time in seconds

getHeartbeatInterval

public int getHeartbeatInterval()

setHeartbeatTimeout

public void setHeartbeatTimeout(int heartbeatTimeoutSecs)

Heartbeat timeout Use 0 to disable it

Parameters:

value - - time in seconds

getHeartbeatTimeout

public int getHeartbeatTimeout()

isHeartbeatsEnabled

public boolean isHeartbeatsEnabled()

setCloseTimeout

public void setCloseTimeout(int closeTimeout)

Channel close timeout due inactivity

Parameters:

closeTimeout - - time in seconds

getCloseTimeout

public int getCloseTimeout()

getContext

public String getContext()

setContext

public void setContext(String context)

isAllowCustomRequests

public boolean isAllowCustomRequests()

setAllowCustomRequests

public void setAllowCustomRequests(boolean allowCustomRequests)

Allow to service custom requests differs from socket.io protocol. In this case it's necessary to add own handler which handle them to avoid hang connections. Default is false

Parameters:

allowCustomRequests - - true to allow

getPollingDuration

public int getPollingDuration()

setPollingDuration

public void setPollingDuration(int pollingDuration)

Polling interval for XHR transport

Parameters:

pollingDuration - - time in seconds

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

SSL key store password

Parameters:

keyStorePassword -

getKeyStorePassword

public String getKeyStorePassword()

setKeyStore

public void setKeyStore(InputStream keyStore)

SSL key store stream, maybe appointed to any source

Parameters:

keyStore -

getKeyStore

public InputStream getKeyStore()

setMaxHttpContentLength

public void setMaxHttpContentLength(int value)

Set maximum http content length limit

Parameters:

maxContentLength - the maximum length of the aggregated http content. If the length of the aggregated content exceeds this value, a TooLongFrameException will be raised.

getMaxHttpContentLength

public int getMaxHttpContentLength()

setTransports

public void setTransports(Transport... transports)

Transports supported by server

Parameters:

transports - - list of transports

getTransports

public String getTransports()

setPackagePrefix

public void setPackagePrefix(String packagePrefix)

Package prefix for sending json-object from client without full class name. With defined package prefix socket.io client just need to define '@class: 'SomeType'' in json object instead of '@class: 'com.full.package.name.SomeType''

Parameters:

packagePrefix - - prefix string

getPackagePrefix

public String getPackagePrefix()

setPreferDirectBuffer

public void setPreferDirectBuffer(boolean preferDirectBuffer)

Buffer allocation method used during packet encoding. Default is true

Parameters:

preferDirectBuffer - true if a direct buffer should be tried to be used as target for the encoded messages. If false is used it will allocate a heap buffer, which is backed by an byte array.

isPreferDirectBuffer

public boolean isPreferDirectBuffer()

setStoreFactory

public void setStoreFactory(StoreFactory clientStoreFactory)

Data store - used to store session data and implements distributed pubsub. Default is MemoryStoreFactory

Parameters:

storeFactory - - implements StoreFactory

See Also:

MemoryStoreFactory, RedissonStoreFactory, HazelcastStoreFactory

getStoreFactory

public StoreFactory getStoreFactory()

setAuthorizationListener

public void setAuthorizationListener(AuthorizationListener authorizationListener)

Authorization listener invoked on every handshake. Accepts or denies a client by AuthorizationListener.isAuthorized method. Accepts all clients by default.

Parameters:

authorizationListener - - authorization listener itself

See Also:

AuthorizationListener

getAuthorizationListener

public AuthorizationListener getAuthorizationListener()

setExceptionListener

public void setExceptionListener(ExceptionListener exceptionListener)

Exception listener invoked on any exception in SocketIO listener

Parameters:

exceptionListener -

See Also:

ExceptionListener

getExceptionListener

public ExceptionListener getExceptionListener()

getSocketConfig

public SocketConfig getSocketConfig()

setSocketConfig

public void setSocketConfig(SocketConfig socketConfig)

TCP socket configuration

Parameters:

socketConfig -

setAutoAck

public void setAutoAck(boolean autoAck)

Send ack-response automatically on each ack-request Default is true

Parameters:

autoAck -

isAutoAck

public boolean isAutoAck()