Configuration (NettySocketIO 1.7.19 API)

java.lang.Object
- com.corundumstudio.socketio.Configuration

public class Configuration
extends Object

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AckMode`	`getAckMode()`
`AuthorizationListener`	`getAuthorizationListener()`
`int`	`getBossThreads()`
`String`	`getContext()`
`ExceptionListener`	`getExceptionListener()`
`int`	`getFirstDataTimeout()`
`String`	`getHostname()`
`JsonSupport`	`getJsonSupport()`
`String`	`getKeyManagerFactoryAlgorithm()`
`InputStream`	`getKeyStore()`
`String`	`getKeyStoreFormat()`
`String`	`getKeyStorePassword()`
`int`	`getMaxFramePayloadLength()`
`int`	`getMaxHttpContentLength()`
`String`	`getOrigin()`
`String`	`getPackagePrefix()`
`int`	`getPingInterval()`
`int`	`getPingTimeout()`
`int`	`getPort()`
`SocketConfig`	`getSocketConfig()`
`String`	`getSSLProtocol()`
`StoreFactory`	`getStoreFactory()`
`List<Transport>`	`getTransports()`
`InputStream`	`getTrustStore()`
`String`	`getTrustStoreFormat()`
`String`	`getTrustStorePassword()`
`int`	`getUpgradeTimeout()`
`int`	`getWorkerThreads()`
`boolean`	`isAddVersionHeader()`
`boolean`	`isAllowCustomRequests()`
`boolean`	`isHeartbeatsEnabled()`
`boolean`	`isHttpCompression()`
`boolean`	`isPreferDirectBuffer()`
`boolean`	`isRandomSession()`
`boolean`	`isUseLinuxNativeEpoll()`
`boolean`	`isWebsocketCompression()`
`void`	`setAckMode(AckMode ackMode)` Auto ack-response mode Default is `AckMode.AUTO_SUCCESS_ONLY`
`void`	`setAddVersionHeader(boolean addVersionHeader)` Adds Server header with lib version to http response.
`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`	`setBossThreads(int bossThreads)`
`void`	`setContext(String context)`
`void`	`setExceptionListener(ExceptionListener exceptionListener)` Exception listener invoked on any exception in SocketIO listener
`void`	`setFirstDataTimeout(int firstDataTimeout)` Timeout between channel opening and first data transfer Helps to avoid 'silent channel' attack and prevents 'Too many open files' problem in this case
`void`	`setHostname(String hostname)` Optional parameter.
`void`	`setHttpCompression(boolean httpCompression)` Activate http protocol compression.
`void`	`setJsonSupport(JsonSupport jsonSupport)` Allows to setup custom implementation of JSON serialization/deserialization
`void`	`setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)`
`void`	`setKeyStore(InputStream keyStore)` SSL key store stream, maybe appointed to any source
`void`	`setKeyStoreFormat(String keyStoreFormat)` Key store format
`void`	`setKeyStorePassword(String keyStorePassword)` SSL key store password
`void`	`setMaxFramePayloadLength(int maxFramePayloadLength)` Set maximum websocket frame content length limit
`void`	`setMaxHttpContentLength(int value)` Set maximum http content length limit
`void`	`setOrigin(String origin)` Set Access-Control-Allow-Origin header value for http each response.
`void`	`setPackagePrefix(String packagePrefix)` Package prefix for sending json-object from client without full class name.
`void`	`setPingInterval(int heartbeatIntervalSecs)` Ping interval
`void`	`setPingTimeout(int heartbeatTimeoutSecs)` Ping timeout Use `0` to disable it
`void`	`setPort(int port)`
`void`	`setPreferDirectBuffer(boolean preferDirectBuffer)` Buffer allocation method used during packet encoding.
`void`	`setRandomSession(boolean randomSession)`
`void`	`setSocketConfig(SocketConfig socketConfig)` TCP socket configuration
`void`	`setSSLProtocol(String sslProtocol)` Set the name of the requested SSL protocol
`void`	`setStoreFactory(StoreFactory clientStoreFactory)` Data store - used to store session data and implements distributed pubsub.
`void`	`setTransports(Transport... transports)` Transports supported by server
`void`	`setTrustStore(InputStream trustStore)`
`void`	`setTrustStoreFormat(String trustStoreFormat)`
`void`	`setTrustStorePassword(String trustStorePassword)`
`void`	`setUpgradeTimeout(int upgradeTimeout)` Transport upgrade timeout in milliseconds
`void`	`setUseLinuxNativeEpoll(boolean useLinuxNativeEpoll)`
`void`	`setWebsocketCompression(boolean websocketCompression)` Activate websocket protocol compression.
`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
  - getJsonSupport
```
public JsonSupport getJsonSupport()
```
  - setJsonSupport
```
public void setJsonSupport(JsonSupport jsonSupport)
```
    Allows to setup custom implementation of JSON serialization/deserialization
    
    Parameters:
    
    jsonSupport - - json mapper
    
    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 - - name of host
  - 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)
```
  - setPingInterval
```
public void setPingInterval(int heartbeatIntervalSecs)
```
    Ping interval
    
    Parameters:
    
    heartbeatIntervalSecs - - time in milliseconds
  - getPingInterval
```
public int getPingInterval()
```
  - setPingTimeout
```
public void setPingTimeout(int heartbeatTimeoutSecs)
```
    Ping timeout Use 0 to disable it
    
    Parameters:
    
    heartbeatTimeoutSecs - - time in milliseconds
  - getPingTimeout
```
public int getPingTimeout()
```
  - isHeartbeatsEnabled
```
public boolean isHeartbeatsEnabled()
```
  - 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
  - setKeyStorePassword
```
public void setKeyStorePassword(String keyStorePassword)
```
    SSL key store password
    
    Parameters:
    
    keyStorePassword - - password of key store
  - getKeyStorePassword
```
public String getKeyStorePassword()
```
  - setKeyStore
```
public void setKeyStore(InputStream keyStore)
```
    SSL key store stream, maybe appointed to any source
    
    Parameters:
    
    keyStore - - key store input stream
  - getKeyStore
```
public InputStream getKeyStore()
```
  - setKeyStoreFormat
```
public void setKeyStoreFormat(String keyStoreFormat)
```
    Key store format
    
    Parameters:
    
    keyStoreFormat - - key store format
  - getKeyStoreFormat
```
public String getKeyStoreFormat()
```
  - setMaxHttpContentLength
```
public void setMaxHttpContentLength(int value)
```
    Set maximum http content length limit
    
    Parameters:
    
    value - the maximum length of the aggregated http content.
  - getMaxHttpContentLength
```
public int getMaxHttpContentLength()
```
  - setTransports
```
public void setTransports(Transport... transports)
```
    Transports supported by server
    
    Parameters:
    
    transports - - list of transports
  - getTransports
```
public List<Transport> 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:
    
    clientStoreFactory - - 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 - - listener
    
    See Also:
    
    ExceptionListener
  - getExceptionListener
```
public ExceptionListener getExceptionListener()
```
  - getSocketConfig
```
public SocketConfig getSocketConfig()
```
  - setSocketConfig
```
public void setSocketConfig(SocketConfig socketConfig)
```
    TCP socket configuration
    
    Parameters:
    
    socketConfig - - config
  - setAckMode
```
public void setAckMode(AckMode ackMode)
```
    Auto ack-response mode Default is AckMode.AUTO_SUCCESS_ONLY
    
    Parameters:
    
    ackMode - - ack mode
    
    See Also:
    
    AckMode
  - getAckMode
```
public AckMode getAckMode()
```
  - getTrustStoreFormat
```
public String getTrustStoreFormat()
```
  - setTrustStoreFormat
```
public void setTrustStoreFormat(String trustStoreFormat)
```
  - getTrustStore
```
public InputStream getTrustStore()
```
  - setTrustStore
```
public void setTrustStore(InputStream trustStore)
```
  - getTrustStorePassword
```
public String getTrustStorePassword()
```
  - setTrustStorePassword
```
public void setTrustStorePassword(String trustStorePassword)
```
  - getKeyManagerFactoryAlgorithm
```
public String getKeyManagerFactoryAlgorithm()
```
  - setKeyManagerFactoryAlgorithm
```
public void setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)
```
  - setMaxFramePayloadLength
```
public void setMaxFramePayloadLength(int maxFramePayloadLength)
```
    Set maximum websocket frame content length limit
    
    Parameters:
    
    maxFramePayloadLength - - length
  - getMaxFramePayloadLength
```
public int getMaxFramePayloadLength()
```
  - setUpgradeTimeout
```
public void setUpgradeTimeout(int upgradeTimeout)
```
    Transport upgrade timeout in milliseconds
    
    Parameters:
    
    upgradeTimeout - - upgrade timeout
  - getUpgradeTimeout
```
public int getUpgradeTimeout()
```
  - setAddVersionHeader
```
public void setAddVersionHeader(boolean addVersionHeader)
```
    Adds Server header with lib version to http response.
    Default is true
    
    Parameters:
    
    addVersionHeader - - true to add header
  - isAddVersionHeader
```
public boolean isAddVersionHeader()
```
  - setOrigin
```
public void setOrigin(String origin)
```
    Set Access-Control-Allow-Origin header value for http each response. Default is null If value is null then request ORIGIN header value used.
    
    Parameters:
    
    origin - - origin
  - getOrigin
```
public String getOrigin()
```
  - isUseLinuxNativeEpoll
```
public boolean isUseLinuxNativeEpoll()
```
  - setUseLinuxNativeEpoll
```
public void setUseLinuxNativeEpoll(boolean useLinuxNativeEpoll)
```
  - setSSLProtocol
```
public void setSSLProtocol(String sslProtocol)
```
    Set the name of the requested SSL protocol
    
    Parameters:
    
    sslProtocol - - name of protocol
  - getSSLProtocol
```
public String getSSLProtocol()
```
  - setFirstDataTimeout
```
public void setFirstDataTimeout(int firstDataTimeout)
```
    Timeout between channel opening and first data transfer Helps to avoid 'silent channel' attack and prevents 'Too many open files' problem in this case
    
    Parameters:
    
    firstDataTimeout - - timeout value
  - getFirstDataTimeout
```
public int getFirstDataTimeout()
```
  - setHttpCompression
```
public void setHttpCompression(boolean httpCompression)
```
    Activate http protocol compression. Uses gzip or deflate encoding choice depends on the "Accept-Encoding" header value.
    Default is true
    
    Parameters:
    
    httpCompression - - true to use http compression
  - isHttpCompression
```
public boolean isHttpCompression()
```
  - setWebsocketCompression
```
public void setWebsocketCompression(boolean websocketCompression)
```
    Activate websocket protocol compression. Uses permessage-deflate encoding only.
    Default is true
    
    Parameters:
    
    websocketCompression - - true to use websocket compression
  - isWebsocketCompression
```
public boolean isWebsocketCompression()
```
  - isRandomSession
```
public boolean isRandomSession()
```
  - setRandomSession
```
public void setRandomSession(boolean randomSession)
```

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Method Detail

getJsonSupport

setJsonSupport

getHostname

setHostname

getPort

setPort

getBossThreads

setBossThreads

getWorkerThreads

setWorkerThreads

setPingInterval

getPingInterval

setPingTimeout

getPingTimeout

isHeartbeatsEnabled

getContext

setContext

isAllowCustomRequests

setAllowCustomRequests

setKeyStorePassword

getKeyStorePassword

setKeyStore

getKeyStore

setKeyStoreFormat

getKeyStoreFormat

setMaxHttpContentLength

getMaxHttpContentLength

setTransports

getTransports

setPackagePrefix

getPackagePrefix

setPreferDirectBuffer

isPreferDirectBuffer

setStoreFactory

getStoreFactory

setAuthorizationListener

getAuthorizationListener

setExceptionListener

getExceptionListener

getSocketConfig

setSocketConfig

setAckMode

getAckMode

getTrustStoreFormat

setTrustStoreFormat

getTrustStore

setTrustStore

getTrustStorePassword

setTrustStorePassword

getKeyManagerFactoryAlgorithm

setKeyManagerFactoryAlgorithm

setMaxFramePayloadLength

getMaxFramePayloadLength

setUpgradeTimeout

getUpgradeTimeout

setAddVersionHeader

isAddVersionHeader

setOrigin

getOrigin

isUseLinuxNativeEpoll

setUseLinuxNativeEpoll

setSSLProtocol

getSSLProtocol

setFirstDataTimeout

getFirstDataTimeout

setHttpCompression

isHttpCompression

setWebsocketCompression

isWebsocketCompression

isRandomSession

setRandomSession