org.voovan.http.server

Class WebSocketDispatcher

java.lang.Object

org.voovan.http.server.WebSocketDispatcher

public class WebSocketDispatcher
extends Object

根据 WebSocket 请求分派到处理路由

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketDispatcher.WebSocketEvent

Field Summary

Fields

Modifier and Type	Field and Description
static HashWheelTimer	HEARTBEAT_WHEEL_TIMER

Constructor Summary

Constructors

Constructor and Description
WebSocketDispatcher(WebServerConfig webConfig, SessionManager sessionManager) 构造函数

Method Summary

Modifier and Type	Method and Description
void	addRouteHandler(String routePath, WebSocketRouter handler) 增加一个路由规则
WebSocketSession	disposeSession(HttpRequest request, WebSocketRouter webSocketRouter) 处理 WebSocketSession
static Object	filterDecoder(WebSocketSession session, Chain<WebSocketFilter> wsFilterChain, Object result) 过滤器解密函数,接收事件(onRecive)前调用 onRecive事件前调用
static Object	filterDecoder(WebSocketSession session, Object result) 过滤器解密函数,接收事件(onRecive)前调用 onRecive事件前调用
static Object	filterEncoder(WebSocketSession session, Chain<WebSocketFilter> wsFilterChain, Object result) 使用过滤器编码结果
static Object	filterEncoder(WebSocketSession session, Object result) 过滤器解密函数,接收事件(onRecive)前调用 onRecive事件前调用
org.voovan.http.server.RouterWrap<WebSocketRouter>	findRouter(HttpRequest request) 获取路由处理对象和注册路由
void	fireCloseEvent(IoSession session) 出发 Close 事件
WebSocketFrame	fireOpenEvent(IoSession session, HttpRequest request) 触发 WebSocket Open 事件
WebSocketFrame	firePingEvent(IoSession session, HttpRequest request, ByteBuffer byteBuffer) 触发 WebSocket Ping 事件
void	firePoneEvent(IoSession session, HttpRequest request, ByteBuffer byteBuffer) 触发 WebSocket Pone 事件
WebSocketFrame	fireReceivedEvent(IoSession session, HttpRequest request, ByteBuffer byteBuffer) 触发 WebSocket Received 事件
void	fireSentEvent(IoSession session, HttpRequest request, ByteBuffer byteBuffer) 触发 WebSocket Sent 事件
static HashWheelTimer	getHeartBeatWheelTimer()
Map<String,org.voovan.http.server.RouterWrap<WebSocketRouter>>	getRouters() 获取 WebSocket 的路由配置
WebSocketFrame	process(WebSocketDispatcher.WebSocketEvent event, IoSession session, HttpRequest request, ByteBuffer byteBuffer) 路由处理函数

Methods inherited from class java.lang.Object

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

Field Detail

HEARTBEAT_WHEEL_TIMER

public static HashWheelTimer HEARTBEAT_WHEEL_TIMER

Constructor Detail

WebSocketDispatcher

public WebSocketDispatcher(WebServerConfig webConfig,
                           SessionManager sessionManager)

构造函数

Parameters:

webConfig - WEB 配置对象

sessionManager - session 管理器

Method Detail

getHeartBeatWheelTimer

public static HashWheelTimer getHeartBeatWheelTimer()

getRouters

public Map<String,org.voovan.http.server.RouterWrap<WebSocketRouter>> getRouters()

获取 WebSocket 的路由配置

Returns:

路由配置信息

addRouteHandler

public void addRouteHandler(String routePath,
                            WebSocketRouter handler)

增加一个路由规则

Parameters:

routePath - 匹配路径

handler - WebSocketRouter 对象

findRouter

public org.voovan.http.server.RouterWrap<WebSocketRouter> findRouter(HttpRequest request)

获取路由处理对象和注册路由

Parameters:

request - 请求对象

Returns:

路由信息对象 [ 匹配到的已注册路由, WebSocketRouter对象 ]

filterDecoder

public static Object filterDecoder(WebSocketSession session,
                                   Chain<WebSocketFilter> wsFilterChain,
                                   Object result)
                            throws WebSocketFilterException

过滤器解密函数,接收事件(onRecive)前调用 onRecive事件前调用

Parameters:

session - session 对象

wsFilterChain - 过滤器链

result - 解码对象,上一个过滤器的返回值

Returns:

解码后对象

Throws:

WebSocketFilterException - WebSocket过滤器异常

filterDecoder

public static Object filterDecoder(WebSocketSession session,
                                   Object result)
                            throws WebSocketFilterException

过滤器解密函数,接收事件(onRecive)前调用 onRecive事件前调用

Parameters:

session - session 对象

result - 解码对象,上一个过滤器的返回值

Returns:

解码后对象

Throws:

WebSocketFilterException - WebSocket过滤器异常

filterEncoder

public static Object filterEncoder(WebSocketSession session,
                                   Chain<WebSocketFilter> wsFilterChain,
                                   Object result)
                            throws WebSocketFilterException

使用过滤器编码结果

Parameters:

session - Session 对象

wsFilterChain - 过滤器链

result - 需编码的对象

Returns:

编码后的对象

Throws:

WebSocketFilterException - WebSocket过滤器异常

filterEncoder

public static Object filterEncoder(WebSocketSession session,
                                   Object result)
                            throws WebSocketFilterException

过滤器解密函数,接收事件(onRecive)前调用 onRecive事件前调用

Parameters:

session - session 对象

result - 解码对象,上一个过滤器的返回值

Returns:

解码后对象

Throws:

WebSocketFilterException - WebSocket过滤器异常

process

public WebSocketFrame process(WebSocketDispatcher.WebSocketEvent event,
                              IoSession session,
                              HttpRequest request,
                              ByteBuffer byteBuffer)

路由处理函数

Parameters:

event - WebSocket 事件

session - socket连接会话

request - HTTP 请求对象

byteBuffer - 对象, 保存 WebSocket 数据

Returns:

WebSocket 帧对象

disposeSession

public WebSocketSession disposeSession(HttpRequest request,
                                       WebSocketRouter webSocketRouter)

处理 WebSocketSession

Parameters:

request - Http 请求对象

webSocketRouter - websocket 路由处理

Returns:

WebSocketSession对象

fireOpenEvent

public WebSocketFrame fireOpenEvent(IoSession session,
                                    HttpRequest request)

触发 WebSocket Open 事件

Parameters:

session - socket 会话对象

request - http 请求对象

Returns:

WebSocketFrame WebSocket 帧

fireReceivedEvent

public WebSocketFrame fireReceivedEvent(IoSession session,
                                        HttpRequest request,
                                        ByteBuffer byteBuffer)

触发 WebSocket Received 事件

Parameters:

session - socket 会话对象

request - http 请求对象

byteBuffer - ping的报文数据

Returns:

WebSocketFrame WebSocket 帧

fireSentEvent

public void fireSentEvent(IoSession session,
                          HttpRequest request,
                          ByteBuffer byteBuffer)

触发 WebSocket Sent 事件

Parameters:

session - socket 会话对象

request - http 请求对象

byteBuffer - ByteBuffer 对象

fireCloseEvent

public void fireCloseEvent(IoSession session)

出发 Close 事件

Parameters:

session - HTTP-Session 对象

firePingEvent

public WebSocketFrame firePingEvent(IoSession session,
                                    HttpRequest request,
                                    ByteBuffer byteBuffer)

触发 WebSocket Ping 事件

Parameters:

session - socket 会话对象

request - http 请求对象

byteBuffer - ping的报文数据

Returns:

WebSocketFrame WebSocket 帧

firePoneEvent

public void firePoneEvent(IoSession session,
                          HttpRequest request,
                          ByteBuffer byteBuffer)

触发 WebSocket Pone 事件

Parameters:

session - socket 会话对象

request - http 请求对象

byteBuffer - ByteBuffer 对象