cn.starboot.socket.plugins

类 HeartPlugin

java.lang.Object

cn.starboot.socket.plugins.AbstractPlugin

cn.starboot.socket.plugins.HeartPlugin

所有已实现的接口:

Monitor, Plugin

public abstract class HeartPlugin
extends AbstractPlugin

心跳插件

版本:

2.10.1.v20211002-RELEASE

作者:

MDong

嵌套类概要

嵌套类

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

字段概要

字段

限定符和类型	字段和说明
private static HeartPlugin.TimeoutCallback	DEFAULT_TIMEOUT_CALLBACK
private static org.slf4j.Logger	LOGGER
private long	period
private Map<ChannelContext,Long>	sessionMap
private long	timeout
private HeartPlugin.TimeoutCallback	timeoutCallback

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
boolean	beforeProcess(ChannelContext channelContext, Packet packet)
abstract boolean	isHeartMessage(Packet packet) 判断当前收到的消息是否为心跳消息。
private void	registerHeart(ChannelContext channelContext)
void	stateEvent(StateMachineEnum stateMachineEnum, ChannelContext context, Throwable throwable)

从类继承的方法 cn.starboot.socket.plugins.AbstractPlugin

afterDecode, afterRead, afterWrite, beforeEncode, beforeRead, beforeWrite, shouldAccept

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

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

字段详细资料

LOGGER

private static final org.slf4j.Logger LOGGER

DEFAULT_TIMEOUT_CALLBACK

private static final HeartPlugin.TimeoutCallback DEFAULT_TIMEOUT_CALLBACK

sessionMap

private final Map<ChannelContext,Long> sessionMap

timeout

private final long timeout

period

private final long period

timeoutCallback

private final HeartPlugin.TimeoutCallback timeoutCallback

构造器详细资料

HeartPlugin

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

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

参数:

timeout - 消息超时时间

unit - 时间单位

HeartPlugin

private HeartPlugin(int timeout,
                    int period,
                    TimeUnit timeUnit,
                    HeartPlugin.TimeoutCallback timeoutCallback)

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

参数:

timeout - 消息超时时间

方法详细资料

beforeProcess

public final boolean beforeProcess(ChannelContext channelContext,
                                   Packet packet)

指定者:

beforeProcess 在接口中 Plugin

覆盖:

beforeProcess 在类中 AbstractPlugin

stateEvent

public final void stateEvent(StateMachineEnum stateMachineEnum,
                             ChannelContext context,
                             Throwable throwable)

指定者:

stateEvent 在接口中 Plugin

覆盖:

stateEvent 在类中 AbstractPlugin

isHeartMessage

public abstract boolean isHeartMessage(Packet packet)

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

参数:

packet - 心跳包

返回:

判断是否为心跳包

registerHeart

private void registerHeart(ChannelContext channelContext)