io.socket.engineio.server

Class EngineIoServer

java.lang.Object

io.socket.engineio.server.Emitter

io.socket.engineio.server.EngineIoServer

public final class EngineIoServer
extends Emitter

The engine.io server. This class is responsible for handling all HTTP and WebSocket requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EngineIoServer.HandshakeInterceptor

Nested classes/interfaces inherited from class io.socket.engineio.server.Emitter

Emitter.Listener

Constructor Summary

Constructors

Constructor and Description
EngineIoServer() Create instance of server with default options.
EngineIoServer(EngineIoServerOptions options) Create instance of server with specified options.

Method Summary

Modifier and Type	Method and Description
EngineIoServerOptions	getOptions() Gets the configured options for this server instance.
ScheduledExecutorService	getScheduledExecutor() Gets the underlying executor used for ping timeout handling.
void	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle an HTTP request.
void	handleWebSocket(EngineIoWebSocket webSocket) Handle a WebSocket request.
void	shutdown() Releases resources such as threads and clients.

Methods inherited from class io.socket.engineio.server.Emitter

emit, hasListeners, listeners, off, off, off, on, once

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineIoServer

public EngineIoServer()

Create instance of server with default options.

EngineIoServer

public EngineIoServer(EngineIoServerOptions options)

Create instance of server with specified options. The options instance is locked to prevent further modifications.

Parameters:

options - Server options.

Method Detail

getOptions

public EngineIoServerOptions getOptions()

Gets the configured options for this server instance.

getScheduledExecutor

public ScheduledExecutorService getScheduledExecutor()

Gets the underlying executor used for ping timeout handling.

shutdown

public void shutdown()

Releases resources such as threads and clients.

handleRequest

public void handleRequest(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws IOException

Handle an HTTP request. This method handles polling transport connections.

Parameters:

request - The HTTP request object.

response - The HTTP response object.

Throws:

IOException - On IO error.

handleWebSocket

public void handleWebSocket(EngineIoWebSocket webSocket)

Handle a WebSocket request. This method handles websocket transport connections.

Parameters:

webSocket - The WebSocket connection object.