mysql心跳检测_心跳检测 · GatewayWorker手册 · 看云

## 为什么需要心跳检测？

正常的情况客户端断开连接会向服务端发送一个fin包，服务端收到fin包后得知客户端连接断开，则立刻触发onClose事件回调。

但是有些极端情况如客户端掉电、网络关闭、拔网线、路由故障等，这些极端情况客户端无法发送fin包给服务端，服务端便无法知道连接已经断开。如果客户端与服务端定时有心跳数据传输，则会比较及时的发现连接断开，触发onClose事件回调。

另外路由节点防火墙会关闭长时间不通讯的socket连接，导致socket长连接断开。所以需要客户端与服务端定时发送心跳数据保持连接不被断开。

## 心跳检测的原理是什么？

客户端定时每X秒(推荐小于60秒)向服务端发送特定数据(任意数据都可)，服务端设定为X秒没有收到客户端心跳则认为客户端掉线，并关闭连接触发onClose回调。这样即通过心跳检测请求维持了连接(避免连接因长时间不活跃而被网关防火墙关闭)，也能让服务端比较及时的知道客户端是否异常掉线。

## GatewayWorker中如何配置心跳检测？

目前GatewayWorker支持两种心跳检测，服务端设定多少秒内没收到心跳关闭连接(推荐)，同时也支持服务端定时向客户端发送心跳数据(不推荐)。

## 客户端定时发送心跳(推荐)

客户端定时(间隔最好小于60秒)向服务端发送心跳。服务端类似以下配置：

```php

$gateway = new Gateway("Websocket://0.0.0.0:8585");

$gateway->pingInterval = 55;

$gateway->pingNotResponseLimit = 1;

$gateway->pingData = '';

```

以上配置含义是客户端连接 ```pingInterval*pingNotResponseLimit=55``` 秒内没有任何数据传输给服务端则服务端认为对应客户端已经掉线，服务端关闭连接并触发onClose回调。

> 由于心跳是周期性检测，实际执行onClose的时间一般会大于`pingInterval*pingNotResponseLimit=55`，误差在`pingInterval`内。

## 服务端主动发送心跳(不推荐)

GatewayWorer支持服务端向客户端发送心跳检测，可以像下面这样设置。

```php

$gateway = new Gateway("Websocket://0.0.0.0:8585");

$gateway->pingInterval = 55;

$gateway->pingNotResponseLimit = 0;

// 服务端定时向客户端发送的数据

$gateway->pingData = '{"type":"ping"}';

```

以上服务端会定时55秒给客户端发心跳数据```{"type":"ping"}```，而客户端不需要定时向服务端发送心跳数据。

其中```pingNotResponseLimit = 0```代表服务端允许客户端不发送心跳，服务端**不会**因为客户端长时间没发送数据而断开连接。

如果```pingNotResponseLimit = 1```，则代表客户端必须定时发送数据给服务端，否则```pingNotResponseLimit*pingInterval=55```秒内没有任何数据发来则关闭对应连接，并触发onClose。

> 由于心跳是周期性检测，实际执行onClose的时间一般会大于`pingInterval*pingNotResponseLimit=55`，误差在`pingInterval`内。

### 说明：

``` Gateway::$pingInterval ```

心跳检测时间间隔 单位：秒。如果设置为0代表不做任何心跳检测。

``` Gateway::$pingNotResponseLimit ```

客户端连续```$pingNotResponseLimit```次```$pingInterval```时间内不发送任何数据(包括但不限于心跳数据)则断开链接，并触发onClose。

如果设置为0代表客户端不用发送心跳数据，即通过TCP层面检测连接的连通性(极端情况至少10分钟才能检测到连接断开，甚至可能永远检测不到)

``` Gateway::$pingData ```

当需要服务端定时给客户端发送心跳数据时， ``` $gateway->pingData ```设置为服务端要发送的心跳请求数据，心跳数据是任意的，只要客户端能识别即可。客户端收到心跳数据可以忽略不做任何处理。

### 注意:

当设置为服务端主动发送心跳时，心跳间隔并不是100%精准。当客户端连接成功后，服务端发来的第一个心跳的时间间隔可能要小于服务器设置的值。

当设置为服务端主动发送心跳时，如果客户端最近有发来数据，那么证明客户端存活，服务端会省略一个心跳，下个心跳大约```1.5*$gateway->pingInterval```秒后发送。