Package com.corundumstudio.socketio
Class SocketIOServer
java.lang.Object
com.corundumstudio.socketio.SocketIOServer
- All Implemented Interfaces:
ClientListeners
Fully thread-safe.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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) addNamespace
(String name) 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 packetvoid
addPongListener
(PongListener listener) protected void
applyConnectionOptions
(io.netty.bootstrap.ServerBootstrap bootstrap) Get all clients connected to default namespaceGet all namespacesGet client by uuid from default namespaceAllows to get configuration provided during server creation.getNamespace
(String name) getRoomOperations
(String room) Get broadcast operations for clients within room byroom
nameprotected void
void
removeAllListeners
(String eventName) void
removeNamespace
(String name) void
setPipelineFactory
(SocketIOChannelInitializer pipelineFactory) void
start()
Start serverio.netty.util.concurrent.Future<Void>
Start server asynchronouslyvoid
stop()
Stop server
-
Constructor Details
-
SocketIOServer
-
-
Method Details
-
setPipelineFactory
-
getAllClients
Get all clients connected to default namespace- Returns:
- clients collection
-
getClient
Get client by uuid from default namespace- Parameters:
uuid
- - id of client- Returns:
- client
-
getAllNamespaces
Get all namespaces- Returns:
- namespaces collection
-
getBroadcastOperations
-
getRoomOperations
Get broadcast operations for clients within room byroom
name- Parameters:
room
- - name of room- Returns:
- broadcast operations
-
start
public void start()Start server -
startAsync
Start server asynchronously- Returns:
- void
-
applyConnectionOptions
protected void applyConnectionOptions(io.netty.bootstrap.ServerBootstrap bootstrap) -
initGroups
protected void initGroups() -
stop
public void stop()Stop server -
addNamespace
-
getNamespace
-
removeNamespace
-
getConfiguration
Allows to get configuration provided during server creation. Further changes on this object not affect server.- Returns:
- Configuration object
-
addMultiTypeEventListener
public void addMultiTypeEventListener(String eventName, MultiTypeEventListener listener, Class<?>... eventClass) - Specified by:
addMultiTypeEventListener
in interfaceClientListeners
-
addEventListener
- Specified by:
addEventListener
in interfaceClientListeners
-
addEventInterceptor
- Specified by:
addEventInterceptor
in interfaceClientListeners
-
removeAllListeners
- Specified by:
removeAllListeners
in interfaceClientListeners
-
addDisconnectListener
- Specified by:
addDisconnectListener
in interfaceClientListeners
-
addConnectListener
- Specified by:
addConnectListener
in interfaceClientListeners
-
addPingListener
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 interfaceClientListeners
-
addPongListener
- Specified by:
addPongListener
in interfaceClientListeners
-
addListeners
- Specified by:
addListeners
in interfaceClientListeners
-
addListeners
- Specified by:
addListeners
in interfaceClientListeners
-
addListeners
- Specified by:
addListeners
in interfaceClientListeners
-