ServerLauncher (MobileIMSDK 6.5(Server端) API文档)

java.lang.Object
- net.x52im.mobileimsdk.server.ServerLauncher

```
public abstract class ServerLauncher
extends java.lang.Object
```
MobileIMSDK的服务端入口主类。
为了简化API的调用，理论上使用者使用本类公开的方法即可实现MobileIMSDK 的所有能力。
本类主要实现服务端的初始化、基本服务的启停以及一些提供给开发者的公开API。
服务端默认不会自动开启，请调用 startup()以便启动MobileIMSDK的服务端, shutdown()关闭服务端，直到再次调用 startup() 。
提示1： 请重写 initListeners()方法，以实现应用层的回调监听器以便实现自定义业务逻辑。
提示2： 如要开启与MobileIMSDK-Web版的消息互通，请设置 bridgeEnabled == true ，默认为false.

从以下版本开始:

3.1

版本:

5.0

作者:

Jack Jiang( http://www.52im.net/thread-2792-1-1.html )

另请参阅:

ServerCoreHandler

字段概要

字段
限定符和类型	字段和说明
`static boolean`	`bridgeEnabled` 是否允许与MobileIMSDK Web版进行互通。
`protected ServerCoreHandler`	`serverCoreHandler` MobileIMSDK框架的核心通信逻辑实现类（实现的是MobileIMSDK服务端的通信处理核心算法）。
`static boolean`	`serverTimestamp` 是否为消息/指令打上服务端时间戳。
`static int`	`supportedGateways` 当前支持的接入网关类型（即支持的网络传输协议类型）。

构造器概要

构造器
构造器和说明

ServerLauncher()

构造器
构造器和说明
`ServerLauncher()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected void`	`bind()` 绑定端口，启动网络接入服务。
`protected GatewayTCP`	`createGatewayTCP()` 创建TCP协议的网关对象。
`protected GatewayUDP`	`createGatewayUDP()` 创建UDP协议的网关对象。
`protected GatewayWebsocket`	`createGatewayWebsocket()` 创建WebSocket协议的网关对象。
`ServerCoreHandler`	`getServerCoreHandler()` 获取 ServerCoreHandler 对象引用。
`ServerEventListener`	`getServerEventListener()` 返回服务端通用事件回调监听器对象引用。
`MessageQoSEventListenerS2C`	`getServerMessageQoSEventListener()` 返回QoS机制的Server主动消息发送之质量保证事件监听器对象。
`protected void`	`initGateways()` 初始化网关（一个网关实例对应一种网络通信类型）。
`protected abstract void`	`initListeners()` 初始化回调处理事件监听器。
`protected ServerCoreHandler`	`initServerCoreHandler()` 初始化MobileIMSDK的ServerCoreHandler实现类。
`boolean`	`isRunning()` 服务端是否启动并运行中。
`void`	`setServerEventListener(ServerEventListener serverEventListener)` 设置服务端通用事件回调监听器。
`void`	`setServerMessageQoSEventListener(MessageQoSEventListenerS2C serverMessageQoSEventListener)` 设置QoS机制的Server主动消息发送之质量保证事件监听器。
`void`	`shutdown()` 关闭服务端。
`void`	`startup()` 开启服务端。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - serverTimestamp
```
public static boolean serverTimestamp
```
    是否为消息/指令打上服务端时间戳。true表示需要，否则不需要，默认false。
    此时间戳可以辅助用于应用层处理消息的顺序问题。
    
    另请参阅:
    
    Protocal.getSm(), Protocal.genServerTimestamp()
  - bridgeEnabled
```
public static boolean bridgeEnabled
```
    是否允许与MobileIMSDK Web版进行互通。true表示需要互通，否则不互通，默认false。
    注意：请在 startup()方法被调用前被设置，否则将不起效.
    
    从以下版本开始:
    
    3.0
  - supportedGateways
```
public static int supportedGateways
```
    当前支持的接入网关类型（即支持的网络传输协议类型）。
    注意：请在 startup()方法被调用前被设置，否则将不起效.
    使用举例：
```
 1）仅支持UDP时，设置本参数为：Gateway.SOCKET_TYPE_UDP;
 2）仅支持TCP时，设置本参数：Gateway.SOCKET_TYPE_TCP;
 3）仅支持WebSocket时，设置本参数：Gateway.SOCKET_TYPE_WEBSOCKET;
 3）需支持UDP+TCP+WebSocket时，设置本参数：Gateway.SOCKET_TYPE_UDP | Gateway.SOCKET_TYPE_TCP | Gateway.SOCKET_TYPE_WEBSOCKET;
 
```
    另请参阅:
    
    Gateway.SOCKET_TYPE_UDP, Gateway.SOCKET_TYPE_TCP, Gateway.SOCKET_TYPE_WEBSOCKET
  - serverCoreHandler
```
protected ServerCoreHandler serverCoreHandler
```
    MobileIMSDK框架的核心通信逻辑实现类（实现的是MobileIMSDK服务端的通信处理核心算法）。
- 构造器详细资料
  - ServerLauncher
```
public ServerLauncher()
               throws java.io.IOException
```
    抛出:
    
    java.io.IOException
- 方法详细资料
  - initServerCoreHandler
```
protected ServerCoreHandler initServerCoreHandler()
```
    初始化MobileIMSDK的ServerCoreHandler实现类。
    本类是MobileIMSDK的服务端网络调度算法核心所在，其性能将决定整个即时通讯架构的数据交换性能、负载能力、吞吐效率等。
    
    返回:
    
    初始化完成后的ServerCoreHandler实现对象
    
    从以下版本开始:
    
    2.1.3
  - initListeners
```
protected abstract void initListeners()
```
    初始化回调处理事件监听器。
    请重写 initListeners()方法，以实现应用层的回调监听器以便实现自定义业务逻辑，可以设置的回调监听器有： setServerEventListener(ServerEventListener) 和 setServerMessageQoSEventListener(MessageQoSEventListenerS2C)。
  - initGateways
```
protected void initGateways()
```
    初始化网关（一个网关实例对应一种网络通信类型）。
  - createGatewayUDP
```
protected GatewayUDP createGatewayUDP()
```
    创建UDP协议的网关对象。
    
    返回:
    
    新对象
  - createGatewayTCP
```
protected GatewayTCP createGatewayTCP()
```
    创建TCP协议的网关对象。
    
    返回:
    
    新对象
  - createGatewayWebsocket
```
protected GatewayWebsocket createGatewayWebsocket()
```
    创建WebSocket协议的网关对象。
    
    返回:
    
    新对象
  - startup
```
public void startup()
             throws java.lang.Exception
```
    开启服务端。
    
    抛出:
    
    java.io.IOException - 端口绑定失败将抛出本异常
    
    java.lang.Exception
    
    另请参阅:
    
    initServerCoreHandler(), initListeners(), initGateways(), QoS4ReciveDaemonRoot.startup(), QoS4SendDaemonRoot.startup(boolean), ServerCoreHandler.lazyStartupBridgeProcessor(), bridgeEnabled, AbstractBootstrap.bind(String, int)
  - bind
```
protected void bind()
             throws java.lang.Exception
```
    绑定端口，启动网络接入服务。
    
    抛出:
    
    java.lang.Exception
  - shutdown
```
public void shutdown()
```
    关闭服务端。
    
    另请参阅:
    
    ChannelOutboundInvoker.close(), QoS4ReciveDaemonRoot.stop(), QoS4SendDaemonRoot.stop(), net.x52im.mobileimsdk.server.bridge.QoS4ReciveDaemonC2B#stop(), net.x52im.mobileimsdk.server.bridge.QoS4SendDaemonB2C#stop()
  - getServerEventListener
```
public ServerEventListener getServerEventListener()
```
    返回服务端通用事件回调监听器对象引用。
    
    返回:
    
    ServerEventListener对象
    
    另请参阅:
    
    ServerCoreHandler.getServerEventListener()
  - setServerEventListener
```
public void setServerEventListener(ServerEventListener serverEventListener)
```
    设置服务端通用事件回调监听器。
    
    参数:
    
    serverEventListener - ServerEventListener对象
    
    另请参阅:
    
    ServerCoreHandler.setServerEventListener(ServerEventListener)
  - getServerMessageQoSEventListener
```
public MessageQoSEventListenerS2C getServerMessageQoSEventListener()
```
    返回QoS机制的Server主动消息发送之质量保证事件监听器对象。
    
    返回:
    
    MessageQoSEventListenerS2C对象
    
    另请参阅:
    
    ServerCoreHandler.getServerMessageQoSEventListener()
  - setServerMessageQoSEventListener
```
public void setServerMessageQoSEventListener(MessageQoSEventListenerS2C serverMessageQoSEventListener)
```
    设置QoS机制的Server主动消息发送之质量保证事件监听器。
    
    参数:
    
    serverMessageQoSEventListener - MessageQoSEventListenerS2C对象
    
    另请参阅:
    
    ServerCoreHandler.setServerMessageQoSEventListener(MessageQoSEventListenerS2C)
  - getServerCoreHandler
```
public ServerCoreHandler getServerCoreHandler()
```
    获取 ServerCoreHandler 对象引用。
    
    返回:
    
    返回对象引用
    
    从以下版本开始:
    
    3.0
  - isRunning
```
public boolean isRunning()
```
    服务端是否启动并运行中。
    
    返回:
    
    true表示已正常启动并运行，否则没有启动

类 ServerLauncher

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

serverTimestamp

bridgeEnabled

supportedGateways

serverCoreHandler

构造器详细资料

ServerLauncher

方法详细资料

initServerCoreHandler

initListeners

initGateways

createGatewayUDP

createGatewayTCP

createGatewayWebsocket

startup

bind

shutdown

getServerEventListener

setServerEventListener

getServerMessageQoSEventListener

setServerMessageQoSEventListener

getServerCoreHandler

isRunning