Package 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	Description
static interface	EngineIoServer.HandshakeInterceptor

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

Emitter.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	ERROR_JSON
private java.util.HashSet<java.lang.String>	mAllowedCorsOrigins
private java.util.Map<java.lang.String,EngineIoSocket>	mClients
private EngineIoServer.HandshakeInterceptor	mHandshakeInterceptor
private EngineIoServerOptions	mOptions
private java.util.concurrent.ScheduledExecutorService	mScheduledExecutor

Constructor Summary

Constructors

Constructor	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	Description
EngineIoServerOptions	getOptions()	Gets the configured options for this server instance.
java.util.concurrent.ScheduledExecutorService	getScheduledExecutor()	Gets the underlying executor used for ping timeout handling.
void	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle an HTTP request.
void	handleWebSocket(EngineIoWebSocket webSocket)	Handle a WebSocket request.
private void	handshakePolling(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
private void	handshakeWebSocket(EngineIoWebSocket webSocket)
private static Parser	parserFromQuery(java.util.Map<java.lang.String,java.lang.String> query)
private void	sendErrorMessage(jakarta.servlet.http.HttpServletResponse response, ServerErrors code)
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

Field Detail

ERROR_JSON

private static final java.lang.String ERROR_JSON

See Also:

Constant Field Values

mClients

private final java.util.Map<java.lang.String,EngineIoSocket> mClients

mOptions

private final EngineIoServerOptions mOptions

mAllowedCorsOrigins

private final java.util.HashSet<java.lang.String> mAllowedCorsOrigins

mScheduledExecutor

private final java.util.concurrent.ScheduledExecutorService mScheduledExecutor

mHandshakeInterceptor

private final EngineIoServer.HandshakeInterceptor mHandshakeInterceptor

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 java.util.concurrent.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(jakarta.servlet.http.HttpServletRequest request,
                          jakarta.servlet.http.HttpServletResponse response)
                   throws java.io.IOException

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

Parameters:

request - The HTTP request object.

response - The HTTP response object.

Throws:

java.io.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.

sendErrorMessage

private void sendErrorMessage(jakarta.servlet.http.HttpServletResponse response,
                              ServerErrors code)
                       throws java.io.IOException

Throws:

java.io.IOException

handshakePolling

private void handshakePolling(jakarta.servlet.http.HttpServletRequest request,
                              jakarta.servlet.http.HttpServletResponse response)
                       throws java.io.IOException

Throws:

java.io.IOException

handshakeWebSocket

private void handshakeWebSocket(EngineIoWebSocket webSocket)

parserFromQuery

private static Parser parserFromQuery(java.util.Map<java.lang.String,java.lang.String> query)