io.socket.socketio.server

Class SocketIoNamespace

java.lang.Object

io.socket.engineio.server.Emitter

io.socket.socketio.server.SocketIoNamespace

public abstract class SocketIoNamespace
extends io.socket.engineio.server.Emitter

Socket.io namespace class. This class represents a namespace created on the server.

Nested Class Summary

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

io.socket.engineio.server.Emitter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected SocketIoAdapter	mAdapter
protected String	mName
protected SocketIoServer	mServer

Method Summary

Modifier and Type	Method and Description
abstract void	broadcast(String[] rooms, String event, Object[] args) Broadcast a message to all clients in this namespace that have joined specified rooms.
void	broadcast(String room, String event, Object... args) Broadcast a message to all clients in this namespace that have joined specified room.
SocketIoAdapter	getAdapter() Get the adapter for this namespace.
String	getName() Get the name of this namespace.
SocketIoServer	getServer() Get the server associated with this namespace.

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

Field Detail

mServer

protected final SocketIoServer mServer

mName

protected final String mName

mAdapter

protected final SocketIoAdapter mAdapter

Method Detail

getName

public String getName()

Get the name of this namespace.

Returns:

Namespace name with '/' prefix.

getServer

public SocketIoServer getServer()

Get the server associated with this namespace.

Returns:

Server instance of this namespace.

getAdapter

public SocketIoAdapter getAdapter()

Get the adapter for this namespace.

Returns:

Adapter instance for this namespace.

broadcast

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

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

Parameters:

room - Room to send message to or null.

event - Name of event to raise on remote client.

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

Throws:

IllegalArgumentException

broadcast

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

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

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 event is null or argument is not of supported type.