org.nutz.plugins.mvc.websocket.handler

类 AbstractWsHandler

java.lang.Object

org.nutz.plugins.mvc.websocket.handler.AbstractWsHandler

所有已实现的接口:

javax.websocket.MessageHandler, WsHandler

直接已知子类:

SimpleWsHandler

public abstract class AbstractWsHandler
extends Object
implements WsHandler

嵌套类概要

从接口继承的嵌套类/接口 javax.websocket.MessageHandler

javax.websocket.MessageHandler.Partial<T>, javax.websocket.MessageHandler.Whole<T>

字段概要

字段

限定符和类型	字段和说明
protected Map<String,org.nutz.lang.util.Callback<org.nutz.lang.util.NutMap>>	actions
protected AbstractWsEndpoint	endpoint
protected javax.servlet.http.HttpSession	httpSession
protected String	prefix
protected WsRoomProvider	roomProvider
protected Set<String>	rooms
protected javax.websocket.Session	session

构造器概要

构造器

构造器和说明
AbstractWsHandler(String prefix)

方法概要

限定符和类型	方法和说明
void	defaultAction(org.nutz.lang.util.NutMap msg) 没有任何action方法对应时,就调用它咯
void	depose() 会话关闭时的回调
void	init() 在所有setXXX方法执行完毕后才会调用的初始化方法
void	join(String room)
void	left(String room)
void	onActionError(org.nutz.lang.util.NutMap msg, Throwable e) 抛出异常的时候调用之
void	onMessage(String message) 处理消息, 将其转为NutMap,然后找对应的处理方法.
void	setEndpoint(AbstractWsEndpoint endpoint) Endpoint实现类的实例,主要是为了提高websocket发送消息的api
void	setHttpSession(javax.servlet.http.HttpSession httpSession) 设置关联的HttpSession
void	setRoomProvider(WsRoomProvider roomProvider) 设置房间的实现类的实例
void	setSession(javax.websocket.Session session) 设置WebSocket Session实例

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

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

字段详细资料

rooms

protected Set<String> rooms

roomProvider

protected WsRoomProvider roomProvider

session

protected javax.websocket.Session session

prefix

protected String prefix

httpSession

protected javax.servlet.http.HttpSession httpSession

endpoint

protected AbstractWsEndpoint endpoint

actions

protected Map<String,org.nutz.lang.util.Callback<org.nutz.lang.util.NutMap>> actions

构造器详细资料

AbstractWsHandler

public AbstractWsHandler(String prefix)

方法详细资料

join

public void join(String room)

left

public void left(String room)

depose

public void depose()

从接口复制的说明: WsHandler

会话关闭时的回调

指定者:

depose 在接口中 WsHandler

init

public void init()

从接口复制的说明: WsHandler

在所有setXXX方法执行完毕后才会调用的初始化方法

指定者:

init 在接口中 WsHandler

onMessage

public void onMessage(String message)

处理消息, 将其转为NutMap,然后找对应的处理方法.

指定者:

onMessage 在接口中 WsHandler

onActionError

public void onActionError(org.nutz.lang.util.NutMap msg,
                          Throwable e)

抛出异常的时候调用之

defaultAction

public void defaultAction(org.nutz.lang.util.NutMap msg)

没有任何action方法对应时,就调用它咯

setRoomProvider

public void setRoomProvider(WsRoomProvider roomProvider)

从接口复制的说明: WsHandler

设置房间的实现类的实例

指定者:

setRoomProvider 在接口中 WsHandler

setSession

public void setSession(javax.websocket.Session session)

从接口复制的说明: WsHandler

设置WebSocket Session实例

指定者:

setSession 在接口中 WsHandler

参数:

session - WebSocket会话实例,肯定不是null

setHttpSession

public void setHttpSession(javax.servlet.http.HttpSession httpSession)

从接口复制的说明: WsHandler

设置关联的HttpSession

指定者:

setHttpSession 在接口中 WsHandler

参数:

httpSession - 设置所关联的会话, 可能是null

setEndpoint

public void setEndpoint(AbstractWsEndpoint endpoint)

从接口复制的说明: WsHandler

Endpoint实现类的实例,主要是为了提高websocket发送消息的api

指定者:

setEndpoint 在接口中 WsHandler