Package com.corundumstudio.socketio

Class SocketIOServer

java.lang.Object

com.corundumstudio.socketio.SocketIOServer

All Implemented Interfaces:

ClientListeners

public class SocketIOServer
extends Object
implements ClientListeners

Fully thread-safe.

Constructor Summary

Constructors

Constructor	Description
SocketIOServer(Configuration configuration)

Method Summary

Modifier and Type	Method	Description
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)
SocketIONamespace	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 packet
void	addPongListener(PongListener listener)
protected void	applyConnectionOptions(io.netty.bootstrap.ServerBootstrap bootstrap)
Collection<SocketIOClient>	getAllClients()	Get all clients connected to default namespace
Collection<SocketIONamespace>	getAllNamespaces()	Get all namespaces
BroadcastOperations	getBroadcastOperations()
SocketIOClient	getClient(UUID uuid)	Get client by uuid from default namespace
Configuration	getConfiguration()	Allows to get configuration provided during server creation.
SocketIONamespace	getNamespace(String name)
BroadcastOperations	getRoomOperations(String... rooms)	Get broadcast operations for clients within rooms by rooms' names
protected void	initGroups()
void	removeAllListeners(String eventName)
void	removeNamespace(String name)
void	setPipelineFactory(SocketIOChannelInitializer pipelineFactory)
void	start()	Start server
io.netty.util.concurrent.Future<Void>	startAsync()	Start server asynchronously
void	stop()	Stop server

Methods inherited from class java.lang.Object

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

Constructor Details

SocketIOServer

public SocketIOServer(Configuration configuration)

Method Details

setPipelineFactory

public void setPipelineFactory(SocketIOChannelInitializer pipelineFactory)

getAllClients

public Collection<SocketIOClient> getAllClients()

Get all clients connected to default namespace

Returns:

clients collection

getClient

public SocketIOClient getClient(UUID uuid)

Get client by uuid from default namespace

Parameters:

uuid - - id of client

Returns:

client

getAllNamespaces

public Collection<SocketIONamespace> getAllNamespaces()

Get all namespaces

Returns:

namespaces collection

getBroadcastOperations

public BroadcastOperations getBroadcastOperations()

getRoomOperations

public BroadcastOperations getRoomOperations(String... rooms)

Get broadcast operations for clients within rooms by rooms' names

Parameters:

rooms - rooms' names

Returns:

broadcast operations

start

public void start()

Start server

startAsync

public io.netty.util.concurrent.Future<Void> 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

public SocketIONamespace addNamespace(String name)

getNamespace

public SocketIONamespace getNamespace(String name)

removeNamespace

public void removeNamespace(String name)

getConfiguration

public Configuration 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 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

removeAllListeners

public void removeAllListeners(String eventName)

Specified by:

removeAllListeners in interface ClientListeners

addDisconnectListener

public void addDisconnectListener(DisconnectListener listener)

Specified by:

addDisconnectListener in interface ClientListeners

addConnectListener

public void addConnectListener(ConnectListener listener)

Specified by:

addConnectListener in interface ClientListeners

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

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