KeepAliveDaemon (MobileIMSDK_TCP 6.3(Android平台) API文档)

java.lang.Object
- net.x52im.mobileimsdk.android.core.KeepAliveDaemon

```
public class KeepAliveDaemon
extends java.lang.Object
```
用于保持与服务端通信活性的Keep alive心跳机制实现类（含心跳包发送定时器 + 心跳超时检查定时器）。
Keep alive的技术实现原理：
1、心跳包发送定时器：独立定时向服务端发送心跳包，不参与其它更多逻辑； 2、心跳超时检查定时器：独立检查服务端发过来的心跳响应超时时间，不参与其它更多逻辑，工作逻辑是定时检查，当 lastGetKeepAliveResponseFromServerTimstamp超过NETWORK_CONNECTION_TIME_OUT 超时阀值，将认为网络不同——随即让SDK进入掉线处理逻辑； 3、服务端心跳响应：服务端回过来的心跳响应时，将更新本类中的 lastGetKeepAliveResponseFromServerTimstamp 字段，用于更新"最近一次服务端的心跳响应包时间"，以便"2"中判断心跳响应超时的依据。
Keep alive的目的有2个：
1、防止NAT路由算法导致的端口老化：路由器的NAT路由算法存在所谓的“端口老化”概念，请参见文章：http://www.52im.net/thread-209-1-1.html。 2、即时探测由于网络状态的变动而导致的通信中断（进而自动触发自动治愈机制）：此种情况可的原因有（但不限于）：无线网络信号不稳定、WiFi与2G/3G/4G等同开情况下的网络切换、网络连接正常但宽带欠费被停机、手机系统的省电策略等。
本线程的启停，目前属于MobileIMSDK算法的一部分，暂时无需也不建议由应用层自行调用。

版本:

1.0

作者:

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

字段概要

字段
限定符和类型	字段和说明
`static int`	`KEEP_ALIVE_INTERVAL` Keep Alive 心跳发送时间间隔（单位：毫秒），默认15000毫秒（即15秒）.
`static int`	`NETWORK_CONNECTION_TIME_OUT` 收到服务端响应心跳包的超时间时间（单位：毫秒），默认（15 * 1000 + 5000）＝ 20000 毫秒（即20秒）.
`static int`	`NETWORK_CONNECTION_TIME_OUT_CHECK_INTERVAL` 心跳包超时检查定时器的运行间隔时间（单位：毫秒），默认（2 * 1000）＝ 2000 毫秒（即2秒）.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`java.util.Observer`	`getDebugObserver()` !
`static KeepAliveDaemon`	`getInstance()`
`boolean`	`isInit()` 本类对象是否已补初始化过。
`boolean`	`isKeepAliveRunning()` 线程是否正在运行中。
`void`	`notifyConnectionLost()` 心跳线程算法已判定需要与服务器的“通信通道”断开，调用此方法将进入框架的“通信通道”断开处理逻辑。
`void`	`setDebugObserver(java.util.Observer debugObserver)` !
`void`	`setNetworkConnectionLostObserver(java.util.Observer networkConnectionLostObserver)` 设置网络断开事件观察者.
`void`	`start(boolean immediately)` 启动线程。
`void`	`stop()` 无条件中断本线程的运行。
`void`	`updateGetKeepAliveResponseFromServerTimstamp()` 收到服务端反馈的心跳包时调用此方法：作用是更新服务端最背后的响应时间戳.

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

- 字段详细资料
  - KEEP_ALIVE_INTERVAL
```
public static int KEEP_ALIVE_INTERVAL
```
    Keep Alive 心跳发送时间间隔（单位：毫秒），默认15000毫秒（即15秒）.
    心跳间隔越短则保持会话活性的健康度更佳，但将使得在大量客户端连接情况下服务端因此而增加负载，且手机将消耗更多电量和流量，所以此间隔需要权衡（建议为：大于3秒且小于270秒(即4分半钟) ）！
    说明：此参数用于设定客户端发送到服务端的心跳间隔，心跳包的作用是用来保持与服务端的会话活性（更准确的说是为了避免客户端因路由器的NAT算法而导致路由器端口老化，相关知识见此文：http://www.52im.net/thread-281-1-1.html）.
    参定此参数的同时，也需要相应设置服务端的ServerLauncher.SESION_RECYCLER_EXPIRE参数。
  - NETWORK_CONNECTION_TIME_OUT
```
public static int NETWORK_CONNECTION_TIME_OUT
```
    收到服务端响应心跳包的超时间时间（单位：毫秒），默认（15 * 1000 + 5000）＝ 20000 毫秒（即20秒）.
    超过这个时间客户端将判定与服务端的网络连接已断开（此间隔建议为(KEEP_ALIVE_INTERVAL * 1) + 5 秒），没有上限，但不可太长，否则将不能即时反映出与服务器端的连接断开（比如掉掉线时），请从能忍受的反应时长和即时性上做出权衡。
    本参数除与KEEP_ALIVE_INTERVAL有关联外，不受其它设置影响。
  - NETWORK_CONNECTION_TIME_OUT_CHECK_INTERVAL
```
public static int NETWORK_CONNECTION_TIME_OUT_CHECK_INTERVAL
```
    心跳包超时检查定时器的运行间隔时间（单位：毫秒），默认（2 * 1000）＝ 2000 毫秒（即2秒）.
    此时间将决定断网感应灵敏度。建议设置值的范围为1~5秒内。
    
    从以下版本开始:
    
    6.1
- 方法详细资料
  - getInstance
```
public static KeepAliveDaemon getInstance()
```
  - notifyConnectionLost
```
public void notifyConnectionLost()
```
    心跳线程算法已判定需要与服务器的“通信通道”断开，调用此方法将进入框架的“通信通道”断开处理逻辑。
    本方法，目前属于MobileIMSDK框架算法的一部分，暂时无需也不建议由应用层开发者自行调用。
    
    从以下版本开始:
    
    5.0
  - stop
```
public void stop()
```
    无条件中断本线程的运行。
    本线程的启停，目前属于MobileIMSDK算法的一部分，暂时无需也不建议由应用层自行调用。
  - start
```
public void start(boolean immediately)
```
    启动线程。
    无论本方法调用前线程是否已经在运行中，都会尝试首先调用 stop()方法，以便确保线程被启动前是真正处于停止状态，这也意味着可无害调用本方法。
    本线程的启停，目前属于MobileIMSDK算法的一部分，暂时无需也不建议由应用层自行调用。
    
    参数:
    
    immediately - true表示立即执行线程作业，否则直到 KEEP_ALIVE_INTERVAL执行间隔的到来才进行首次作业的执行。
  - isKeepAliveRunning
```
public boolean isKeepAliveRunning()
```
    线程是否正在运行中。
    
    返回:
    
    true表示是，否则线路处于停止状态
  - isInit
```
public boolean isInit()
```
    本类对象是否已补初始化过。无论如何时请务必确保本对象的业务方法在执行前已经调用过 init。
    
    返回:
    
    true表示是，否则表示未被初始化
    
    从以下版本开始:
    
    3.4
  - updateGetKeepAliveResponseFromServerTimstamp
```
public void updateGetKeepAliveResponseFromServerTimstamp()
```
    收到服务端反馈的心跳包时调用此方法：作用是更新服务端最背后的响应时间戳.
    本方法的调用，目前属于MobileIMSDK算法的一部分，暂时无需也不建议由应用层自行调用。
  - setNetworkConnectionLostObserver
```
public void setNetworkConnectionLostObserver(java.util.Observer networkConnectionLostObserver)
```
    设置网络断开事件观察者.
    本方法的调用，目前属于MobileIMSDK算法的一部分，暂时无需也不建议由应用层自行调用。
    
    参数:
    
    networkConnectionLostObserver - 网络断开事件观察者
  - getDebugObserver
```
public java.util.Observer getDebugObserver()
```
    !本方法仅用于DEBUG，开发者无需关注！
    
    返回:
    
    DEBUG事件观察者
  - setDebugObserver
```
public void setDebugObserver(java.util.Observer debugObserver)
```
    !本方法仅用于DEBUG，开发者无需关注！
    
    参数:
    
    debugObserver - DEBUG事件观察者

类 KeepAliveDaemon

字段概要

方法概要

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

字段详细资料

KEEP_ALIVE_INTERVAL

NETWORK_CONNECTION_TIME_OUT

NETWORK_CONNECTION_TIME_OUT_CHECK_INTERVAL

方法详细资料

getInstance

notifyConnectionLost

stop

start

isKeepAliveRunning

isInit

updateGetKeepAliveResponseFromServerTimstamp

setNetworkConnectionLostObserver

getDebugObserver

setDebugObserver