io.socket.socketio.server

Class SocketIoSocket

java.lang.Object

io.socket.engineio.server.Emitter

io.socket.socketio.server.SocketIoSocket

public final class SocketIoSocket
extends io.socket.engineio.server.Emitter

Socket.io socket class. This class represents a unique combination of a single remote connection and it's associated namespace.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SocketIoSocket.AllEventListener Callback for all user events received on socket.
static interface	SocketIoSocket.ReceivedByLocalAcknowledgementCallback Callback for local received acknowledgement.
static interface	SocketIoSocket.ReceivedByRemoteAcknowledgementCallback Callback for remote received acknowledgement.

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

io.socket.engineio.server.Emitter.Listener

Method Summary

Modifier and Type	Method and Description
void	broadcast(String[] rooms, String event, Object[] args) Broadcast a message to all clients in this namespace that have joined specified rooms except this client.
void	broadcast(String room, String event, Object... args) Broadcast a message to all clients in this namespace that have joined specified room except this client.
void	disconnect(boolean close) Disconnect this socket.
boolean	equals(Object obj)
Object	getConnectData() Gets the data packet sent while establishing the socket connection.
String	getId() Gets the id of this socket.
Map<String,List<String>>	getInitialHeaders() Gets the headers of the initial HTTP connection.
Map<String,String>	getInitialQuery() Gets the query parameters of the initial HTTP connection.
SocketIoNamespace	getNamespace() Gets the namespace of this socket.
int	hashCode()
void	joinRoom(String... rooms) Adds the socket to the specified rooms.
void	leaveAllRooms() Removes the socket from all rooms.
void	leaveRoom(String... rooms) Removes the socket from the specified rooms.
void	registerAllEventListener(SocketIoSocket.AllEventListener listener) Register listener for all user events.
void	send(String event, Object... args) Send data to remote client.
void	send(String event, Object[] args, SocketIoSocket.ReceivedByRemoteAcknowledgementCallback acknowledgementCallback) Send data to remote client.
void	unregisterAllEventListener(SocketIoSocket.AllEventListener listener) Unregister listener registered with registerAllEventListener.

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public String getId()

Gets the id of this socket.

getNamespace

public SocketIoNamespace getNamespace()

Gets the namespace of this socket.

getConnectData

public Object getConnectData()

Gets the data packet sent while establishing the socket connection.

getInitialQuery

public Map<String,String> getInitialQuery()

Gets the query parameters of the initial HTTP connection.

getInitialHeaders

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

Gets the headers of the initial HTTP connection.

disconnect

public void disconnect(boolean close)

Disconnect this socket. Optionally, close the underlying connection.

Parameters:

close - Whether to close the remote connection or not.

broadcast

public void broadcast(String room,
                      String event,
                      Object... args)
               throws IllegalArgumentException

Broadcast a message to all clients in this namespace that have joined specified room except this client.

Parameters:

room - Room to send message to.

event - Name of event to raise on remote client.

args - Arguments to send. Supported types are: JSONObject, JSONArray, null.

Throws:

IllegalArgumentException - If event is null or argument is not of supported type.

broadcast

public void broadcast(String[] rooms,
                      String event,
                      Object[] args)
               throws IllegalArgumentException

Broadcast a message to all clients in this namespace that have joined specified rooms except this client.

Parameters:

rooms - Rooms to send message to.

event - Name of event to raise on remote client.

args - Array of arguments to send. Supported types are: JSONObject, JSONArray, null.

Throws:

IllegalArgumentException - If argument is not of supported type.

send

public void send(String event,
                 Object... args)
          throws IllegalArgumentException

Send data to remote client.

Parameters:

event - Name of event to raise on remote client.

args - Array of arguments to send. Supported types are: JSONObject, JSONArray, null.

Throws:

IllegalArgumentException - If event is null or argument is not of supported type.

send

public void send(String event,
                 Object[] args,
                 SocketIoSocket.ReceivedByRemoteAcknowledgementCallback acknowledgementCallback)
          throws IllegalArgumentException

Send data to remote client.

Parameters:

event - Name of event to raise on remote client.

args - Array of arguments to send. Supported types are: JSONObject, JSONArray, null.

acknowledgementCallback - Acknowledgement callback to call on remote ack or null.

Throws:

IllegalArgumentException - If event is null or argument is not of supported type.

joinRoom

public void joinRoom(String... rooms)

Adds the socket to the specified rooms.

Parameters:

rooms - List of rooms to join.

leaveRoom

public void leaveRoom(String... rooms)

Removes the socket from the specified rooms.

Parameters:

rooms - List of rooms to leave.

leaveAllRooms

public void leaveAllRooms()

Removes the socket from all rooms.

registerAllEventListener

public void registerAllEventListener(SocketIoSocket.AllEventListener listener)

Register listener for all user events.

Parameters:

listener - Listener to register.

unregisterAllEventListener

public void unregisterAllEventListener(SocketIoSocket.AllEventListener listener)

Unregister listener registered with registerAllEventListener.

Parameters:

listener - Listener to unregister.