io.socket.engineio.server

Class EngineIoServerOptions

java.lang.Object

io.socket.engineio.server.EngineIoServerOptions

public final class EngineIoServerOptions
extends Object

Options for EngineIoServer

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALLOWED_CORS_ORIGIN_ALL Specify that all origins are to be allowed for CORS
static String[]	ALLOWED_CORS_ORIGIN_NONE Specify that no origins are allowed for CORS
static EngineIoServerOptions	DEFAULT The default options used by server.

Method Summary

Modifier and Type	Method and Description
String[]	getAllowedCorsOrigins() Gets the allowed CORS origins option.
io.socket.engineio.parser.Packet<?>	getInitialPacket() Gets the initial packet option.
int	getMaxTimeoutThreadPoolSize() Gets the max threadpool size for the ping timeout timers.
long	getPingInterval() Gets the ping interval option.
long	getPingTimeout() Gets the ping timeout option.
boolean	isCorsHandlingDisabled() Gets the value of 'isCorsHandlingDisabled' option.
void	lock() Lock this options instance to prevent modifications.
static EngineIoServerOptions	newFromDefault() Create a new instance of EngineIoServerOptions by copying default options.
EngineIoServerOptions	setAllowedCorsOrigins(String[] allowedCorsOrigins) Sets the allowed CORS origins option.
EngineIoServerOptions	setCorsHandlingDisabled(boolean corsHandlingDisabled) Sets the 'isCorsHandlingDisabled' option.
EngineIoServerOptions	setInitialPacket(io.socket.engineio.parser.Packet<?> initialPacket) Sets the initial packet.
EngineIoServerOptions	setMaxTimeoutThreadPoolSize(int maxTimeoutThreadPoolSize) Sets the max threadpool size for the ping timeout timers.
EngineIoServerOptions	setPingInterval(long pingInterval) Sets the ping interval option.
EngineIoServerOptions	setPingTimeout(long pingTimeout) Sets the ping timeout option.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final EngineIoServerOptions DEFAULT

The default options used by server. This instance is locked and cannot be modified. ping timeout: 5000 ping interval: 25000 allowed origins: *

ALLOWED_CORS_ORIGIN_ALL

public static final String[] ALLOWED_CORS_ORIGIN_ALL

Specify that all origins are to be allowed for CORS

ALLOWED_CORS_ORIGIN_NONE

public static final String[] ALLOWED_CORS_ORIGIN_NONE

Specify that no origins are allowed for CORS

Method Detail

newFromDefault

public static EngineIoServerOptions newFromDefault()

Create a new instance of EngineIoServerOptions by copying default options.

Returns:

New instance of EngineIoServerOptions with default options.

isCorsHandlingDisabled

public boolean isCorsHandlingDisabled()

Gets the value of 'isCorsHandlingDisabled' option.

Returns:

Boolean value indicating if CORS handling is disabled.

setCorsHandlingDisabled

public EngineIoServerOptions setCorsHandlingDisabled(boolean corsHandlingDisabled)
                                              throws IllegalStateException

Sets the 'isCorsHandlingDisabled' option.

Parameters:

corsHandlingDisabled - Boolean value for disabling CORS handling.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.

getPingInterval

public long getPingInterval()

Gets the ping interval option.

Returns:

Ping interval in milliseconds.

setPingInterval

public EngineIoServerOptions setPingInterval(long pingInterval)
                                      throws IllegalStateException

Sets the ping interval option.

Parameters:

pingInterval - Ping interval in milliseconds.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.

getPingTimeout

public long getPingTimeout()

Gets the ping timeout option.

Returns:

Ping timeout in milliseconds.

setPingTimeout

public EngineIoServerOptions setPingTimeout(long pingTimeout)
                                     throws IllegalStateException

Sets the ping timeout option.

Parameters:

pingTimeout - Ping timeout in milliseconds.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.

getAllowedCorsOrigins

public String[] getAllowedCorsOrigins()

Gets the allowed CORS origins option.

Returns:

Array of strings containing allowed CORS origins.

setAllowedCorsOrigins

public EngineIoServerOptions setAllowedCorsOrigins(String[] allowedCorsOrigins)
                                            throws IllegalStateException

Sets the allowed CORS origins option.

Parameters:

allowedCorsOrigins - Array of strings containing allowed CORS origins.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.

getInitialPacket

public io.socket.engineio.parser.Packet<?> getInitialPacket()

Gets the initial packet option.

Returns:

Initial packet.

setInitialPacket

public EngineIoServerOptions setInitialPacket(io.socket.engineio.parser.Packet<?> initialPacket)
                                       throws IllegalStateException,
                                              IllegalArgumentException

Sets the initial packet.

Parameters:

initialPacket - The initial packet to send on client connection.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.

IllegalArgumentException - If initialPacket.type is not message or data is null.

lock

public void lock()

Lock this options instance to prevent modifications.

getMaxTimeoutThreadPoolSize

public int getMaxTimeoutThreadPoolSize()

Gets the max threadpool size for the ping timeout timers.

Returns:

Max threadpool size for ping timeout timers.

setMaxTimeoutThreadPoolSize

public EngineIoServerOptions setMaxTimeoutThreadPoolSize(int maxTimeoutThreadPoolSize)
                                                  throws IllegalStateException

Sets the max threadpool size for the ping timeout timers.

Parameters:

maxTimeoutThreadPoolSize - Max threadpool size for handling ping timeouts.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.