Skip navigation links
A C D E G H I J L M N O P R S T U V W Y 

A

ALLOWED_CORS_ORIGIN_ALL - Static variable in class io.socket.engineio.server.EngineIoServerOptions
Specify that all origins are to be allowed for CORS
ALLOWED_CORS_ORIGIN_NONE - Static variable in class io.socket.engineio.server.EngineIoServerOptions
Specify that no origins are allowed for CORS
ALPHABET - Static variable in interface io.socket.engineio.server.utils.ServerYeast
 

C

call(Object...) - Method in interface io.socket.engineio.server.Emitter.Listener
 
call(EngineIoSocket, Object...) - Method in interface io.socket.engineio.server.EngineIoSocket.SocketedListener
 
call(Packet<T>, int, int) - Method in interface io.socket.engineio.server.parser.Parser.DecodePayloadCallback
 
call(T) - Method in interface io.socket.engineio.server.parser.Parser.EncodeCallback
 
close() - Method in class io.socket.engineio.server.EngineIoSocket
Close this socket.
close() - Method in class io.socket.engineio.server.EngineIoWebSocket
Close the WebSocket.
close() - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
CLOSE - Static variable in class io.socket.engineio.server.parser.Packet
 
close() - Method in class io.socket.engineio.server.Transport
Close the transport if not already closed.

D

data - Variable in class io.socket.engineio.server.parser.Packet
 
decode(String) - Static method in interface io.socket.engineio.server.utils.ParseQS
 
decodePacket(Object) - Method in interface io.socket.engineio.server.parser.Parser
 
decodePacket(Object) - Method in class io.socket.engineio.server.parser.ParserV3
Decode a packet received from transport.
decodePacket(Object) - Method in class io.socket.engineio.server.parser.ParserV4
Decode a packet received from transport.
decodePayload(Object, Parser.DecodePayloadCallback<Object>) - Method in interface io.socket.engineio.server.parser.Parser
 
decodePayload(Object, Parser.DecodePayloadCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV3
Decode payload received from transport.
decodePayload(Object, Parser.DecodePayloadCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV4
Decode payload received from transport.
DEFAULT - Static variable in class io.socket.engineio.server.EngineIoServerOptions
The default options used by server.
doClose() - Method in class io.socket.engineio.server.Transport
Transport specific logic for closing transport.
doClose() - Method in class io.socket.engineio.server.transport.Polling
 
doClose() - Method in class io.socket.engineio.server.transport.WebSocket
 

E

emit(String, Object...) - Method in class io.socket.engineio.server.Emitter
Executes each of listeners with the given args.
emit(String, Object...) - Method in class io.socket.engineio.server.EngineIoSocket
 
Emitter - Class in io.socket.engineio.server
The event emitter which is ported from the JavaScript module.
Emitter() - Constructor for class io.socket.engineio.server.Emitter
 
Emitter.Listener - Interface in io.socket.engineio.server
 
encode(Map<String, String>) - Static method in interface io.socket.engineio.server.utils.ParseQS
 
encode(long) - Static method in interface io.socket.engineio.server.utils.ServerYeast
 
encodeByteArray(Packet<byte[]>, boolean, Parser.EncodeCallback<Object>) - Static method in class io.socket.engineio.server.parser.ParserV3
 
encodeByteArray(Packet<byte[]>, boolean, Parser.EncodeCallback<Object>) - Static method in class io.socket.engineio.server.parser.ParserV4
 
encodePacket(Packet<?>, boolean, Parser.EncodeCallback<Object>) - Method in interface io.socket.engineio.server.parser.Parser
 
encodePacket(Packet<?>, boolean, Parser.EncodeCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV3
Encode a packet for transfer over transport.
encodePacket(Packet<?>, boolean, Parser.EncodeCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV4
Encode a packet for transfer over transport.
encodePayload(List<Packet<?>>, boolean, Parser.EncodeCallback<Object>) - Method in interface io.socket.engineio.server.parser.Parser
 
encodePayload(List<Packet<?>>, boolean, Parser.EncodeCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV3
Encode an array of packets into a payload for transfer over transport.
encodePayload(List<Packet<?>>, boolean, Parser.EncodeCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV4
Encode an array of packets into a payload for transfer over transport.
encodePayloadAsBinary(List<Packet<?>>, Parser.EncodeCallback<Object>) - Method in class io.socket.engineio.server.parser.ParserV3
Encode an array of packets into a binary payload for transfer over transport.
EngineIoServer - Class in io.socket.engineio.server
The engine.io server.
EngineIoServer() - Constructor for class io.socket.engineio.server.EngineIoServer
Create instance of server with default options.
EngineIoServer(EngineIoServerOptions) - Constructor for class io.socket.engineio.server.EngineIoServer
Create instance of server with specified options.
EngineIoServer.HandshakeInterceptor - Interface in io.socket.engineio.server
 
EngineIoServerOptions - Class in io.socket.engineio.server
Options for EngineIoServer
EngineIoSocket - Class in io.socket.engineio.server
An engine.io socket.
EngineIoSocket.SocketedListener - Interface in io.socket.engineio.server
 
EngineIoWebSocket - Class in io.socket.engineio.server
Adapter between different WebSocket implementations and Engine.IO.
EngineIoWebSocket() - Constructor for class io.socket.engineio.server.EngineIoWebSocket
 
ERROR - Static variable in class io.socket.engineio.server.parser.Packet
 
ERROR_PACKET - Static variable in interface io.socket.engineio.server.parser.Parser
 

G

getAllowedCorsOrigins() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the allowed CORS origins option.
getConnectionHeaders() - Method in class io.socket.engineio.server.EngineIoWebSocket
Get the headers in the initial HTTP request.
getConnectionHeaders() - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
getHandshakeInterceptor() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the EngineIoServer.HandshakeInterceptor for the server.
getId() - Method in class io.socket.engineio.server.EngineIoSocket
Gets the sid of this socket.
getInitialHeaders() - Method in class io.socket.engineio.server.EngineIoSocket
Get the headers of the initial HTTP connection.
getInitialHeaders() - Method in class io.socket.engineio.server.Transport
Get the headers of the initial HTTP request.
getInitialHeaders() - Method in class io.socket.engineio.server.transport.Polling
 
getInitialHeaders() - Method in class io.socket.engineio.server.transport.WebSocket
 
getInitialPacket() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the initial packet option.
getInitialQuery() - Method in class io.socket.engineio.server.EngineIoSocket
Get the query parameters of the initial HTTP connection.
getInitialQuery() - Method in class io.socket.engineio.server.Transport
Get the query parameters of the initial HTTP request.
getInitialQuery() - Method in class io.socket.engineio.server.transport.Polling
 
getInitialQuery() - Method in class io.socket.engineio.server.transport.WebSocket
 
getMaxTimeoutThreadPoolSize() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the max threadpool size for the ping timeout timers.
getName() - Method in class io.socket.engineio.server.Transport
Get the name of this transport.
getName() - Method in class io.socket.engineio.server.transport.Polling
 
getName() - Method in class io.socket.engineio.server.transport.WebSocket
 
getOptions() - Method in class io.socket.engineio.server.EngineIoServer
Gets the configured options for this server instance.
getPingInterval() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the ping interval option in milliseconds.
getPingTimeout() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the ping timeout option in milliseconds.
getProtocolVersion() - Method in class io.socket.engineio.server.EngineIoSocket
Gets the protocol version of this socket.
getProtocolVersion() - Method in interface io.socket.engineio.server.parser.Parser
 
getProtocolVersion() - Method in class io.socket.engineio.server.parser.ParserV3
 
getProtocolVersion() - Method in class io.socket.engineio.server.parser.ParserV4
 
getQuery() - Method in class io.socket.engineio.server.EngineIoWebSocket
Get the query of the initial HTTP request.
getQuery() - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
getReadyState() - Method in class io.socket.engineio.server.EngineIoSocket
Gets the ready state of this socket.
getScheduledExecutor() - Method in class io.socket.engineio.server.EngineIoServer
Gets the underlying executor used for ping timeout handling.
getScheduledExecutorService() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the custom ScheduledExecutorService for the server to use or null to let the server create it's own executor.

H

handleRequest(HttpServletRequest, HttpServletResponse) - Method in class io.socket.engineio.server.EngineIoServer
Handle an HTTP request.
handleWebSocket(EngineIoWebSocket) - Method in class io.socket.engineio.server.EngineIoServer
Handle a WebSocket request.
hasListeners(String) - Method in class io.socket.engineio.server.Emitter
Check if this emitter has listeners for the specified event.

I

intercept(Map<String, String>, Map<String, List<String>>) - Method in interface io.socket.engineio.server.EngineIoServer.HandshakeInterceptor
Intercept and either allow or block the connection.
io.socket.engineio.server - package io.socket.engineio.server
Main engine.io classes.
io.socket.engineio.server.parser - package io.socket.engineio.server.parser
Parser classes used by engine.io.
io.socket.engineio.server.transport - package io.socket.engineio.server.transport
Transport classes used by engine.io.
io.socket.engineio.server.utils - package io.socket.engineio.server.utils
 
isCorsHandlingDisabled() - Method in class io.socket.engineio.server.EngineIoServerOptions
Gets the value of 'isCorsHandlingDisabled' option.
isSyncPollingAllowed() - Method in class io.socket.engineio.server.EngineIoServerOptions
Whether sync polling transport is allowed or not.
isWritable() - Method in class io.socket.engineio.server.Transport
Checks whether the transport is currently writable.
isWritable() - Method in class io.socket.engineio.server.transport.Polling
 
isWritable() - Method in class io.socket.engineio.server.transport.WebSocket
 

J

JettyWebSocketHandler - Class in io.socket.engineio.server
Adapter for Jetty WebSocket implementation.
JettyWebSocketHandler(EngineIoServer) - Constructor for class io.socket.engineio.server.JettyWebSocketHandler
 

L

listeners(String) - Method in class io.socket.engineio.server.Emitter
Returns a list of listeners for the specified event.
lock() - Method in class io.socket.engineio.server.EngineIoServerOptions
Lock this options instance to prevent modifications.

M

MESSAGE - Static variable in class io.socket.engineio.server.parser.Packet
 
mParser - Variable in class io.socket.engineio.server.Transport
 
mReadyState - Variable in class io.socket.engineio.server.Transport
 

N

NAME - Static variable in class io.socket.engineio.server.transport.Polling
 
NAME - Static variable in class io.socket.engineio.server.transport.WebSocket
 
newFromDefault() - Static method in class io.socket.engineio.server.EngineIoServerOptions
Create a new instance of EngineIoServerOptions by copying default options.
NOOP - Static variable in class io.socket.engineio.server.parser.Packet
 

O

off() - Method in class io.socket.engineio.server.Emitter
Removes all registered listeners.
off(String) - Method in class io.socket.engineio.server.Emitter
Removes all listeners of the specified event.
off(String, Emitter.Listener) - Method in class io.socket.engineio.server.Emitter
Removes the listener.
off(String, EngineIoSocket.SocketedListener) - Method in class io.socket.engineio.server.EngineIoSocket
Removes the listener.
off(String) - Method in class io.socket.engineio.server.EngineIoSocket
 
on(String, Emitter.Listener) - Method in class io.socket.engineio.server.Emitter
Listens on the event.
on(String, EngineIoSocket.SocketedListener) - Method in class io.socket.engineio.server.EngineIoSocket
Listen on the event.
once(String, Emitter.Listener) - Method in class io.socket.engineio.server.Emitter
Adds a one time listener for the event.
onClose() - Method in class io.socket.engineio.server.Transport
Called by child to indicate closure of transport.
onClose() - Method in class io.socket.engineio.server.transport.Polling
 
onComplete(AsyncEvent) - Method in class io.socket.engineio.server.transport.Polling
 
onData(Object) - Method in class io.socket.engineio.server.Transport
Called by child to indicate data received from remote client.
onData(Object) - Method in class io.socket.engineio.server.transport.Polling
 
onError(String, String) - Method in class io.socket.engineio.server.Transport
Called by child class to indicate error with transport.
onError(AsyncEvent) - Method in class io.socket.engineio.server.transport.Polling
 
onPacket(Packet<?>) - Method in class io.socket.engineio.server.Transport
Called by child to indicate a packet receive from remote client.
onRequest(HttpServletRequest, HttpServletResponse) - Method in class io.socket.engineio.server.Transport
Handle a client HTTP request.
onRequest(HttpServletRequest, HttpServletResponse) - Method in class io.socket.engineio.server.transport.Polling
 
onRequest(HttpServletRequest, HttpServletResponse) - Method in class io.socket.engineio.server.transport.WebSocket
 
onStartAsync(AsyncEvent) - Method in class io.socket.engineio.server.transport.Polling
 
onTimeout(AsyncEvent) - Method in class io.socket.engineio.server.transport.Polling
 
onWebSocketBinary(byte[], int, int) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
onWebSocketClose(int, String) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
onWebSocketConnect(Session) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
onWebSocketError(Throwable) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
onWebSocketText(String) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
OPEN - Static variable in class io.socket.engineio.server.parser.Packet
 

P

Packet<T> - Class in io.socket.engineio.server.parser
 
Packet(String) - Constructor for class io.socket.engineio.server.parser.Packet
 
Packet(String, T) - Constructor for class io.socket.engineio.server.parser.Packet
 
PACKETS - Static variable in interface io.socket.engineio.server.parser.Parser
 
PACKETS_REVERSE - Static variable in interface io.socket.engineio.server.parser.Parser
 
ParseQS - Interface in io.socket.engineio.server.utils
 
Parser - Interface in io.socket.engineio.server.parser
 
Parser.DecodePayloadCallback<T> - Interface in io.socket.engineio.server.parser
 
Parser.EncodeCallback<T> - Interface in io.socket.engineio.server.parser
 
ParserV3 - Class in io.socket.engineio.server.parser
 
ParserV3() - Constructor for class io.socket.engineio.server.parser.ParserV3
 
ParserV4 - Class in io.socket.engineio.server.parser
 
ParserV4() - Constructor for class io.socket.engineio.server.parser.ParserV4
 
PING - Static variable in class io.socket.engineio.server.parser.Packet
 
Polling - Class in io.socket.engineio.server.transport
Polling transport.
Polling(Object, Parser) - Constructor for class io.socket.engineio.server.transport.Polling
 
PONG - Static variable in class io.socket.engineio.server.parser.Packet
 
PROTOCOL - Static variable in class io.socket.engineio.server.parser.ParserV3
 
PROTOCOL - Static variable in class io.socket.engineio.server.parser.ParserV4
 
PROTOCOL_V3 - Static variable in interface io.socket.engineio.server.parser.Parser
 
PROTOCOL_V4 - Static variable in interface io.socket.engineio.server.parser.Parser
 

R

ReadyState - Enum in io.socket.engineio.server
The possible states a connection can be in at any given time.

S

send(Packet<?>) - Method in class io.socket.engineio.server.EngineIoSocket
Send a packet to the remote client.
send(List<Packet<?>>) - Method in class io.socket.engineio.server.transport.Polling
 
send(List<Packet<?>>) - Method in class io.socket.engineio.server.Transport
Send a list of packets over the transport.
send(List<Packet<?>>) - Method in class io.socket.engineio.server.transport.WebSocket
 
ServerYeast - Interface in io.socket.engineio.server.utils
 
setAllowedCorsOrigins(String[]) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets the allowed CORS origins option.
setAllowSyncPolling(boolean) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets whether sync polling transport is allowed or not.
setCorsHandlingDisabled(boolean) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets the 'isCorsHandlingDisabled' option.
setHandshakeInterceptor(EngineIoServer.HandshakeInterceptor) - Method in class io.socket.engineio.server.EngineIoServerOptions
setInitialPacket(Packet<?>) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets the initial packet.
setMaxTimeoutThreadPoolSize(int) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets the max threadpool size for the ping timeout timers.
setPingInterval(long) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets the ping interval option.
setPingTimeout(long) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets the ping timeout option.
setScheduledExecutorService(ScheduledExecutorService) - Method in class io.socket.engineio.server.EngineIoServerOptions
Sets a custom ScheduledExecutorService for the server to use.
shutdown() - Method in class io.socket.engineio.server.EngineIoServer
Releases resources such as threads and clients.

T

THREAD_RANDOM - Static variable in interface io.socket.engineio.server.utils.ServerYeast
A ThreadLocal is used to improve thread performance since SecureRandom do not perform well with thread contention.
Transport - Class in io.socket.engineio.server
Base class for all transports.
Transport(Parser) - Constructor for class io.socket.engineio.server.Transport
 
type - Variable in class io.socket.engineio.server.parser.Packet
 

U

UPGRADE - Static variable in class io.socket.engineio.server.parser.Packet
 

V

valueOf(String) - Static method in enum io.socket.engineio.server.ReadyState
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.socket.engineio.server.ReadyState
Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocket - Class in io.socket.engineio.server.transport
WebSocket transport.
WebSocket(EngineIoWebSocket, Parser) - Constructor for class io.socket.engineio.server.transport.WebSocket
 
write(String) - Method in class io.socket.engineio.server.EngineIoWebSocket
Write a string to the WebSocket and send to remote client.
write(byte[]) - Method in class io.socket.engineio.server.EngineIoWebSocket
Write a byte array to the WebSocket and send to remote client.
write(String) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 
write(byte[]) - Method in class io.socket.engineio.server.JettyWebSocketHandler
 

Y

yeast() - Static method in interface io.socket.engineio.server.utils.ServerYeast
 
A C D E G H I J L M N O P R S T U V W Y 
Skip navigation links

Copyright © 2022. All rights reserved.