top.jfunc.websocket

接口 WebSocketManager

所有已知实现类:

MemWebSocketManager, RedisWebSocketManager

public interface WebSocketManager

管理websocket的session,可以使用Map，可以自己添加接口功能实现，并放到容器中 注意：放在容器中的名字必须是 WebSocketManager.WEBSOCKET_MANAGER_NAME 即：webSocketManager

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	WEBSOCKET_MANAGER_NAME 在容器中的名字

方法概要

限定符和类型	方法和说明
void	broadcast(java.lang.String message) 广播
WebSocket	get(java.lang.String identifier) 根据标识获取websocket session
default boolean	isPing(java.lang.String identifier, java.lang.String message) 在OnMessage中判断是否是心跳, 从客户端的消息判断是否是ping消息
java.util.Map<java.lang.String,WebSocket>	localWebSocketMap() 获取当前机器上的保存的WebSocket
void	onMessage(java.lang.String identifier, java.lang.String message) WebSocket接收到消息的函数调用
default java.lang.String	pong(java.lang.String identifier, java.lang.String message) 返回心跳信息
void	put(java.lang.String identifier, WebSocket webSocket) 放入一个 websocket session
void	remove(java.lang.String identifier) 删除
void	sendMessage(java.lang.String identifier, java.lang.String message) 给某人发送消息
default int	size() 统计所有在线人数

字段详细资料

WEBSOCKET_MANAGER_NAME

static final java.lang.String WEBSOCKET_MANAGER_NAME

在容器中的名字

另请参阅:

常量字段值

方法详细资料

get

WebSocket get(java.lang.String identifier)

根据标识获取websocket session

参数:

identifier - 标识

返回:

WebSocket

put

void put(java.lang.String identifier,
         WebSocket webSocket)

放入一个 websocket session

参数:

identifier - 标识

webSocket - websocket

remove

void remove(java.lang.String identifier)

删除

参数:

identifier - 标识

localWebSocketMap

java.util.Map<java.lang.String,WebSocket> localWebSocketMap()

获取当前机器上的保存的WebSocket

返回:

WebSocket Map

size

default int size()

统计所有在线人数

返回:

所有在线人数

sendMessage

void sendMessage(java.lang.String identifier,
                 java.lang.String message)

给某人发送消息

参数:

identifier - 标识

message - 消息

broadcast

void broadcast(java.lang.String message)

广播

参数:

message - 消息

onMessage

void onMessage(java.lang.String identifier,
               java.lang.String message)

WebSocket接收到消息的函数调用

参数:

identifier - 标识

message - 消息内容

isPing

default boolean isPing(java.lang.String identifier,
                       java.lang.String message)

在OnMessage中判断是否是心跳, 从客户端的消息判断是否是ping消息

参数:

identifier - 标识

message - 消息

返回:

是否是ping消息

pong

default java.lang.String pong(java.lang.String identifier,
                              java.lang.String message)

返回心跳信息

参数:

identifier - 标识

message - 消息

返回:

返回的pong消息