io.socket.socketio.server

Class SocketIoAdapter

java.lang.Object

io.socket.emitter.Emitter

io.socket.socketio.server.SocketIoAdapter

Direct Known Subclasses:

SocketIoMemoryAdapter

public abstract class SocketIoAdapter
extends io.socket.emitter.Emitter

Socket.io adapter class for broadcasts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SocketIoAdapter.AdapterFactory Factory to create new instance of adapter.

Nested classes/interfaces inherited from class io.socket.emitter.Emitter

io.socket.emitter.Emitter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected SocketIoNamespace	mNamespace The namespace that this adapter serves.
protected Map<String,Set<SocketIoSocket>>	mRoomSockets Set of sockets contained within a room.
protected Map<String,HashSet<String>>	mSocketRooms Set of rooms joined by a socket.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SocketIoAdapter(SocketIoNamespace namespace)

Method Summary

Modifier and Type	Method and Description
abstract void	add(String room, SocketIoSocket socket) Add a socket to the specified room.
void	broadcast(io.socket.parser.Packet<?> packet, String[] rooms) Broadcast a packet to all sockets or sockets that have joined specified rooms.
abstract void	broadcast(io.socket.parser.Packet<?> packet, String[] rooms, String[] socketsExcluded) Broadcast a packet to all sockets or sockets that have joined specified rooms.
abstract String[]	listClientRooms(SocketIoSocket socket) Get list of rooms joined by socket.
abstract SocketIoSocket[]	listClients(String room) Get list of sockets in specified room.
abstract void	remove(String room, SocketIoSocket socket) Remove a socket from the specified room.

Methods inherited from class io.socket.emitter.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

mNamespace

protected final SocketIoNamespace mNamespace

The namespace that this adapter serves.

mRoomSockets

protected final Map<String,Set<SocketIoSocket>> mRoomSockets

Set of sockets contained within a room.

mSocketRooms

protected final Map<String,HashSet<String>> mSocketRooms

Set of rooms joined by a socket.

Constructor Detail

SocketIoAdapter

protected SocketIoAdapter(SocketIoNamespace namespace)

Method Detail

broadcast

public void broadcast(io.socket.parser.Packet<?> packet,
                      String[] rooms)
               throws IllegalArgumentException

Broadcast a packet to all sockets or sockets that have joined specified rooms.

Parameters:

packet - Packet to broadcast.

rooms - List of rooms to restrict packet to or null to send to all rooms.

Throws:

IllegalArgumentException - If packet is null.

broadcast

public abstract void broadcast(io.socket.parser.Packet<?> packet,
                               String[] rooms,
                               String[] socketsExcluded)
                        throws IllegalArgumentException

Broadcast a packet to all sockets or sockets that have joined specified rooms. Optionally, specify sockets to exclude from sending.

Parameters:

packet - Packet to broadcast.

rooms - List of rooms to restrict packet to or null to send to all rooms.

socketsExcluded - List of sockets to exclude from sending or null.

Throws:

IllegalArgumentException - If packet is null.

add

public abstract void add(String room,
                         SocketIoSocket socket)
                  throws IllegalArgumentException

Add a socket to the specified room.

Parameters:

room - Room name to add socket to.

socket - Socket to add to room.

Throws:

IllegalArgumentException - If room or socket is null.

remove

public abstract void remove(String room,
                            SocketIoSocket socket)
                     throws IllegalArgumentException

Remove a socket from the specified room.

Parameters:

room - Room name to remove socket from.

socket - Socket to remove from room.

Throws:

IllegalArgumentException - If room or socket is null.

listClients

public abstract SocketIoSocket[] listClients(String room)
                                      throws IllegalArgumentException

Get list of sockets in specified room.

Parameters:

room - Room name to list sockets in.

Returns:

List of sockets or empty list.

Throws:

IllegalArgumentException - If room is null.

listClientRooms

public abstract String[] listClientRooms(SocketIoSocket socket)
                                  throws IllegalArgumentException

Get list of rooms joined by socket.

Parameters:

socket - Socket to list rooms joined.

Returns:

List of rooms or empty list.

Throws:

IllegalArgumentException - If socket is null.