Package com.corundumstudio.socketio.namespace

Class Namespace

java.lang.Object

com.corundumstudio.socketio.namespace.Namespace

All Implemented Interfaces:

ClientListeners, SocketIONamespace

public class Namespace
extends Object
implements SocketIONamespace

Hub object for all clients in one namespace. Namespace shares by different namespace-clients.

See Also:

• NamespaceClient

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME

Constructor Summary

Constructors

Constructor	Description
Namespace(String name, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
void	addClient(SocketIOClient client)
void	addConnectListener(ConnectListener listener)
void	addDisconnectListener(DisconnectListener listener)
void	addEventInterceptor(EventInterceptor eventInterceptor)
<T> void	addEventListener(String eventName, Class<T> eventClass, DataListener<T> listener)
<L> void	addListeners(Iterable<L> listeners)
void	addListeners(Object listeners)
void	addListeners(Object listeners, Class<?> listenersClass)
void	addMultiTypeEventListener(String eventName, MultiTypeEventListener listener, Class<?>... eventClass)
void	addPingListener(PingListener listener)	from v4, ping will always be sent by server except probe ping packet sent from client, and pong will always be responded by client while receiving ping except probe pong packet responded from server it makes no more sense to listen to ping packet, instead you can listen to pong packet
void	addPongListener(PongListener listener)
void	dispatch(String room, Packet packet)
boolean	equals(Object obj)
Collection<SocketIOClient>	getAllClients()	Get all clients connected to namespace
BroadcastOperations	getBroadcastOperations()
SocketIOClient	getClient(UUID uuid)	Get client by uuid connected to namespace
JsonSupport	getJsonSupport()
String	getName()
Iterable<SocketIOClient>	getRoomClients(String room)
int	getRoomClientsInCluster(String room)
BroadcastOperations	getRoomOperations(String room)
BroadcastOperations	getRoomOperations(String... rooms)
Set<String>	getRooms()
Set<String>	getRooms(SocketIOClient client)
int	hashCode()
void	join(String room, UUID sessionId)
void	joinRoom(String room, UUID sessionId)
void	joinRooms(Set<String> rooms, UUID sessionId)
void	leave(String room, UUID sessionId)
void	leaveRoom(String room, UUID sessionId)
void	leaveRooms(Set<String> rooms, UUID sessionId)
void	onConnect(SocketIOClient client)
void	onDisconnect(SocketIOClient client)
void	onEvent(NamespaceClient client, String eventName, List<Object> args, AckRequest ackRequest)
void	onPing(SocketIOClient client)
void	onPong(SocketIOClient client)
void	removeAllListeners(String eventName)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

Constructor Details

Namespace

public Namespace(String name,
 Configuration configuration)

Method Details

addClient

public void addClient(SocketIOClient client)

getName

public String getName()

Specified by:

getName in interface SocketIONamespace

addMultiTypeEventListener

public void addMultiTypeEventListener(String eventName,
 MultiTypeEventListener listener,
 Class<?>... eventClass)

Specified by:

addMultiTypeEventListener in interface ClientListeners

removeAllListeners

public void removeAllListeners(String eventName)

Specified by:

removeAllListeners in interface ClientListeners

addEventListener

public <T> void addEventListener(String eventName,
 Class<T> eventClass,
 DataListener<T> listener)

Specified by:

addEventListener in interface ClientListeners

addEventInterceptor

public void addEventInterceptor(EventInterceptor eventInterceptor)

Specified by:

addEventInterceptor in interface ClientListeners

onEvent

public void onEvent(NamespaceClient client,
 String eventName,
 List<Object> args,
 AckRequest ackRequest)

addDisconnectListener

public void addDisconnectListener(DisconnectListener listener)

Specified by:

addDisconnectListener in interface ClientListeners

onDisconnect

public void onDisconnect(SocketIOClient client)

addConnectListener

public void addConnectListener(ConnectListener listener)

Specified by:

addConnectListener in interface ClientListeners

onConnect

public void onConnect(SocketIOClient client)

addPingListener

public void addPingListener(PingListener listener)

Description copied from interface: ClientListeners

from v4, ping will always be sent by server except probe ping packet sent from client, and pong will always be responded by client while receiving ping except probe pong packet responded from server it makes no more sense to listen to ping packet, instead you can listen to pong packet

Specified by:

addPingListener in interface ClientListeners

Parameters:

listener -

addPongListener

public void addPongListener(PongListener listener)

Specified by:

addPongListener in interface ClientListeners

onPing

public void onPing(SocketIOClient client)

onPong

public void onPong(SocketIOClient client)

getBroadcastOperations

public BroadcastOperations getBroadcastOperations()

Specified by:

getBroadcastOperations in interface SocketIONamespace

getRoomOperations

public BroadcastOperations getRoomOperations(String room)

Specified by:

getRoomOperations in interface SocketIONamespace

getRoomOperations

public BroadcastOperations getRoomOperations(String... rooms)

Specified by:

getRoomOperations in interface SocketIONamespace

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

addListeners

public void addListeners(Object listeners)

Specified by:

addListeners in interface ClientListeners

addListeners

public <L> void addListeners(Iterable<L> listeners)

Specified by:

addListeners in interface ClientListeners

addListeners

public void addListeners(Object listeners,
 Class<?> listenersClass)

Specified by:

addListeners in interface ClientListeners

joinRoom

public void joinRoom(String room,
 UUID sessionId)

joinRooms

public void joinRooms(Set<String> rooms,
 UUID sessionId)

dispatch

public void dispatch(String room,
 Packet packet)

join

public void join(String room,
 UUID sessionId)

leaveRoom

public void leaveRoom(String room,
 UUID sessionId)

leaveRooms

public void leaveRooms(Set<String> rooms,
 UUID sessionId)

leave

public void leave(String room,
 UUID sessionId)

getRooms

public Set<String> getRooms(SocketIOClient client)

getRooms

public Set<String> getRooms()

getRoomClients

public Iterable<SocketIOClient> getRoomClients(String room)

getRoomClientsInCluster

public int getRoomClientsInCluster(String room)

getAllClients

public Collection<SocketIOClient> getAllClients()

Description copied from interface: SocketIONamespace

Get all clients connected to namespace

Specified by:

getAllClients in interface SocketIONamespace

Returns:

collection of clients

getJsonSupport

public JsonSupport getJsonSupport()

getClient

public SocketIOClient getClient(UUID uuid)

Description copied from interface: SocketIONamespace

Get client by uuid connected to namespace

Specified by:

getClient in interface SocketIONamespace

Parameters:

uuid - - id of client

Returns:

client