io.socket.socketio.server

Class SocketIoServerOptions

java.lang.Object

io.socket.socketio.server.SocketIoServerOptions

public final class SocketIoServerOptions
extends Object

Options for SocketIoServer

Field Summary

Fields

Modifier and Type	Field and Description
static SocketIoServerOptions	DEFAULT The default options used by server.

Method Summary

Modifier and Type	Method and Description
SocketIoAdapter.AdapterFactory	getAdapterFactory() Gets the adapter factory instance.
long	getConnectionTimeout() Gets the amount of time to wait (ms) before a client without namespace is closed.
void	lock() Lock this options instance to prevent modifications.
static SocketIoServerOptions	newFromDefault() Create a new instance of SocketIoServerOptions by copying default options.
SocketIoServerOptions	setAdapterFactory(SocketIoAdapter.AdapterFactory adapterFactory) Sets the adapter factory instance.
SocketIoServerOptions	setConnectionTimeout(long connectionTimeout) Sets the amount of time to wait (ms) before a client without namespace is closed.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final SocketIoServerOptions DEFAULT

The default options used by server. This instance is locked and cannot be modified. adapter factory: SocketIoMemoryAdapter.Factory

Method Detail

newFromDefault

public static SocketIoServerOptions newFromDefault()

Create a new instance of SocketIoServerOptions by copying default options.

Returns:

New instance of SocketIoServerOptions with default options.

getConnectionTimeout

public long getConnectionTimeout()

Gets the amount of time to wait (ms) before a client without namespace is closed.

setConnectionTimeout

public SocketIoServerOptions setConnectionTimeout(long connectionTimeout)

Sets the amount of time to wait (ms) before a client without namespace is closed.

getAdapterFactory

public SocketIoAdapter.AdapterFactory getAdapterFactory()

Gets the adapter factory instance.

setAdapterFactory

public SocketIoServerOptions setAdapterFactory(SocketIoAdapter.AdapterFactory adapterFactory)
                                        throws IllegalStateException

Sets the adapter factory instance.

Parameters:

adapterFactory - Adapter factory instance to set or null for default.

Returns:

Instance for chaining.

Throws:

IllegalStateException - If instance is locked.

lock

public void lock()

Lock this options instance to prevent modifications.