net.x52im.mobileimsdk.server.utils

类 ServerToolKits

java.lang.Object

net.x52im.mobileimsdk.server.utils.ServerToolKits

public class ServerToolKits
extends java.lang.Object

服务端实用方法工具箱。

从以下版本开始:

3.1

版本:

1.0

作者:

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

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ServerToolKits.SenseModeTCP MobileIMSDK核心框架的TCP协议心跳频率模式.
static class	ServerToolKits.SenseModeUDP MobileIMSDK核心框架的UDP协议心跳频率模式.
static class	ServerToolKits.SenseModeWebsocket MobileIMSDK核心框架的WebSocket协议心跳频率模式.

构造器概要

构造器

构造器和说明
ServerToolKits()

方法概要

限定符和类型	方法和说明
static java.lang.String	clientInfoToString(io.netty.channel.Channel session) 获取对应Session的信息（如session中存放的user_id、登陆名、ip地址和端口等）。
static java.lang.String	fromIOBuffer_JSON(io.netty.buffer.ByteBuf buffer) 从Netty的数据缓冲对象中解析出MobileIMSDK的完整协议内容（Protocal对象的JSON表示形式）。
static Protocal	fromIOBuffer(io.netty.buffer.ByteBuf buffer) 从Netty的原始数据对象中解析出MobileIMSDK的完整协议内容（Protocal对象）。
static void	setSenseModeTCP(ServerToolKits.SenseModeTCP mode) 设置MobileIMSDK核心框架的TCP协议心跳频率模式（默认为 ServerToolKits.SenseModeTCP.MODE_15S ）。
static void	setSenseModeUDP(ServerToolKits.SenseModeUDP mode) 设置MobileIMSDK核心框架的UDP协议心跳频率模式（默认为 ServerToolKits.SenseModeUDP.MODE_3S ）。
static void	setSenseModeWebsocket(ServerToolKits.SenseModeWebsocket mode) 设置MobileIMSDK核心框架的WebSocket协议心跳频率模式（默认为 ServerToolKits.SenseModeWebsocket.MODE_15S ）。
static Protocal	toProtocal(java.lang.String protocalJSONStr) 获得MobileIMSDK完整协议内容Protocal对象形式。

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

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

构造器详细资料

ServerToolKits

public ServerToolKits()

方法详细资料

setSenseModeTCP

public static void setSenseModeTCP(ServerToolKits.SenseModeTCP mode)

设置MobileIMSDK核心框架的TCP协议心跳频率模式（默认为 ServerToolKits.SenseModeTCP.MODE_15S ）。

请在 ServerLauncher.startup()方法被调用前被设置，否则将不起效.

重要说明：服务端本模式的设定必须要与客户端的模式设制保持一致，否则 可能因参数的不一致而导至IM算法的不匹配，进而出现不可预知的问题。

参数:

mode - 预设的模感度类型

另请参阅:

ServerToolKits.SenseModeTCP

setSenseModeUDP

public static void setSenseModeUDP(ServerToolKits.SenseModeUDP mode)

设置MobileIMSDK核心框架的UDP协议心跳频率模式（默认为 ServerToolKits.SenseModeUDP.MODE_3S ）。

请在 ServerLauncher.startup()方法被调用前被设置，否则将不起效.

重要说明：服务端本模式的设定必须要与客户端的模式设制保持一致，否则 可能因参数的不一致而导至IM算法的不匹配，进而出现不可预知的问题。

参数:

mode - 预设的模感度类型

另请参阅:

ServerToolKits.SenseModeUDP

setSenseModeWebsocket

public static void setSenseModeWebsocket(ServerToolKits.SenseModeWebsocket mode)

设置MobileIMSDK核心框架的WebSocket协议心跳频率模式（默认为 ServerToolKits.SenseModeWebsocket.MODE_15S ）。

请在 ServerLauncher.startup()方法被调用前被设置，否则将不起效.

重要说明：服务端本模式的设定必须要与客户端的模式设制保持一致，否则 可能因参数的不一致而导至IM算法的不匹配，进而出现不可预知的问题。

参数:

mode - 预设的模感度类型

另请参阅:

ServerToolKits.SenseModeWebsocket

clientInfoToString

public static java.lang.String clientInfoToString(io.netty.channel.Channel session)

获取对应Session的信息（如session中存放的user_id、登陆名、ip地址和端口等）。

本方法目前仅用于Debug时。

参数:

session - 目标会话对象引用

返回:

session信息内容的文本

fromIOBuffer_JSON

public static java.lang.String fromIOBuffer_JSON(io.netty.buffer.ByteBuf buffer)
                                          throws java.lang.Exception

从Netty的数据缓冲对象中解析出MobileIMSDK的完整协议内容（Protocal对象的JSON表示形式）。

本方法将由MobileIMSDK框架内部算法按需调用，目前不建议也不需要开发者调用。

参数:

buffer - Netty的数据缓冲对象

返回:

解析后的MobileIMSDK的完整协议内容（Protocal对象的JSON表示形式）

抛出:

java.lang.Exception - 解析出错则抛出本异常

另请参阅:

IoBuffer#getString(java.nio.charset.CharsetDecoder)}

fromIOBuffer

public static Protocal fromIOBuffer(io.netty.buffer.ByteBuf buffer)
                             throws java.lang.Exception

从Netty的原始数据对象中解析出MobileIMSDK的完整协议内容（Protocal对象）。

本方法将由MobileIMSDK框架内部算法按需调用，目前不建议也不需要开发者调用。

参数:

buffer - Netty的数据缓冲对象

返回:

解析后的MobileIMSDK的完整协议内容（Protocal对象）

抛出:

java.lang.Exception - 解析出错则抛出本异常

另请参阅:

fromIOBuffer_JSON(ByteBuf)

toProtocal

public static Protocal toProtocal(java.lang.String protocalJSONStr)
                           throws java.lang.Exception

获得MobileIMSDK完整协议内容Protocal对象形式。

本方法将由MobileIMSDK框架内部算法按需调用，目前不建议也不需要开发者调用。

参数:

protocalJSONStr - Protocal对象的JSON文本形式

返回:

解析后的MobileIMSDK的完整协议内容（Protocal对象）

抛出:

java.lang.Exception - 解析出错则抛出本异常