org.aoju.bus.socket.origin.plugins

Class HeartPlugin<T>

java.lang.Object

org.aoju.bus.socket.origin.plugins.AbstractPlugin<T>

org.aoju.bus.socket.origin.plugins.HeartPlugin<T>

All Implemented Interfaces:

NetMonitor<T>, Plugin<T>

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

心跳插件

Since:

JDK 1.8+

Version:

5.5.0

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
HeartPlugin(int timeout)

Method Summary

Modifier and Type	Method and Description
abstract boolean	isHeartMessage(AioSession<T> session, T msg) 判断当前收到的消息是否为心跳消息 心跳请求消息与响应消息可能相同,也可能不同,因实际场景而异,故接口定义不做区分
boolean	preProcess(AioSession<T> session, T t) 对请求消息进行预处理,并决策是否进行后续的MessageProcessor处理 若返回false,则当前消息将被忽略 若返回true,该消息会正常秩序MessageProcessor.process.
abstract void	sendHeartRequest(AioSession<T> session) 自定义心跳消息并发送
void	stateEvent(StateMachine stateMachineEnum, AioSession<T> session, Throwable throwable)

Methods inherited from class org.aoju.bus.socket.origin.plugins.AbstractPlugin

acceptMonitor, readMonitor, writeMonitor

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartPlugin

public HeartPlugin(int timeout)

Method Detail

preProcess

public final boolean preProcess(AioSession<T> session,
                                T t)

Description copied from interface: Plugin

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

Specified by:

preProcess in interface Plugin<T>

Overrides:

preProcess in class AbstractPlugin<T>

Parameters:

session - 会话

t - 对象

Returns:

true/false

stateEvent

public final void stateEvent(StateMachine stateMachineEnum,
                             AioSession<T> session,
                             Throwable throwable)

Specified by:

stateEvent in interface Plugin<T>

Overrides:

stateEvent in class AbstractPlugin<T>

Parameters:

stateMachineEnum - 状态

session - 会话

throwable - 线程

sendHeartRequest

public abstract void sendHeartRequest(AioSession<T> session)
                               throws IOException

自定义心跳消息并发送

Parameters:

session - 会话

Throws:

IOException - 异常

isHeartMessage

public abstract boolean isHeartMessage(AioSession<T> session,
                                       T msg)

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

Parameters:

session - 会话

msg - 信息

Returns:

true/false