org.nutz.plugins.mvc.websocket

类 AbstractWsEndpoint

java.lang.Object

org.nutz.plugins.mvc.websocket.AbstractWsEndpoint

public abstract class AbstractWsEndpoint
extends Object

深度封装WebSocket的基础操作. 用法: 继承本类,并标注

@ServerEndpoint(value = "/websocket", configurator=NutWsConfigurator.class) @IocBean(create="init", depose="depose")

作者:

wendal

字段概要

字段

限定符和类型	字段和说明
protected ConcurrentHashMap<String,WsHandler>	handlers 存放Websocket Session Id --> WsHandler 的映射关系
protected Field	idField 用于修改Session的Id字段
protected String	roomPrefix
protected WsRoomProvider	roomProvider 房间提供者.
protected ConcurrentHashMap<String,javax.websocket.Session>	sessions 存放Websocket Session Id --> Session 的映射关系

构造器概要

构造器

构造器和说明
AbstractWsEndpoint()

方法概要

限定符和类型	方法和说明
void	_onClose(javax.websocket.Session session, javax.websocket.CloseReason closeReason)
void	_onError(javax.websocket.Session session, Throwable throwable)
void	_onMesssageString(javax.websocket.Session session, String msg)
void	_onOpen(javax.websocket.Session session, javax.websocket.EndpointConfig config)
protected void	changeSessionId(javax.websocket.Session session) WebSocketSession只对当前JVM是唯一的,所以我们要改造一下, 变成UUID.
WsHandler	createHandler(javax.websocket.Session session, javax.websocket.EndpointConfig config) 根据WebSocket会话创建一个WsHandler.
void	each(String room, org.nutz.lang.Each<javax.websocket.Session> callback) 按房间遍历活跃的session对象
WsHandler	getHandler(String wsid) 根据wsid获取其WsHandler实例
String	getRoomPrefix()
WsRoomProvider	getRoomProvider()
javax.websocket.Session	getSession(String wsid) 返回一个活跃的WebSocket Session对象
javax.websocket.Session	getSession(String wsid, boolean opened) 根据wsid获取一个Session对象.
boolean	isUndertowSession(javax.websocket.Session session)
void	onClose(javax.websocket.Session session, javax.websocket.CloseReason closeReason) WebSocket会话关闭是调用本方法,通常是用户关闭浏览器.
void	onError(javax.websocket.Session session, Throwable throwable) WebSocket会话出错时调用,默认调用onClose.
void	onMesssageString(javax.websocket.Session session, String msg)
void	onOpen(javax.websocket.Session session, javax.websocket.EndpointConfig config) Websocket会话创建成功时调用本方法, 将创建WsHandler实例,并登记之.
boolean	sendBinary(String wsid, Object msg) 异步非阻塞发送一段二进制数据到指定的WebSocket Session
boolean	sendBinarySync(String wsid, Object msg) sendBinary的同步阻塞版本
boolean	sendJson(String wsid, Object msg) 异步非阻塞发送文本信息到指定的WebSocket Session
boolean	sendJsonSync(String wsid, Object msg) sendJson的同步阻塞版本
boolean	sendText(String wsid, CharSequence text) 异步非阻塞发送文本信息到指定的WebSocket Session
boolean	sendTextSync(String wsid, CharSequence text) sendText的同步阻塞版本
void	setRoomPrefix(String roomPrefix)
void	setRoomProvider(WsRoomProvider roomProvider)
ByteBuffer	toByteBuffer(Object msg) 把byte[]/InputStream/ByteBuffer转换为ByteBuffer,其他类型的实例将toString()然后转byte[]再封装为ByteBuffer

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

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

字段详细资料

handlers

protected ConcurrentHashMap<String,WsHandler> handlers

存放Websocket Session Id --> WsHandler 的映射关系

sessions

protected ConcurrentHashMap<String,javax.websocket.Session> sessions

存放Websocket Session Id --> Session 的映射关系

roomProvider

protected WsRoomProvider roomProvider

房间提供者. WebSocket默认没有房间的概念

idField

protected Field idField

用于修改Session的Id字段

roomPrefix

protected String roomPrefix

构造器详细资料

AbstractWsEndpoint

public AbstractWsEndpoint()

方法详细资料

onOpen

public void onOpen(javax.websocket.Session session,
                   javax.websocket.EndpointConfig config)

Websocket会话创建成功时调用本方法, 将创建WsHandler实例,并登记之.

_onOpen

public void _onOpen(javax.websocket.Session session,
                    javax.websocket.EndpointConfig config)

onClose

public void onClose(javax.websocket.Session session,
                    javax.websocket.CloseReason closeReason)

WebSocket会话关闭是调用本方法,通常是用户关闭浏览器. 移除session相关的资源

_onClose

public void _onClose(javax.websocket.Session session,
                     javax.websocket.CloseReason closeReason)

onError

public void onError(javax.websocket.Session session,
                    Throwable throwable)

WebSocket会话出错时调用,默认调用onClose.

_onError

public void _onError(javax.websocket.Session session,
                     Throwable throwable)

onMesssageString

public void onMesssageString(javax.websocket.Session session,
                             String msg)

_onMesssageString

public void _onMesssageString(javax.websocket.Session session,
                              String msg)

changeSessionId

protected void changeSessionId(javax.websocket.Session session)

WebSocketSession只对当前JVM是唯一的,所以我们要改造一下, 变成UUID. 测试过tomcat和jetty是没有问题的,其他web服务器未测试.

createHandler

public WsHandler createHandler(javax.websocket.Session session,
                               javax.websocket.EndpointConfig config)

根据WebSocket会话创建一个WsHandler. 注意, 该实例还得实现MessageHandler.Whole或MessageHandler.Partial接口!!!

getSession

public javax.websocket.Session getSession(String wsid)

返回一个活跃的WebSocket Session对象

参数:

wsid - session的id

返回:

如果该wsid存在且处于活跃状态,返回session实例,否则返回null

getSession

public javax.websocket.Session getSession(String wsid,
                                          boolean opened)

根据wsid获取一个Session对象.

参数:

wsid - session的id

opened - 是否检查活跃状态

getHandler

public WsHandler getHandler(String wsid)

根据wsid获取其WsHandler实例

参数:

wsid - session的id

sendText

public boolean sendText(String wsid,
                        CharSequence text)

异步非阻塞发送文本信息到指定的WebSocket Session

参数:

wsid - session的id

text - 文本信息

返回:

session存活即返回true

sendTextSync

public boolean sendTextSync(String wsid,
                            CharSequence text)

sendText的同步阻塞版本

参数:

wsid - session的id

text - 文本信息

返回:

session存活且发送成功,返回true,否则返回false

sendJson

public boolean sendJson(String wsid,
                        Object msg)

异步非阻塞发送文本信息到指定的WebSocket Session

参数:

wsid - session的id

msg - 将转换为Json字符串的对象

返回:

session存活即返回true

sendJsonSync

public boolean sendJsonSync(String wsid,
                            Object msg)

sendJson的同步阻塞版本

参数:

wsid - session的id

msg - 将转换为Json字符串的对象

返回:

session存活且发送成功,返回true,否则返回false

toByteBuffer

public ByteBuffer toByteBuffer(Object msg)

把byte[]/InputStream/ByteBuffer转换为ByteBuffer,其他类型的实例将toString()然后转byte[]再封装为ByteBuffer

参数:

msg - byte[]/InputStream/ByteBuffer等对象

返回:

sendBinary

public boolean sendBinary(String wsid,
                          Object msg)

异步非阻塞发送一段二进制数据到指定的WebSocket Session

参数:

wsid - session的id

msg - byte[]/InputStream/ByteBuffer等

返回:

session存活且msg不是null,返回true,否则返回false

sendBinarySync

public boolean sendBinarySync(String wsid,
                              Object msg)

sendBinary的同步阻塞版本

each

public void each(String room,
                 org.nutz.lang.Each<javax.websocket.Session> callback)

按房间遍历活跃的session对象

参数:

room -

callback -

getRoomProvider

public WsRoomProvider getRoomProvider()

setRoomProvider

public void setRoomProvider(WsRoomProvider roomProvider)

getRoomPrefix

public String getRoomPrefix()

setRoomPrefix

public void setRoomPrefix(String roomPrefix)

isUndertowSession

public boolean isUndertowSession(javax.websocket.Session session)