org.tio.websocket.server.handler

Interface IWsMsgHandler

All Superinterfaces:

IWsSubProtocolsMsgHandler

public interface IWsMsgHandler
extends IWsSubProtocolsMsgHandler

Author:

tanyaowu 2017年7月30日 上午9:34:59

Method Summary

Modifier and Type	Method and Description
default HttpResponse	handshake(HttpRequest request, HttpResponse response, ChannelContext context) 对httpResponse参数进行补充并返回，如果返回null表示不想和对方建立连接，框架会断开连接，如果返回非null，框架会把这个对象发送给对方 注：请不要在这个方法中向对方发送任何消息，因为这个时候握手还没完成，发消息会导致协议交互失败。
default void	onAfterHandshaked(HttpRequest request, HttpResponse response, ChannelContext context) 握手成功后触发该方法
default Object	onBytes(WsRequest request, byte[] bytes, ChannelContext context) 当收到Opcode.BINARY消息时，执行该方法。
default Object	onClose(WsRequest request, byte[] bytes, ChannelContext context) 当收到Opcode.CLOSE时，执行该方法，业务层在该方法中一般不需要写什么逻辑，空着就好
default Object	onText(WsRequest request, String text, ChannelContext context) 当收到Opcode.TEXT消息时，执行该方法。

Methods inherited from interface org.tio.websocket.server.handler.IWsSubProtocolsMsgHandler

encodeSubProtocol, getSupportedSubProtocols

Method Detail

handshake

default HttpResponse handshake(HttpRequest request,
                               HttpResponse response,
                               ChannelContext context)
                        throws Exception

对httpResponse参数进行补充并返回，如果返回null表示不想和对方建立连接，框架会断开连接，如果返回非null，框架会把这个对象发送给对方 注：请不要在这个方法中向对方发送任何消息，因为这个时候握手还没完成，发消息会导致协议交互失败。 对于大部分业务，该方法只需要一行代码：return httpResponse;

Parameters:

request - HttpRequest

response - HttpResponse

context - ChannelContext

Returns:

HttpResponse

Throws:

Exception - Exception

onAfterHandshaked

default void onAfterHandshaked(HttpRequest request,
                               HttpResponse response,
                               ChannelContext context)
                        throws Exception

握手成功后触发该方法

Parameters:

request - HttpRequest

response - HttpResponse

context - ChannelContext

Throws:

Exception - Exception

onBytes

default Object onBytes(WsRequest request,
                       byte[] bytes,
                       ChannelContext context)
                throws Exception

当收到Opcode.BINARY消息时，执行该方法。也就是说如何你的ws是基于BINARY传输的，就会走到这个方法