SocketIOServer (io.scalecube:socketio 2.3.0 API)

java.lang.Object
- io.scalecube.socketio.SocketIOServer

```
public class SocketIOServer
extends Object
```
A Socket.IO server launcher class.

Author:

Anton Kharenko

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServerConfiguration`	`getConfiguration()` Returns server configuration settings.
`SocketIOListener`	`getListener()` Socket.IO events listener.
`PipelineModifier`	`getPipelineModifier()` Returns pipeline modifier
`ServerBootstrapFactory`	`getServerBootstrapFactory()` Returns ServerBootstrap factory.
`boolean`	`isStarted()` Returns if server is in started state or not.
`boolean`	`isStopped()` Returns if server is in stopped state or not.
`static SocketIOServer`	`newInstance()` Creates instance of Socket.IO server with default settings.
`static SocketIOServer`	`newInstance(int port)` Creates instance of Socket.IO server with the given port.
`static SocketIOServer`	`newInstance(int port, SSLContext sslContext)` Creates instance of Socket.IO server with the given secure port.
`static SocketIOServer`	`newInstance(ServerConfiguration config)` Creates instance of Socket.IO server with the given configuration.
`void`	`restart()` Restarts Socket.IO server.
`void`	`setConfiguration(ServerConfiguration configuration)` Sets server configuration settings.
`void`	`setListener(SocketIOListener listener)` Sets Socket.IO events listener.
`void`	`setPipelineModifier(PipelineModifier pipelineModifier)` Sets pipeline modifier.
`void`	`setServerBootstrapFactory(ServerBootstrapFactory serverBootstrapFactory)` Sets ServerBootstrap factory.
`void`	`start()` Starts Socket.IO server with current configuration settings.
`void`	`stop()` Stops Socket.IO server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newInstance
```
public static SocketIOServer newInstance()
```
    Creates instance of Socket.IO server with default settings.
  - newInstance
```
public static SocketIOServer newInstance(int port)
```
    Creates instance of Socket.IO server with the given port.
  - newInstance
```
public static SocketIOServer newInstance(int port,
                                         SSLContext sslContext)
```
    Creates instance of Socket.IO server with the given secure port.
  - newInstance
```
public static SocketIOServer newInstance(ServerConfiguration config)
```
    Creates instance of Socket.IO server with the given configuration.
  - start
```
public void start()
```
    Starts Socket.IO server with current configuration settings.
    
    Throws:
    
    IllegalStateException - if server already started
  - stop
```
public void stop()
```
    Stops Socket.IO server.
    
    Throws:
    
    IllegalStateException - if server already stopped
  - restart
```
public void restart()
```
    Restarts Socket.IO server. If server already started it stops server; otherwise it just starts server.
  - isStarted
```
public boolean isStarted()
```
    Returns if server is in started state or not.
  - isStopped
```
public boolean isStopped()
```
    Returns if server is in stopped state or not.
  - getListener
```
public SocketIOListener getListener()
```
    Socket.IO events listener.
  - setListener
```
public void setListener(SocketIOListener listener)
```
    Sets Socket.IO events listener. If server already started new listener will be applied only after server restart.
  - getPipelineModifier
```
public PipelineModifier getPipelineModifier()
```
    Returns pipeline modifier
  - setPipelineModifier
```
public void setPipelineModifier(PipelineModifier pipelineModifier)
```
    Sets pipeline modifier. Pipeline modifier could be used for adding handlers to channel pipeline.
  - getConfiguration
```
public ServerConfiguration getConfiguration()
```
    Returns server configuration settings.
  - setConfiguration
```
public void setConfiguration(ServerConfiguration configuration)
```
    Sets server configuration settings. If server already started new settings will be applied only after server restart.
  - getServerBootstrapFactory
```
public ServerBootstrapFactory getServerBootstrapFactory()
```
    Returns ServerBootstrap factory.
  - setServerBootstrapFactory
```
public void setServerBootstrapFactory(ServerBootstrapFactory serverBootstrapFactory)
```
    Sets ServerBootstrap factory. If server already started new boostrap factory will be applied only after server restart.

Class SocketIOServer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newInstance

newInstance

newInstance

newInstance

start

stop

restart

isStarted

isStopped

getListener

setListener

getPipelineModifier

setPipelineModifier

getConfiguration

setConfiguration

getServerBootstrapFactory

setServerBootstrapFactory