org.smartboot.socket.extension.plugins

类 HeartPlugin<T>

java.lang.Object

org.smartboot.socket.extension.plugins.AbstractPlugin<T>

org.smartboot.socket.extension.plugins.HeartPlugin<T>

所有已实现的接口:

Plugin<T>, NetMonitor

public abstract class HeartPlugin<T>
extends AbstractPlugin<T>

心跳插件

版本:

V1.0 , 2018/8/19

作者:

三刀

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	HeartPlugin.TimeoutCallback

构造器概要

构造器

构造器和说明
HeartPlugin(int heartRate, int timeout, TimeUnit unit) 心跳插件 心跳插件在断网场景可能会触发TCP Retransmission,导致无法感知到网络实际状态,可通过设置timeout关闭连接
HeartPlugin(int heartRate, int timeout, TimeUnit timeUnit, HeartPlugin.TimeoutCallback timeoutCallback) 心跳插件 心跳插件在断网场景可能会触发TCP Retransmission,导致无法感知到网络实际状态,可通过设置timeout关闭连接
HeartPlugin(int heartRate, TimeUnit timeUnit) 心跳插件

方法概要

限定符和类型	方法和说明
abstract boolean	isHeartMessage(AioSession session, T msg) 判断当前收到的消息是否为心跳消息。
boolean	preProcess(AioSession session, T t) 对请求消息进行预处理，并决策是否进行后续的MessageProcessor处理。
abstract void	sendHeartRequest(AioSession session) 自定义心跳消息并发送
void	stateEvent(StateMachineEnum stateMachineEnum, AioSession session, Throwable throwable) 监听状态机事件

从类继承的方法 org.smartboot.socket.extension.plugins.AbstractPlugin

afterRead, afterWrite, beforeRead, beforeWrite, shouldAccept

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

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

构造器详细资料

HeartPlugin

public HeartPlugin(int heartRate,
                   TimeUnit timeUnit)

心跳插件

参数:

heartRate - 心跳触发频率

timeUnit - heatRate单位

HeartPlugin

public HeartPlugin(int heartRate,
                   int timeout,
                   TimeUnit unit)

心跳插件

心跳插件在断网场景可能会触发TCP Retransmission,导致无法感知到网络实际状态,可通过设置timeout关闭连接

参数:

heartRate - 心跳触发频率

timeout - 消息超时时间

unit - 时间单位

HeartPlugin

public HeartPlugin(int heartRate,
                   int timeout,
                   TimeUnit timeUnit,
                   HeartPlugin.TimeoutCallback timeoutCallback)

心跳插件

心跳插件在断网场景可能会触发TCP Retransmission,导致无法感知到网络实际状态,可通过设置timeout关闭连接

参数:

heartRate - 心跳触发频率

timeout - 消息超时时间

方法详细资料

preProcess

public final boolean preProcess(AioSession session,
                                T t)

从接口复制的说明: Plugin

对请求消息进行预处理，并决策是否进行后续的MessageProcessor处理。 若返回false，则当前消息将被忽略。 若返回true，该消息会正常秩序MessageProcessor.process.

指定者:

preProcess 在接口中 Plugin<T>

覆盖:

preProcess 在类中 AbstractPlugin<T>

返回:

stateEvent

public final void stateEvent(StateMachineEnum stateMachineEnum,
                             AioSession session,
                             Throwable throwable)

从接口复制的说明: Plugin

监听状态机事件

指定者:

stateEvent 在接口中 Plugin<T>

覆盖:

stateEvent 在类中 AbstractPlugin<T>

另请参阅:

MessageProcessor.stateEvent(AioSession, StateMachineEnum, Throwable)

sendHeartRequest

public abstract void sendHeartRequest(AioSession session)
                               throws IOException

自定义心跳消息并发送

参数:

session -

抛出:

IOException

isHeartMessage

public abstract boolean isHeartMessage(AioSession session,
                                       T msg)

判断当前收到的消息是否为心跳消息。 心跳请求消息与响应消息可能相同，也可能不同，因实际场景而异，故接口定义不做区分。

参数:

session -

msg -

返回: