Package com.adobe.granite.socketio
Interface SocketIONamespace
-
- All Superinterfaces:
SocketIOEmitter
@ProviderType public interface SocketIONamespace extends SocketIOEmitter
Socket.IO namespace. Each namespace can have a number of connected sockets.
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_NAMEName of the default namespace.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,SocketIOSocket>getConnected()Returns a map of all connected sockets.StringgetName()Returns the name of this namespace.SocketIOSocketgetSocket(String id)Returns the socket with the given id ornullif it does not exist.-
Methods inherited from interface com.adobe.granite.socketio.SocketIOEmitter
emit, emit, to
-
-
-
-
Field Detail
-
DEFAULT_NAME
static final String DEFAULT_NAME
Name of the default namespace.- See Also:
- Constant Field Values
-
-
Method Detail
-
getConnected
@Nonnull Map<String,SocketIOSocket> getConnected()
Returns a map of all connected sockets. The key of the map corresponds to the socket ids.- Returns:
- the map of connected sockets.
-
getSocket
@CheckForNull SocketIOSocket getSocket(@Nonnull String id)
Returns the socket with the given id ornullif it does not exist.- Parameters:
id- the socket id.- Returns:
- a socket or
null.
-
-