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 and Description
static interface	EngineIoSocket.SocketedListener

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

Emitter.Listener

Method Summary

Modifier and Type	Method and Description
void	close() Close this socket.
Emitter	emit(String event, Object... args) Executes each of listeners with the given args.
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.
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.
void	send(Packet<?> packet) Send a packet to the remote client.

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

Method Detail

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.