net.x52im.mobileimsdk.android.core

类 LocalSocketProvider

java.lang.Object

net.x52im.mobileimsdk.android.core.LocalSocketProvider

public class LocalSocketProvider
extends java.lang.Object

本地 TCP Socket 实例封装实用类。
本类提供存取本地TCP Socket通信对象引用的方便方法，封装了Socket有效性判断以及异常处理等，以便确保调用者通过 方法 getLocalSocket()拿到的Socket对象是健康有效的。

依据作者对MobileIMSDK API的设计理念，本类将以单例的形式提供给调用者使用。

从以下版本开始:

1.0

版本:

1.0

作者:

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

字段概要

字段

限定符和类型	字段和说明
static io.netty.handler.ssl.SslContext	sslContext 开发者设置本对象可实现SSL/TLS加密传输，不设置则不开启SSL/TLS加密。
static int	TCP_FRAME_FIXED_HEADER_LENGTH MobileIMSDK中的TCP数据帧Headder（头部）字节长度（默认4字节）。
static int	TCP_FRAME_MAX_BODY_LENGTH MobileIMSDK中的TCP数据帧Body（数据体）的最大字节长度（默认最大6KB）。

方法概要

限定符和类型	方法和说明
void	closeLocalSocket() 参见closeLocalSocket(boolean)，默认silent参数=ture。
void	closeLocalSocket(boolean silent) 强制关闭本地Socket侦听。
static LocalSocketProvider	getInstance()
io.netty.channel.Channel	getLocalSocket() 获得本地Socket的实例引用.
boolean	isLocalSocketReady() 本类中的Socket对象是否是健康的。
static boolean	isSsl() 是否开启SSL/TLS加密传输。
io.netty.channel.Channel	resetLocalSocket() 重置并新建一个全新的Socket对象。
void	setConnectionDoneObserver(MBObserver connectionDoneObserver) 设置连接完成后将被通知的观察者。

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

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

字段详细资料

TCP_FRAME_FIXED_HEADER_LENGTH

public static int TCP_FRAME_FIXED_HEADER_LENGTH

MobileIMSDK中的TCP数据帧Headder（头部）字节长度（默认4字节）。

 ===== 【为了妥善解决TCP的半包、粘包经典问题，使用“数据包头Header+数据包体Body”的帧组织形式】 ======

 【即帧编码格式为】：
 Header(存放的是body数据长度，定长4字节int整数) + Body(真正数据内容，不定长，长度应在Header的最大值之内)。

 【举例】：
  以发送一个字母“A”（即body为“A”）为例，以下是编码后的完整数据帧形式：
  +------- Header (4 bytes)  -------|---------   Body (1 bytes) ----------+
  +      0x0000 0000 0000 0001      |              0x0041                 +
  +------ （内容为int整数1）   -------|-------（内容为字母“A”的ASCII码）------+

 【有关Netty实现TCP半包、粘包的资料，请见】：
 1）文章：最通用TCP黏包解决方案：LengthFieldBasedFrameDecoder和LengthFieldPrepender
 2）源码1：LengthFieldBasedFrameDecoder
 3）源码2：LengthFieldPrepender

 ============================================ 【END】 =======================================

TCP_FRAME_MAX_BODY_LENGTH

public static int TCP_FRAME_MAX_BODY_LENGTH

MobileIMSDK中的TCP数据帧Body（数据体）的最大字节长度（默认最大6KB）。

关于MobileIMSDK中的数据帧格式和定义，请见 TCP_FRAME_FIXED_HEADER_LENGTH 字段的详细说明

另请参阅:

TCP_FRAME_FIXED_HEADER_LENGTH

sslContext

public static io.netty.handler.ssl.SslContext sslContext

开发者设置本对象可实现SSL/TLS加密传输，不设置则不开启SSL/TLS加密。默认不设置（即本参数默认为null）。 当设置本对象时 isSsl()将返回true。

特别注意：请在MobileIMSDK初始化时设置本对象！

方法详细资料

getInstance

public static LocalSocketProvider getInstance()

setConnectionDoneObserver

public void setConnectionDoneObserver(MBObserver connectionDoneObserver)

设置连接完成后将被通知的观察者。如果设置本参数，则将在连接完成后调用1次，调用完成后置null。

设置本观察者的目的，是因为netty连接的过程是异常完成，有时希望在连接完成时就能立即执行想 要的逻辑，那么设置本观察者即可（在某次连接最终完成前，本参数的设置都会覆盖之前的设置，因为 只有这一个观察者可以用哦）。

参数:

connectionDoneObserver - 观察者对象

resetLocalSocket

public io.netty.channel.Channel resetLocalSocket()

重置并新建一个全新的Socket对象。

返回:

新建的全新Socket对象引用

另请参阅:

Channel, ConfigEntity.localPort

isLocalSocketReady

public boolean isLocalSocketReady()

本类中的Socket对象是否是健康的。

返回:

true表示是健康的，否则不是

getLocalSocket

public io.netty.channel.Channel getLocalSocket()

获得本地Socket的实例引用.

本方法内封装了Socket有效性判断以及异常处理等，以便确保调用者通过本方法拿到的Socket对象是健康有效的。

返回:

如果该实例正常则返回它的引用，否则返回null

另请参阅:

isLocalSocketReady(), resetLocalSocket()

closeLocalSocket

public void closeLocalSocket()

参见closeLocalSocket(boolean)，默认silent参数=ture。

从以下版本开始:

3.4

closeLocalSocket

public void closeLocalSocket(boolean silent)

强制关闭本地Socket侦听。
一旦调用本方法后，再次调用getLocalSocket()将会返回一个全新的Socket对象引用。

本方法通常在两个场景下被调用：
1) 真正需要关闭Socket时（如所在的APP通出时）；
2) 当调用者检测到网络发生变动后希望重置以便获得健康的Socket引用对象时。

参数:

silent - true表示打印log，否则静默执行无需打印log

另请参阅:

DatagramSocket.close()

isSsl

public static boolean isSsl()

是否开启SSL/TLS加密传输。

返回:

true表示是，否则不是