io.socket.socketio.server

Class SocketIoMemoryAdapter

java.lang.Object

io.socket.engineio.server.Emitter

io.socket.socketio.server.SocketIoAdapter

io.socket.socketio.server.SocketIoMemoryAdapter

public final class SocketIoMemoryAdapter
extends SocketIoAdapter

In-memory adapter class. This is the default adapter used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocketIoMemoryAdapter.Factory Factory for SocketIoMemoryAdapter class.

Nested classes/interfaces inherited from class io.socket.socketio.server.SocketIoAdapter

SocketIoAdapter.AdapterFactory

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

io.socket.engineio.server.Emitter.Listener

Field Summary

Fields inherited from class io.socket.socketio.server.SocketIoAdapter

mNamespace, mRoomSockets, mSocketRooms

Method Summary

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

Methods inherited from class io.socket.socketio.server.SocketIoAdapter

broadcast

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

Method Detail

broadcast

public void broadcast(Packet packet,
                      String[] rooms,
                      String[] socketsExcluded)
               throws IllegalArgumentException

Description copied from class: SocketIoAdapter

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

Specified by:

broadcast in class SocketIoAdapter

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 void add(String room,
                SocketIoSocket socket)
         throws IllegalArgumentException

Description copied from class: SocketIoAdapter

Add a socket to the specified room.

Specified by:

add in class SocketIoAdapter

Parameters:

room - Room name to add socket to.

socket - Socket to add to room.

Throws:

IllegalArgumentException - If room or socket is null.

remove

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

Description copied from class: SocketIoAdapter

Remove a socket from the specified room.

Specified by:

remove in class SocketIoAdapter

Parameters:

room - Room name to remove socket from.

socket - Socket to remove from room.

Throws:

IllegalArgumentException - If room or socket is null.

listClients

public SocketIoSocket[] listClients(String room)
                             throws IllegalArgumentException

Description copied from class: SocketIoAdapter

Get list of sockets in specified room.

Specified by:

listClients in class SocketIoAdapter

Parameters:

room - Room name to list sockets in.

Returns:

List of sockets or empty list.

Throws:

IllegalArgumentException - If room is null.

listClientRooms

public String[] listClientRooms(SocketIoSocket socket)
                         throws IllegalArgumentException

Description copied from class: SocketIoAdapter

Get list of rooms joined by socket.

Specified by:

listClientRooms in class SocketIoAdapter

Parameters:

socket - Socket to list rooms joined.

Returns:

List of rooms or empty list.

Throws:

IllegalArgumentException - If socket is null.