org.tio.websocket.server

Class WsServerAioListener

java.lang.Object

org.tio.websocket.server.WsServerAioListener

All Implemented Interfaces:

AioListener, ServerAioListener

public class WsServerAioListener
extends Object
implements ServerAioListener

Author:

tanyaowu 2017年7月30日 上午9:16:02

Constructor Summary

Constructors

Constructor and Description
WsServerAioListener()

Method Summary

Modifier and Type	Method and Description
void	onAfterConnected(ChannelContext channelContext, boolean isConnected, boolean isReconnect) 建链后触发本方法，注：建链不一定成功，需要关注参数isConnected
void	onAfterDecoded(ChannelContext channelContext, Packet packet, int packetSize) 原方法名：onAfterDecoded 解码成功后触发本方法
void	onAfterHandled(ChannelContext channelContext, Packet packet, long cost) 处理一个消息包后
void	onAfterReceivedBytes(ChannelContext channelContext, int receivedBytes) 接收到TCP层传过来的数据后
void	onAfterSent(ChannelContext channelContext, Packet packet, boolean isSentSuccess) 消息包发送之后触发本方法
void	onBeforeClose(ChannelContext channelContext, Throwable throwable, String remark, boolean isRemove) 连接关闭前触发本方法
boolean	onHeartbeatTimeout(ChannelContext channelContext, Long interval, int heartbeatTimeoutCount) 服务器检查到心跳超时时，会调用这个函数（一般场景，该方法只需要直接返回false即可）

Methods inherited from class java.lang.Object

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

Constructor Detail

WsServerAioListener

public WsServerAioListener()

Method Detail

onAfterConnected

public void onAfterConnected(ChannelContext channelContext,
                             boolean isConnected,
                             boolean isReconnect)
                      throws Exception

Description copied from interface: AioListener

建链后触发本方法，注：建链不一定成功，需要关注参数isConnected

Specified by:

onAfterConnected in interface AioListener

isConnected - 是否连接成功,true:表示连接成功，false:表示连接失败

isReconnect - 是否是重连, true: 表示这是重新连接，false: 表示这是第一次连接

Throws:

Exception

onAfterDecoded

public void onAfterDecoded(ChannelContext channelContext,
                           Packet packet,
                           int packetSize)
                    throws Exception

Description copied from interface: AioListener

原方法名：onAfterDecoded 解码成功后触发本方法

Specified by:

onAfterDecoded in interface AioListener

Throws:

Exception

onAfterSent

public void onAfterSent(ChannelContext channelContext,
                        Packet packet,
                        boolean isSentSuccess)
                 throws Exception

Description copied from interface: AioListener

消息包发送之后触发本方法

Specified by:

onAfterSent in interface AioListener

isSentSuccess - true:发送成功，false:发送失败

Throws:

Exception

onBeforeClose

public void onBeforeClose(ChannelContext channelContext,
                          Throwable throwable,
                          String remark,
                          boolean isRemove)
                   throws Exception

Description copied from interface: AioListener

连接关闭前触发本方法

Specified by:

onBeforeClose in interface AioListener

Parameters:

channelContext - the channelcontext

throwable - the throwable 有可能为空

remark - the remark 有可能为空

Throws:

Exception

onAfterHandled

public void onAfterHandled(ChannelContext channelContext,
                           Packet packet,
                           long cost)
                    throws Exception

Description copied from interface: AioListener

处理一个消息包后

Specified by:

onAfterHandled in interface AioListener

cost - 本次处理消息耗时，单位：毫秒

Throws:

Exception

onAfterReceivedBytes

public void onAfterReceivedBytes(ChannelContext channelContext,
                                 int receivedBytes)
                          throws Exception

Description copied from interface: AioListener

接收到TCP层传过来的数据后

Specified by:

onAfterReceivedBytes in interface AioListener

receivedBytes - 本次接收了多少字节

Throws:

Exception

onHeartbeatTimeout

public boolean onHeartbeatTimeout(ChannelContext channelContext,
                                  Long interval,
                                  int heartbeatTimeoutCount)

Description copied from interface: ServerAioListener

服务器检查到心跳超时时，会调用这个函数（一般场景，该方法只需要直接返回false即可）

Specified by:

onHeartbeatTimeout in interface ServerAioListener

interval - 已经多久没有收发消息了，单位：毫秒

heartbeatTimeoutCount - 心跳超时次数，第一次超时此值是1，以此类推。此值被保存在：channelContext.stat.heartbeatTimeoutCount

Returns:

返回true，那么服务器则不关闭此连接；返回false，服务器将按心跳超时关闭该连接