Package io.socket.engineio.server

Class EngineIoSocket

java.lang.Object

io.socket.engineio.server.Emitter

io.socket.engineio.server.EngineIoSocket

public final class EngineIoSocket
extends Emitter

An engine.io socket. Objects of this class represents connections to remote clients one per object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EngineIoSocket.SocketedListener

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

Emitter.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	EMPTY_UPGRADES
private static final String	HANDSHAKE_JSON
private final ConcurrentHashMap<String,ConcurrentLinkedQueue<EngineIoSocket.SocketedListener>>	mCallbacks
private Runnable	mCleanupFunction
private Map<String,List<String>>	mInitialHeaders
private Map<String,String>	mInitialQuery
private final Object	mLockObject
private ScheduledFuture<?>	mPingFuture
private final Runnable	mPingTask
private ScheduledFuture<?>	mPingTimeoutFuture
private final Runnable	mPingTimeoutTask
private final int	mProtocolVersion
private ReadyState	mReadyState
private final ScheduledExecutorService	mScheduledTaskHandler
private final EngineIoServer	mServer
private final String	mSid
private Transport	mTransport
private final AtomicBoolean	mUpgrading
private final LinkedList<Packet<?>>	mWriteBuffer
private static final List<Packet<?>>	PAYLOAD_NOOP
private static final String	WEBSOCKET_UPGRADES

Constructor Summary

Constructors

Constructor	Description
EngineIoSocket(Object lockObject, String sid, int protocolVersion, EngineIoServer server, ScheduledExecutorService scheduledTaskHandler)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	canUpgrade(String transport)	Checks whether the socket can be upgraded to another transport.
private void	clearTransport()
void	close()	Close this socket.
private void	closeTransport()
Emitter	emit(String event, Object... args)	Executes each of listeners with the given args.
private void	flush()
(package private) String	getCurrentTransportName()	Get the name of the current transport.
String	getId()	Gets the sid of this socket.
Map<String,List<String>>	getInitialHeaders()	Get the headers of the initial HTTP connection.
Map<String,String>	getInitialQuery()	Get the query parameters of the initial HTTP connection.
int	getProtocolVersion()	Gets the protocol version of this socket.
ReadyState	getReadyState()	Gets the ready state of this socket.
(package private) void	init(Transport transport)	Called after instance creation to initialize transport.
EngineIoSocket	off(String event)	Removes all listeners of the specified event.
EngineIoSocket	off(String event, EngineIoSocket.SocketedListener fn)	Removes the listener.
EngineIoSocket	on(String event, EngineIoSocket.SocketedListener fn)	Listen on the event.
private void	onClose(String reason, String description)
private void	onError()
private void	onOpen()
private void	onPacket(Packet<?> packet)
(package private) void	onRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle an HTTP request.
private void	resetPingTimeout(long timeout)
private void	schedulePing()
void	send(Packet<?> packet)	Send a packet to the remote client.
private void	sendPacket(Packet<?> packet)
private void	sendPing()
private void	setTransport(Transport transport)
(package private) void	updateInitialHeadersFromActiveTransport()
(package private) void	upgrade(Transport transport)	Perform upgrade to the specified transport.

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

hasListeners, listeners, off, off, on, once

Methods inherited from class java.lang.Object

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

Field Details

PAYLOAD_NOOP

private static final List<Packet<?>> PAYLOAD_NOOP

EMPTY_UPGRADES

private static final String EMPTY_UPGRADES

WEBSOCKET_UPGRADES

private static final String WEBSOCKET_UPGRADES

HANDSHAKE_JSON

private static final String HANDSHAKE_JSON

See Also:

• Constant Field Values

mSid

private final String mSid

mProtocolVersion

private final int mProtocolVersion

mServer

private final EngineIoServer mServer

mWriteBuffer

private final LinkedList<Packet<?>> mWriteBuffer

mCallbacks

private final ConcurrentHashMap<String,ConcurrentLinkedQueue<EngineIoSocket.SocketedListener>> mCallbacks

mLockObject

private final Object mLockObject

mScheduledTaskHandler

private final ScheduledExecutorService mScheduledTaskHandler

mPingTask

private final Runnable mPingTask

mPingTimeoutTask

private final Runnable mPingTimeoutTask

mPingFuture

private ScheduledFuture<?> mPingFuture

mPingTimeoutFuture

private ScheduledFuture<?> mPingTimeoutFuture

mUpgrading

private final AtomicBoolean mUpgrading

mCleanupFunction

private Runnable mCleanupFunction

mReadyState

private ReadyState mReadyState

mTransport

private Transport mTransport

mInitialQuery

private Map<String,String> mInitialQuery

mInitialHeaders

private Map<String,List<String>> mInitialHeaders

Constructor Details

EngineIoSocket

EngineIoSocket(Object lockObject,
 String sid,
 int protocolVersion,
 EngineIoServer server,
 ScheduledExecutorService scheduledTaskHandler)

Method Details

getId

public String getId()

Gets the sid of this socket.

getProtocolVersion

public int getProtocolVersion()

Gets the protocol version of this socket.

getReadyState

public ReadyState getReadyState()

Gets the ready state of this socket.

getInitialQuery

public Map<String,String> getInitialQuery()

Get the query parameters of the initial HTTP connection.

getInitialHeaders

public Map<String,List<String>> getInitialHeaders()

Get the headers of the initial HTTP connection.

send

public void send(Packet<?> packet)

Send a packet to the remote client. Queuing of packets in case of polling transport are handled internally. This method is thread safe.

Parameters:

packet - The packet to send.

close

public void close()

Close this socket.

on

public EngineIoSocket on(String event,
 EngineIoSocket.SocketedListener fn)

Listen on the event. NOTE: Unstable api. Might change in the future.

Parameters:

event - Event name

fn - Event listener

Returns:

A reference to this object

off

public EngineIoSocket off(String event,
 EngineIoSocket.SocketedListener fn)

Removes the listener. NOTE: Unstable api. Might change in the future.

Parameters:

event - an event name.

fn - Event listener.

Returns:

a reference to this object.

off

public EngineIoSocket off(String event)

Description copied from class: Emitter

Removes all listeners of the specified event.

Overrides:

off in class Emitter

Parameters:

event - an event name.

Returns:

a reference to this object.

emit

public Emitter emit(String event,
 Object... args)

Description copied from class: Emitter

Executes each of listeners with the given args.

Overrides:

emit in class Emitter

Parameters:

event - an event name.

args - Data to emit.

Returns:

a reference to this object.

init

void init(Transport transport)

Called after instance creation to initialize transport.

Parameters:

transport - The opened transport.

updateInitialHeadersFromActiveTransport

void updateInitialHeadersFromActiveTransport()

onRequest

void onRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
        throws IOException

Handle an HTTP request.

Parameters:

request - The HTTP request object.

response - The HTTP response object.

Throws:

IOException - On IO error.

canUpgrade

boolean canUpgrade(String transport)

Checks whether the socket can be upgraded to another transport.

Parameters:

transport - The transport to upgrade to.

Returns:

Boolean value indicating if upgrade is possible.

upgrade

void upgrade(Transport transport)

Perform upgrade to the specified transport.

Parameters:

transport - The transport to upgrade to.

getCurrentTransportName

String getCurrentTransportName()

Get the name of the current transport.

Returns:

Name of current transport.

setTransport

private void setTransport(Transport transport)

closeTransport

private void closeTransport()

clearTransport

private void clearTransport()

onOpen

private void onOpen()

onClose

private void onClose(String reason,
 String description)

onError

private void onError()

onPacket

private void onPacket(Packet<?> packet)

sendPacket

private void sendPacket(Packet<?> packet)

flush

private void flush()

sendPing

private void sendPing()

schedulePing

private void schedulePing()

resetPingTimeout

private void resetPingTimeout(long timeout)